Skip to main content
POST
Run Task Definition

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

definition_id
string<uuid>
required
workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

One run of a saved task.

parameters
Parameters · object | null

Merged over the saved task's own parameters for this run only.

Response

Successful Response

agent_id
string<uuid>
required
created_at
string<date-time>
required
description
string
required
id
string<uuid>
required
parameters
Parameters · object
required
status
string
required
created_by
string | null
end_user_id
string | null
error
string | null
execution_id
string | null
failure_reason
string | null
metadata
Metadata · object | null
provenance
TaskProvenance · object

Why a task exists: who or what started it, and the event that caused it.

result
scheduled_at
string<date-time> | null
total_cost
number | null
total_tokens
integer | null