Reference Sets

List reference sets

Changed on

List the workspace's reference sets. Pass a returned reference_set_id in the reference_sets array of an inference request. Only sets that are ready to generate with are listed: archived sets, and empty ones with no files, no trained model and no prompt fragments, are omitted.

get/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:read)

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Query parameters

searchstring nullable

Full-text search on name/description

category'general' | 'character' | 'object' | 'scene' | 'animation' | 'brand' | 'camera_movement' | 'camera_angle' | 'camera_framing' | 'camera_lens' | 'scene_lighting' | 'scene_composition' | 'scene_atmosphere' | 'time_and_motion' | 'genre_look' | 'optical_effect' | 'visual_effect' | 'character_performance'

What a reference set is.

The first group is user-settable: a curator picks one when creating or editing a set. The second group is internal: the cinematic-technique library owns those values, they are seeded only by the fixtures in core/workflows/fixtures/data/reference_sets and a user-facing write path must reject them (see USER_SETTABLE_CATEGORIES).

Only sets of this category, e.g. animation for the motions a rigged mesh can play.

limitinteger

Maximum number of results to return.

cursorstring nullable

Cursor from a previous response to fetch the next page.

Response

Successful Response

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:read was removed from the endpoint's security scheme oauth2