Get inference run

Viewing v2— current version

GET

/v2/workspaces/{workspace_id}/inferences/{inference_id}

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

import requests

url = "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/inferences/:inference_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/inferences/:inference_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/inferences/:inference_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/inferences/:inference_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/inferences/:inference_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/inferences/:inference_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/inferences/:inference_id");
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.

Get the status and results of an inference run, plus what each attached reference set contributed to it.

Authorizations

bearerAuth

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.

inference_id

required

Inference Id

Id of the generation.

string format: uuid

Id of the generation.

Responses

200

Successful Response

application/json

GetInferenceRunV2Output

object

inference_id

required

Inference Id

Unique identifier for this inference run.

string format: uuid

status

required

InferenceStatus

Current status: in_progress, complete, failed, cancelled, or deleted.

string

Allowed values: in_progress complete failed cancelled deleted

poll_interval_seconds

Any of:

integer
null

integer

completed_at

Any of:

string
null

string format: date-time

outputs

Any of:

Array<object>
null

Array<object>

ForgeRunAsset

object

file_id

required

File Id

File ID for the generated asset.

string format: uuid

url

required

Url

Download URL for the asset.

string

content_type

required

Content Type

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

string

preview_url

Any of:

string
null

string

width

Any of:

integer
null

integer

height

Any of:

integer
null

integer

duration_seconds

Any of:

number
null

number

file_size_bytes

Any of:

integer
null

integer

actual_price_creative_units

Any of:

number
null

number

error

Any of:

string
null

string

error_code

Any of:

string
null

string

base_model_id

Any of:

string
null

string

reference_set_contributions

Reference Set Contributions

Per-set summary of what each reference set contributed.

Array<object>

default:

ForgeReferenceSetContribution

object

set_id

Any of:

string
null

string format: uuid

lora_applied

Lora Applied

True when a LoRA finetune was applied for this set.

boolean

animation_applied

Animation Applied

True when an animation (Meshy rigging action) finetune was applied for this set.

boolean

voice_applied

Voice Applied

True when a voice (ElevenLabs) finetune was applied for this set.

boolean

mapped_asset_count

Mapped Asset Count

Number of assets successfully mapped to guidance inputs.

integer

prompt_fallback_applied

Prompt Fallback Applied

True when the set fell back to prompt-only representation.

boolean

lora_available_but_incompatible

Lora Available But Incompatible

True when SBMC has a LoRA for this set on another base model but not the one used.

boolean

skipped_not_applicable

Skipped Not Applicable

True when the set isn’t applicable to the chosen model (its modality / applicable base models exclude it) so no LoRA or assets were applied.

boolean

reference_sets_degraded

Reference Sets Degraded

True when at least one attached reference set did not meaningfully contribute. The run still costs Creative Units.

boolean

reference_sets_warning

Any of:

string
null

string

Example

{
  "status": "in_progress",
  "reference_set_contributions": [],
  "reference_sets_degraded": false
}

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.

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

422

Invalid input parameters.

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 — too many concurrent requests.

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