Create a reference set

Viewing v2— current version

POST

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

curl --request POST \
  --url https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "category": "general",
  "file_ids": [
    "<uuid>"
  ],
  "description": "<string>",
  "cover_file_ids": [
    "<uuid>"
  ]
}'

import requests

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

payload = {
    "name": "<string>",
    "category": "general",
    "file_ids": ["<uuid>"],
    "description": "<string>",
    "cover_file_ids": ["<uuid>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

const url = 'https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"<string>","category":"general","file_ids":["<uuid>"],"description":"<string>","cover_file_ids":["<uuid>"]}'
};

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

package main

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

func main() {

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

  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"category\": \"general\",\n  \"file_ids\": [\n    \"<uuid>\"\n  ],\n  \"description\": \"<string>\",\n  \"cover_file_ids\": [\n    \"<uuid>\"\n  ]\n}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'category' => 'general',
    'file_ids' => [
        '<uuid>'
    ],
    'description' => '<string>',
    'cover_file_ids' => [
        '<uuid>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"name\": \"<string>\",\n  \"category\": \"general\",\n  \"file_ids\": [\n    \"<uuid>\"\n  ],\n  \"description\": \"<string>\",\n  \"cover_file_ids\": [\n    \"<uuid>\"\n  ]\n}");
Request request = new Request.Builder()
  .url("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets")
  .post(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"category\": \"general\",\n  \"file_ids\": [\n    \"<uuid>\"\n  ],\n  \"description\": \"<string>\",\n  \"cover_file_ids\": [\n    \"<uuid>\"\n  ]\n}"

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

var client = new RestClient("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/reference-sets");
var request = new RestRequest("", Method.Post);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"<string>\",\n  \"category\": \"general\",\n  \"file_ids\": [\n    \"<uuid>\"\n  ],\n  \"description\": \"<string>\",\n  \"cover_file_ids\": [\n    \"<uuid>\"\n  ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);

Unchanged from v1. This endpoint’s documented request and response schemas are identical in v1 and v2 — change the /v1 prefix to /v2. Schema equality is not a promise about behaviour, so keep your usual smoke tests.

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.

Authorizations

bearerAuth
oauth2

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.

Header Parameters

Idempotency-Key

string

<= 255 characters

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^required

application/json

CreateReferenceSetRequest

object

name

required

Name

Display name for the reference set.

string

<= 255 characters

category

required

Category

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

string

Allowed values: general character object scene effect

file_ids

required

File Ids

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

Array<string>

>= 1 items <= 1000 items

description

Any of:

string
null

string

<= 2000 characters

cover_file_ids

Any of:

Array<string>
null

Array<string>

Responses

201

Successful Response

application/json

CreateReferenceSetResponse

object

reference_set_id

required

Reference Set Id

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

string format: uuid

name

required

Name

string

asset_count

required

Asset Count

Number of input files added to the reference set.

integer

cover_count

required

Cover Count

Number of cover thumbnails set on the reference set.

integer

skipped

Skipped

Files from file_ids that were not included, each with the reason.

Array<object>

SkippedFile

object

file_id

required

File Id

string format: uuid

reason

required

Reason

Why this file_id was not added: not_found (no such file), foreign_workspace (belongs to another workspace), already_member (already in the set), or duplicate_in_request (listed more than once in this call).

string

Allowed values: not_found foreign_workspace already_member duplicate_in_request

Example

{
  "skipped": [
    {
      "reason": "not_found"
    }
  ]
}

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 request with this Idempotency-Key is still running — 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."
}

Create a reference set

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

201

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

500

Example

Request Body^required