Run a canonical automation manually

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "payload": "<unknown>"
}
'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs"

payload = { "payload": "<unknown>" }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({payload: '<unknown>'})
};

fetch('https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/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([
    'payload' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs"

	payload := strings.NewReader("{\n  \"payload\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payload\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payload\": \"<unknown>\"\n}"

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

{
  "automationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "automationRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "automationSnapshot": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "effectiveInitialMessage": "<string>",
  "promptSnapshot": {},
  "status": "pending",
  "statusUrl": "<string>",
  "triggerType": "manual",
  "updatedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "field": "<string>",
    "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "eventContext": {},
  "eventSourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventSummary": "<string>",
  "occurrenceAt": "2023-11-07T05:31:56Z",
  "providerDeliveryId": "<string>",
  "sessionAction": "started",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceSnapshot": {},
  "triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "triggerIncarnation": 4503599627370496,
  "triggerSnapshot": {}
}

{
  "code": "invalid_json",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unauthorized",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "forbidden",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "not_found",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "conflict",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "payload_too_large",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unsupported_media_type",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "automation_reference_invalid",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "rate_limit_exceeded",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "internal_error",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "bad_gateway",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "automation_runs_unconfigured",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "gateway_timeout",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

POST

managed-agents

automations

{automationId}

runs

Run a canonical automation manually

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "payload": "<unknown>"
}
'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs"

payload = { "payload": "<unknown>" }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({payload: '<unknown>'})
};

fetch('https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/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([
    'payload' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs"

	payload := strings.NewReader("{\n  \"payload\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payload\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v1/automations/{automationId}/runs")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payload\": \"<unknown>\"\n}"

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

{
  "automationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "automationRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "automationSnapshot": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "effectiveInitialMessage": "<string>",
  "promptSnapshot": {},
  "status": "pending",
  "statusUrl": "<string>",
  "triggerType": "manual",
  "updatedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "field": "<string>",
    "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "eventContext": {},
  "eventSourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventSummary": "<string>",
  "occurrenceAt": "2023-11-07T05:31:56Z",
  "providerDeliveryId": "<string>",
  "sessionAction": "started",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceSnapshot": {},
  "triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "triggerIncarnation": 4503599627370496,
  "triggerSnapshot": {}
}

{
  "code": "invalid_json",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unauthorized",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "forbidden",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "not_found",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "conflict",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "payload_too_large",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unsupported_media_type",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "automation_reference_invalid",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "rate_limit_exceeded",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "internal_error",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "bad_gateway",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "automation_runs_unconfigured",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "gateway_timeout",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

Authorizations

Authorization

string

header

required

A Recursion API key, created in the console under API keys.

Headers

Idempotency-Key

string

required

Replay-protection key in an organization-wide namespace shared by keyed mutations. It must contain 1 to 256 visible ASCII characters and be sent as exactly one header value. Request identity is the exact HTTP method, escaped path, raw query, and raw body bytes. For the legacy automation-run route only, the historical fingerprint ignores top-level JSON formatting and object-key order and removes the retired top-level idempotency_key field. The same request replays the original successful response; any different request returns 409 idempotency_conflict, and an active matching request returns 409 idempotency_in_progress. Completed receipts are retained for approximately 24 hours, pending claims may be reclaimed after approximately 1 hour, and no deduplication is guaranteed after expiry.

Required string length: 1 - 256

Pattern: ^[!-~]+$

x-tenant-id

string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1

x-organization-id

string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

automationId

string<uuid>

required

Stable canonical automation identifier.

Body

application/json

Structured input for explicitly running a canonical automation.

payload

any

Optional deliberately open JSON value supplied to this run and frozen in its event context.

Response

Canonical record of one admitted automation run and its frozen execution context.

automationId

string<uuid>

required

Automation whose frozen configuration admitted the run.

automationRunId

string<uuid>

required

Stable run identifier and asynchronous status handle.

automationSnapshot

object | null

required

Bounded non-secret automation configuration frozen at admission.

Show child attributes

createdAt

string<date-time>

required

Time the run was admitted.

effectiveInitialMessage

string

required

Complete initial message supplied to the admitted session.

promptSnapshot

object | null

required

Prompt definition frozen at admission.

Show child attributes

status

enum<string>

required

Session-creation outcome.

Available options:

pending,

created,

failed

statusUrl

string

required

Canonical member URL for polling this run.

triggerType

enum<string>

required

Admission kind.

Available options:

manual,

schedule,

slack,

github,

webhook

updatedAt

string<date-time>

required

Time the run outcome last changed.

completedAt

string<date-time>

Time session creation succeeded or failed.

error

object

Terminal admission failure. Present only for failed runs.

Show child attributes

eventContext

object

Bounded normalized delivery context or deliberately open manual payload.

Show child attributes

eventSourceId

string<uuid>

Event source that received the delivery for provider and custom-webhook runs.

eventSummary

string

One-line description of the event that started the run, such as the GitHub action, repository, number and label, or the start of a Slack message. Absent for manual and schedule runs and when the event carries nothing to describe.

occurrenceAt

string<date-time>

Schedule occurrence represented by this run.

providerDeliveryId

string

Verified provider delivery identity used for deduplication.

sessionAction

enum<string>

What the run did with its session. Present only for created runs of a Slack trigger whose continuation is resume_thread: started for the first post in a thread, appended when the thread's session was still working, resumed when it had finished, and successor when it was gone and a new session replaced it.

Available options:

started,

appended,

resumed,

successor

sessionId

string<uuid>

Managed-agent session the run started or was delivered into. Present only for created runs.

sourceSnapshot

object

Bounded non-secret source configuration frozen for event runs.

Show child attributes

triggerId

string<uuid>

Stored trigger that admitted the run. Absent for manual runs.

triggerIncarnation

integer

Trigger incarnation frozen at admission. Absent for manual runs.

Required range: 1 <= x <= 9007199254740991

triggerSnapshot

object

Bounded trigger configuration frozen at admission. Absent for manual runs.

Show child attributes

API reference

Endpoints

Run a canonical automation manually

Authorizations

Headers

Path Parameters

Body

Response