List base models

Viewing v2— current version

GET

/v2/workspaces/{workspace_id}/base-models

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

import requests

url = "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models"

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/base-models';
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/base-models"

  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/base-models",
  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/base-models")
  .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/base-models")

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/base-models");
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer <token>");
var response = client.Execute(request);

Changed in v2. This endpoint’s contract differs from v1. See the v2 migration guide for the request and response changes before you switch.

List the base models enabled for this workspace, sourced from the model registry. Results come back in Layer’s recommended order, which reflects synced quality and popularity signals and can therefore shift between requests. Reference sets are listed separately under /reference-sets.

Authorizations

bearerAuth
oauth2
serviceAccount
generation: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.

Query Parameters

modality

Any of:

Modality
null

Modality

string

Allowed values: text image audio video three_d playable world

Filter by output modality

search

Search

Full-text search on name, aliases, and description

string

nullable

Full-text search on name, aliases, and description

use_case

Any of:

InferenceUseCase
null

InferenceUseCase

string

Allowed values: text_to_image image_editing multi_angle inpainting reframing split_into_layers text_to_video image_to_video video_editing video_extend insert_video video_subtitle video_lipsync motion_transfer video_object_swap video_character_swap relight_video image_to_video_lipsync text_to_3d image_to_3d text_to_world image_to_world remesh retexture uv_unwrap animate rig segment image_segment text_to_speech sound_effects music upscaling video_interpolation denoise_image denoise_video denoise_audio voice_change audio_separation audio_isolation deblur_video restore_image sdr_to_hdr_video background_removal vectorization virtual_try_on restyle pixelate colorize change_expression erase_object edit_text dub_video extend_audio generate_pbr_materials create_skybox complete_draft

Filter to the models that declare this use case, in Layer’s recommended order for it. The finer-grained choice when the caller’s intent is known, e.g. retexture or rig.

tileable

Tileable

Set true to list only models that can generate seamless tileable textures.

boolean

Set true to list only models that can generate seamless tileable textures.

limit

Limit

Maximum number of results to return.

integer

default: 20 >= 1 <= 100

Maximum number of results to return.

cursor

Cursor

Cursor from a previous response to fetch the next page.

string

nullable

Cursor from a previous response to fetch the next page.

Responses

200

Successful Response

application/json

ListBaseModelsOutput

object

base_models

required

Base Models

Array<object>

BaseModelSummary

object

base_model_id

required

Base Model Id

Base model identifier, e.g. flux-dev — pass it as base_model_id.

string

name

required

Name

Display name.

string

aliases

Aliases

Community nicknames this model is also known by.

Array<string>

default:

modality

required

Modality

Image, video, three_d, or audio.

string

Allowed values: text image audio video three_d playable world

provider

Provider

Slug of the organization behind the model, e.g. openai or bfl, when known.

string

nullable

description

Description

Short description.

string

nullable

price_per_unit

Price Per Unit

CU cost per measurement unit.

number

nullable

price_unit

Price Unit

Measurement unit, e.g. megapixel, second, generation.

string

nullable

inference_timing

required

Inference Timing

Typical generation time range, e.g. ‘5-15s’.

string

pagination

required

PaginationOutput

object

next_cursor

Next Cursor

Cursor to use to get the next page

string

nullable

has_more_results

required

Has More Results

If there are more results to page through

boolean

total_count

Total Count

Total number of results matching the query

integer

nullable

Example

{
  "base_models": [
    {
      "aliases": [],
      "modality": "text"
    }
  ]
}

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."
}