Skip to main content
POST
/
v1beta
/
runs
Run a task
curl --request POST \
  --url https://api.example.com/v1beta/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "arguments": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "arguments": {},
  "result_json": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>

Body

application/json
​
task_id
string<uuid>
required

ID of the task to execute.

​
arguments
object

Arguments to pass to the task. Optional if the task does not require any arguments.

Response

Successful response

​
id
string<uuid>
required

Unique identifier for the object.

​
task_id
string<uuid>
required

ID of the task executed in this run.

​
arguments
object
required

Arguments in this run for the task's input parameters.

​
result_json
string | null
required

Execution result of the run. In JSON, matching the task's output schema.

​
created_at
string<date-time>
required

Timestamp when the object was created.

​
finished_at
string<date-time> | null
required

Timestamp when the object was last updated.