Start a run

A run is an agent execution a tree of spans. The environment is taken from the API key.

POST/api/v2/runs

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Idempotency-Keystring

Stable retry key for a mutation. The key is claimed atomically before the handler runs, so concurrent retries execute the side effect at most once. Replaying the key for the same request (same method, path, workspace and JSON body) returns the original response with an X-Idempotent-Replay: true header. Reusing the key for a different request returns 409 with error code idempotency_key_reuse. A duplicate arriving while the first is still in flight waits and then replays; if the first does not finish in time the duplicate gets 409 idempotency_request_in_progress. Keys are retained for 24 hours. Only successful (2xx) responses are stored; a failed request frees the key so it can be retried.

min length 1 · max length 255

Request body

application/json

namestring

max length 200

agentIdstring

max length 60

agentVersionstring

max length 60

userIdstring

max length 200

applicationstring

max length 200

inputany

tagsstring[]

max items 50

metadataobject

Responses

201

Run started.

successbooleanrequired

Allowed:true

dataRunrequired

Show properties

idstringrequired

Public run id (run_xxx).

agentIdstring | null

agentVersionstring | null

environmentIdstring<uuid>required

namestring | nullrequired

statusstringrequired

Allowed:runningsucceededfailedcancelled

userIdstring | null

applicationstring | null

inputany | null

outputany | null

errorobject | null

tokensinteger | null

costnumber | null

tagsstring[] | null

metadataobject | null

startedAtstring<date-time>required

endedAtstring<date-time> | null

durationMsinteger | null

400

Bad Request - Invalid input data

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.Idempotency-KeyheaderStable retry key for a mutation. The key is claimed atomically before the handler runs, so concurrent retries execute the side effect at most once. Replaying the key for the same request (same method, path, workspace and JSON body) returns the original response with an `X-Idempotent-Replay: true` header. Reusing the key for a different request returns `409` with error code `idempotency_key_reuse`. A duplicate arriving while the first is still in flight waits and then replays; if the first does not finish in time the duplicate gets `409 idempotency_request_in_progress`. Keys are retained for 24 hours. Only successful (2xx) responses are stored; a failed request frees the key so it can be retried.

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.anlyon.com/api/v2/runs' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "agentId": "string",
  "agentVersion": "string",
  "userId": "string",
  "application": "string",
  "input": null,
  "tags": [
    "string"
  ],
  "metadata": {}
}'

const response = await fetch("https://api.anlyon.com/api/v2/runs", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"agentId\": \"string\",\n  \"agentVersion\": \"string\",\n  \"userId\": \"string\",\n  \"application\": \"string\",\n  \"input\": null,\n  \"tags\": [\n    \"string\"\n  ],\n  \"metadata\": {}\n}"
});

import requests

response = requests.post(
    "https://api.anlyon.com/api/v2/runs",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"agentId\": \"string\",\n  \"agentVersion\": \"string\",\n  \"userId\": \"string\",\n  \"application\": \"string\",\n  \"input\": null,\n  \"tags\": [\n    \"string\"\n  ],\n  \"metadata\": {}\n}",
)

Response

{
  "success": true,
  "data": {
    "id": "string",
    "agentId": "string",
    "agentVersion": "string",
    "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
    "name": "string",
    "status": "running",
    "userId": "string",
    "application": "string",
    "input": null,
    "output": null,
    "error": {},
    "tokens": 0,
    "cost": 0,
    "tags": [
      "string"
    ],
    "metadata": {},
    "startedAt": "2019-08-24T14:15:22Z",
    "endedAt": "2019-08-24T14:15:22Z",
    "durationMs": 0
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {
      "url": "Invalid URL format"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}