Skip to content

create_reference_set

Create a new reference set from a list of image, video or audio files in the workspace.

A reference set is a curated collection of assets used to train a model: images or videos for a
LoRA style, audio clips for a voice. Call this when the user wants to start training from assets
they have already uploaded. After creating an image or video set, call draft_captions then
start_training; for a voice, call start_training with a voice framework. A voice import
(start_training with training_framework voice-import) needs no files: create the set with
empty file_ids.

Cover thumbnails: pass cover_file_ids to choose them explicitly, or omit it to auto-pick the
first few image files. The output's cover_count reports how many were set.

Errors: invalid-dataset (no usable assets / all files foreign to the workspace),
invalid-session (the session does not belong to the workspace),
permission errors propagated as-is.

IMPORTANT: Call tool `get_instructions` first for general platform guidance.

Parameters

ParameterTypeDefaultDescription
namerequiredstring—Display name for the reference set.
categoryrequiredenum—Required training category — every reference set must have one. Choose: general (overall aesthetic), character (person/creature), object (specific item), scene (environment/setting).
One of: general, character, object, scene
file_idsstring (uuid)[]—Ordered list of image, video or audio file IDs to include. Must belong to the workspace. Audio clips are what a voice clone (voice-clone) trains on. Leave empty for a voice import (voice-import), which takes a voice_id instead of files.
descriptionstring—Optional description for the reference set.
cover_file_idsstring (uuid)[]—Optional ordered image file IDs to show as the reference set's cover thumbnails. Must belong to the workspace. Omit to auto-pick the first few image files from file_ids.
workspace_idrequiredstring (uuid)—The user's workspace ID.
session_idstring (uuid)—Optional session to place the reference set on. When set, the set is added to that session's canvas (chat surface). Omit for a standalone reference set.
project_idstring (uuid)—Optional project to add the reference set to; use list_projects to find project ids. Without it, a set placed on a session in a project joins that project. With `session_id`, that session must already be in this project.