Cancel inference run

Viewing v2— current version

POST

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

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

import requests

url = "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/inferences/:inference_id/cancel"

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

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

print(response.json())

const url = 'https://api.app.layer.ai/api/v2/workspaces/:workspace_id/inferences/:inference_id/cancel';
const options = {method: 'POST', 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/cancel"

  req, _ := http.NewRequest("POST", 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/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/cancel")
  .post(null)
  .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/cancel")

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

request = Net::HTTP::Post.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/cancel");
var request = new RestRequest("", Method.Post);
request.AddHeader("Authorization", "Bearer <token>");
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.

Request cancellation of an in-flight inference. Fire-and-forget: returns immediately after signalling the run to stop. Poll GET /workspaces/{workspace_id}/inferences/{inference_id} for the eventual CANCELLED status. A run that already COMPLETED can no longer be cancelled and returns INFERENCE_ALREADY_COMPLETE; the other terminal states are idempotent no-ops.

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

202

Successful Response

application/json

GetForgeRunOutput

object

inference_id

required

Inference Id

Unique identifier for this forge 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

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.

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