Training

Create a reference set

Changed on

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/v2/workspaces/{workspace_id}/reference-sets

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/v2/workspaces/{workspace_id}/reference-sets
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.app.layer.ai/authorize, token URL https://auth.app.layer.ai/oauth/token)
    • OAuth 2 (client credentials, token URL https://api.app.layer.ai/api/oauth/token, scopes: reference_sets:write)

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Headers

Idempotency-Keystring

Opaque key making a retry of this request return the first result. A 2xx response is replayed for 24 hours with Idempotent-Replayed: true. A 4xx releases the key. A 5xx, or a request still running, holds the key for 120 seconds, during which a retry gets 409; after that a retry executes again. The key covers the method, path, query, and byte-identical body it was first used with; reusing it for a different request is rejected with 422. Protection is best effort: if the key store is unavailable, or a record is lost early, a retry can execute again even after an earlier 409. See the Idempotency section of the API description.

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

  • 326f3bcdabccRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 2d86d473cda6Revision changes
    • info

      the endpoint scheme security serviceAccount was added to the API

    • info

      the security scope reference_sets:write was removed from the endpoint's security scheme oauth2