Inspect durable script workflow runs, review journal entries, and monitor swarm-script, raw-LLM, and agent-task execution status through the Script Runs API

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

prompt*string

model?string

schema?

fallbackPort?string

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/internal/raw-llm" \  -H "Content-Type: application/json" \  -d '{    "prompt": "string"  }'

{
  "result": null,
  "model": "string"
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

runId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

stepKey*string

Length1 <= length

template?string

task?string

agentId?string

tags?array<>

priority?integer

Range0 <= value <= 100

offerMode?boolean

dir?string

Length1 <= length

vcsRepo?string

Length1 <= length

model?string

Length1 <= length

parentTaskId?string

Formatuuid

requestedByUserId?string

outputSchema?

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/internal/script-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/agent-task" \  -H "Content-Type: application/json" \  -d '{    "stepKey": "string"  }'

{
  "taskId": "string",
  "taskOutput": "string"
}

{
  "taskId": "string",
  "status": "backlog"
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

runId*string

Formatuuid

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/internal/script-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/heartbeat"

Empty

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

runId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status*string

Value in"completed"

output?unknown

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/internal/script-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/status" \  -H "Content-Type: application/json" \  -d '{    "status": "completed"  }'

Empty

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

runId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

stepKey*string

Length1 <= length

stepType*string

Length1 <= length

config?unknown

status*string

Value in"completed" | "failed"

result?unknown

error?string

durationMs?integer

Range0 <= value

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/internal/script-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps" \  -H "Content-Type: application/json" \  -d '{    "stepKey": "string",    "stepType": "string",    "status": "completed"  }'

{
  "ok": true
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

runId*string

Formatuuid

stepKey*string

Length1 <= length

Response Body

`application/json`

curl -X GET "http://localhost:3013/api/internal/script-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps/string"

{
  "stepKey": "string",
  "stepType": "string",
  "status": "completed",
  "result": null,
  "error": "string"
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

status?string

agentId?string

scriptName?string

limit?integer

Range1 <= value <= 500

offset?|

Range0 <= value

Response Body

`application/json`

curl -X GET "http://localhost:3013/api/script-runs"

{
  "runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "agentId": "string",
      "scriptName": "string",
      "kind": "workflow",
      "status": "running",
      "pid": 0,
      "startedAt": "string",
      "finishedAt": "string",
      "error": "string",
      "lastHeartbeatAt": "string",
      "idempotencyKey": "string",
      "requestedByUserId": "string"
    }
  ],
  "total": 0
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

source*string

Length1 <= length

args?unknown

background?boolean

Defaulttrue

idempotencyKey?string

Length1 <= length <= 200

scriptName?string

Length1 <= length <= 200

requestedByUserId?string

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/script-runs" \  -H "Content-Type: application/json" \  -d '{    "source": "string"  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "running",
  "url": "string"
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "running",
  "url": "string"
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "http://localhost:3013/api/script-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X GET "http://localhost:3013/api/script-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "run": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "agentId": "string",
    "scriptName": "string",
    "source": "string",
    "args": null,
    "kind": "workflow",
    "status": "running",
    "pid": 0,
    "startedAt": "string",
    "finishedAt": "string",
    "output": null,
    "error": "string",
    "lastHeartbeatAt": "string",
    "idempotencyKey": "string",
    "requestedByUserId": "string"
  },
  "journal": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "runId": "78c33d18-170c-44d3-a227-b3194f134f73",
      "stepKey": "string",
      "stepType": "string",
      "config": {
        "property1": null,
        "property2": null
      },
      "status": "completed",
      "result": null,
      "error": "string",
      "startedAt": "string",
      "completedAt": "string",
      "durationMs": 0
    }
  ]
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Script Runs

200application/json

500application/json

200application/json

202application/json

404application/json

204

404application/json

204

404application/json

201application/json

404application/json

200application/json

404application/json

200application/json

201application/json

400application/json

409application/json

429application/json

204

404application/json

200application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`