Skip to main content
POST
Run a Task

Authorizations

anchor-api-key
string
header
required

API key passed in the header

Path Parameters

taskId
string
required

The ID of the task to run

Body

application/json
input_params
object
required

Key-value pairs of input parameters for the task

identity_id
string

Optional identity ID to use for the task

session_id
string

Optional session ID to run the task in

cleanup_sessions
boolean
default:true

Whether to clean up sessions after execution (default: true)

Response

Task run started successfully

run_id
string
required

The ID of the task run

status
enum<string>
required

Current task run status

Available options:
queued,
running,
success,
failure,
timeout,
cancelled
result
object

Task output when available

error
string

Error message when the run fails

session_id
string

Session ID used for this task run