Get reference set

Viewing v2— current version

GET

/v2/workspaces/{workspace_id}/reference-sets/{reference_set_id}

curl --request GET \
  --url https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets/:reference_set_id \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets/:reference_set_id"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())

const url = 'https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets/:reference_set_id';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets/:reference_set_id"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets/:reference_set_id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets/:reference_set_id")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets/:reference_set_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

var client = new RestClient("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets/:reference_set_id");
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer <token>");
var response = client.Execute(request);

New in v2. This endpoint has no v1 equivalent.

Get a reference set’s metadata and every attached file with a download URL.

Authorizations

bearerAuth
oauth2
serviceAccount
reference_sets:read

Parameters

Path Parameters

workspace_id

required

Workspace Id

Id of the workspace that owns the resource.

string format: uuid

Id of the workspace that owns the resource.

reference_set_id

required

Reference Set Id

Id of the reference set.

string format: uuid

Id of the reference set.

Responses

200

Successful Response

application/json

GetReferenceSetOutput

object

reference_set_id

required

Reference Set Id

string format: uuid

name

required

Name

Display name of the reference set.

string

slug

required

Slug

URL-safe slug of the reference set.

string

description

Description

Free-text description.

string

nullable

category

Any of:

StyleCategory
null

StyleCategory

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).

string

Allowed values: 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

status

required

Status

Lifecycle status: draft, complete, or archived.

string

Allowed values: draft complete archived

asset_count

required

Asset Count

Number of files attached to the reference set.

integer

files

Files

Attached files, ordered by index.

Array<object>

ReferenceSetFile

object

file_id

required

File Id

ID of a file attached to the reference set.

string format: uuid

url

required

Url

Download URL for the file.

string

content_type

required

Content Type

MIME type, e.g. image/png or video/mp4.

string

index

required

Index

Ordinal position of the file within the reference set.

integer

caption

Caption

Training caption, or null when uncaptioned.

string

nullable

view_type

View Type

Multi-view tag when set: front_image, back_image, left_image, right_image, top_image, or bottom_image.

string

nullable

Example

{
  "category": "general",
  "status": "draft"
}

401

Unauthenticated — missing or invalid Bearer token.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

403

Forbidden — insufficient permissions, or the access token lacks the scope the operation requires.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

404

Resource not found.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

409

The outcome of the request with this Idempotency-Key is not known yet: it is still running, or it failed without a stored response. Retry after the number of seconds in Retry-After.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

422

Invalid input parameters, or an Idempotency-Key reused for a different request.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

429

Rate limited — retry after the number of seconds in Retry-After.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

500

Internal server error.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}