Training

Create a reference set

Create a reference set (a curated collection of already-uploaded files) that can then be trained into a custom style/LoRA. Upload files first via the Files API, then pass their IDs here.

post/v1/workspaces/{workspace_id}/reference-sets

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Headers

Idempotency-Keystring

Opaque key making this request safe to retry. The first request with a given key executes; a later request with the same key returns that first response with Idempotent-Replayed: true instead of executing again. The key covers the method, path, query, and body it was first used with; reusing it for a different request is rejected with 422. Replayable for 24 hours.

Request body

namestring required

Display name for the reference set.

category'general' | 'character' | 'object' | 'scene' | 'effect' required

Training category: general (overall aesthetic), character (person/creature), object (specific item), scene (environment), or effect (visual effect).

file_idsstring[] required

Ordered image or video file IDs to include. Must belong to the workspace.

descriptionstring nullable

Optional description.

cover_file_idsstring[] nullable

Optional ordered image file IDs to show as cover thumbnails. Omit to auto-pick.

Response

Successful Response

reference_set_idstring uuid required

ID of the created reference set (train this with a training run).

namestring required

asset_countinteger required

Number of input files added to the reference set.

cover_countinteger required

Number of cover thumbnails set on the reference set.

Changes

No recorded changes to this endpoint across all 1 revision of this API.