Run an inference with a base model

Viewing v2— current version

POST

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

curl --request POST \
  --url https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

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

payload = {}
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/base-models/:slug/inferences';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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/base-models/:slug/inferences"

  payload := strings.NewReader("{}")

  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/base-models/:slug/inferences",
  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([

  ]),
  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, "{}");
Request request = new Request.Builder()
  .url("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences")
  .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/base-models/:slug/inferences")

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 = "{}"

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

var client = new RestClient("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences");
var request = new RestRequest("", Method.Post);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);

New in v2. This endpoint has no v1 equivalent.

Start a generation with the given base model. The request body is the model’s inference form (see GET /base-models/{slug}/inference-schema for its shape). Returns immediately with an inference id; poll GET /workspaces/{workspace_id}/inferences/{inference_id} for results.

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.

slug

required

Slug

The base model, named by the id the list endpoint returns, or by its slug, display name, or alias.

string

The base model, named by the id the list endpoint returns, or by its slug, display name, or alias.

Query Parameters

session_name

Any of:

string
null

string

Organize this run under a named session. A new session is created if none matches.

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

Input

object

key

additional properties

any

Example^generated

{}

Responses

202

Successful Response

application/json

ExecuteForgeOutput

object

inference_id

required

Inference Id

Unique identifier for this forge run.

string format: uuid

status

required

InferenceStatus

Current status: IN_PROGRESS.

string

Allowed values: in_progress complete failed cancelled deleted

estimated_price_creative_units

Any of:

number
null

number

poll_interval_seconds

required

Poll Interval Seconds

Suggested polling interval in seconds.

integer

created_at

required

Created At

Timestamp of when the run was created.

string format: date-time

session_id

Any of:

string
null

string format: uuid

normalized_parameters

Any of:

NormalizedInferenceParameters
null

NormalizedInferenceParameters

Inference parameters after model-specific normalization.

These reflect the actual values used for generation, including model defaults applied for any parameters not explicitly set.

object

width

Any of:

integer
null

integer

height

Any of:

integer
null

integer

batch_size

Any of:

integer
null

integer

num_inference_steps

Any of:

integer
null

integer

guidance_scale

Any of:

number
null

number

duration_seconds

Any of:

number
null

number

fps

Any of:

integer
null

integer

Example

{
  "status": "in_progress"
}

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

Run an inference with a base model

Authorizations

Parameters

Path Parameters

Query Parameters

Header Parameters

Request Bodyrequired

Examplegenerated

Responses

202

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

500

Example

Request Body^required

Example^generated