Execute workflow

Viewing v2— current version

POST

/v2/workspaces/{workspace_id}/workflows/{workflow_id}/runs

curl --request POST \
  --url https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows/:workflow_id/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inputs": {},
  "session_id": "<uuid>",
  "session_name": "<string>",
  "webhook": {
    "url": "<string>",
    "events": [
      "inference.completed"
    ],
    "metadata": {}
  }
}'

import requests

url = "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows/:workflow_id/runs"

payload = {
    "inputs": {},
    "session_id": "<uuid>",
    "session_name": "<string>",
    "webhook": {
        "url": "<string>",
        "events": ["inference.completed"],
        "metadata": {}
    }
}
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/workflows/:workflow_id/runs';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"inputs":{},"session_id":"<uuid>","session_name":"<string>","webhook":{"url":"<string>","events":["inference.completed"],"metadata":{}}}'
};

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/workflows/:workflow_id/runs"

  payload := strings.NewReader("{\n  \"inputs\": {},\n  \"session_id\": \"<uuid>\",\n  \"session_name\": \"<string>\",\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"events\": [\n      \"inference.completed\"\n    ],\n    \"metadata\": {}\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/workflows/:workflow_id/runs",
  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([
    'inputs' => [

    ],
    'session_id' => '<uuid>',
    'session_name' => '<string>',
    'webhook' => [
        'url' => '<string>',
        'events' => [
                'inference.completed'
        ],
        'metadata' => [

        ]
    ]
  ]),
  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  \"inputs\": {},\n  \"session_id\": \"<uuid>\",\n  \"session_name\": \"<string>\",\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"events\": [\n      \"inference.completed\"\n    ],\n    \"metadata\": {}\n  }\n}");
Request request = new Request.Builder()
  .url("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows/:workflow_id/runs")
  .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/workflows/:workflow_id/runs")

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  \"inputs\": {},\n  \"session_id\": \"<uuid>\",\n  \"session_name\": \"<string>\",\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"events\": [\n      \"inference.completed\"\n    ],\n    \"metadata\": {}\n  }\n}"

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

var client = new RestClient("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows/:workflow_id/runs");
var request = new RestRequest("", Method.Post);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"inputs\": {},\n  \"session_id\": \"<uuid>\",\n  \"session_name\": \"<string>\",\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"events\": [\n      \"inference.completed\"\n    ],\n    \"metadata\": {}\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.

Start a workflow execution. Returns immediately with a run ID. Poll with GET /workspaces/{workspace_id}/workflows/{workflow_id}/runs/{run_id} for results. Creative Units are not checked here: an underfunded workspace is still accepted and the run then reports FAILURE with error_code BlueprintInsufficientBalanceError. Use the estimate endpoint’s has_sufficient_creative_units to check before submitting.

Authorizations

bearerAuth
oauth2
serviceAccount
workflows:write

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.

workflow_id

required

Workflow Id

Id of the workflow.

string format: uuid

Id of the workflow.

Header Parameters

Idempotency-Key

string

<= 255 characters

Opaque key making a retry of this request return the first result. A 2xx response is replayed for 24 hours with Idempotent-Replayed: true. A 4xx releases the key. A 5xx, or a request still running, holds the key for 120 seconds, during which a retry gets 409; after that a retry executes again. The key covers the method, path, query, and byte-identical body it was first used with; reusing it for a different request is rejected with 422. Protection is best effort: if the key store is unavailable, or a record is lost early, a retry can execute again even after an earlier 409. See the Idempotency section of the API description.

Request Body^required

application/json

ExecuteWorkflowRequest

object

inputs

required

Inputs

Input values matching the workflow’s input schema.

object

key

additional properties

any

session_id

Session Id

Existing session ID. Takes precedence over session_name if both are provided.

string format: uuid

nullable

session_name

Session Name

Session name. Creates a new session if not found in the workspace. Ignored if session_id is set.

string

nullable

webhook

Any of:

WebhookInput
null

WebhookInput

Where to POST this request’s terminal events, and what to include with them.

object

url

required

Url

HTTPS URL that receives a POST when this request reaches a terminal state. Must be publicly reachable; must not redirect. Acknowledge with any 2xx within 10 seconds and do the work asynchronously. Reply 410 to stop delivery permanently.

string

<= 2048 characters

events

Events

Narrows what is delivered. Omit to receive every event this request can produce, which is what expected_events on the response lists.

Array<string>

nullable

Allowed values: inference.completed inference.failed inference.cancelled training.succeeded training.failed scoring_run.completed scoring_run.failed workflow_run.succeeded workflow_run.failed workflow_run.cancelled

metadata

Metadata

Opaque key/value pairs echoed back verbatim in every delivery, for correlating a callback with your own records. At most 10 keys and 1024 bytes in total.

object

key

additional properties

string

Responses

202

Successful Response

application/json

ExecuteWorkflowOutput

object

run_id

required

Run Id

Unique identifier for this workflow run.

string format: uuid

status

required

BlueprintRunStatus

Current run status: PENDING or RUNNING.

string

Allowed values: pending running success failure cancelled

estimated_price_creative_units

required

Estimated Price Creative Units

Estimated price in Creative Units.

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

Session Id

Session ID the run was added to, if a session was specified.

string format: uuid

nullable

expected_events

Expected Events

Deliveries this run will produce. Empty when no webhook was supplied.

Array<string>

default:

Example

{
  "status": "pending",
  "expected_events": []
}

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

Execute workflow

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

202

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

500

Example

Request Body^required