Skip to main content
POST
Create a task

Authorizations

Authorization
string
header
required

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

Path Parameters

orgID
string<uuid>
required

Body

application/json
agent_type
enum<string>
required
Available options:
codex,
claude-code,
opencode
interaction_mode
enum<string>
required
Available options:
default,
plan
model
string
required
Minimum string length: 1
project_id
string<uuid>
required
prompt
string
required
Minimum string length: 1
agent_profile_id
string<uuid>

Optional agent profile the task is started through. Its connection pin applies to a task of the profile's agent unless runs_on chooses otherwise; the request's agent, model and effort are the task's.

auto_fix_ci
boolean

Optional per-task override. Omit to inherit the fresh project default; explicit true or false overrides it.

auto_fix_pr_comments
boolean

Optional per-task override. Omit to inherit the fresh project default; explicit true or false overrides it.

auto_rebase
boolean

Optional per-task override. Omit to inherit the fresh project default; explicit true or false overrides it.

base_branch
string
Minimum string length: 1
context
object
idempotency_key
string<uuid>

Optional client-generated UUID, scoped to the authenticated user in the authenticated org. The first create with a key records it with the task; a retry with the same key and an equivalent request returns that same task (202, same body) without creating, admitting, or dispatching again, even if the task was since archived. Reusing a key for a different request fails with 409 code idempotency_key_reused and creates nothing.

post_pr_demo_video
boolean

Optional per-task override. Omit to inherit the fresh project default; explicit true or false overrides it.

post_pr_screenshots
boolean

Optional per-task override. Omit to inherit the fresh project default; explicit true or false overrides it.

reasoning_effort
enum<string> | null
Available options:
ultra,
max,
xhigh,
high,
medium,
low,
ultrathink,
ultracode
runs_on
object

Optional initial task connection; an explicit choice is validated before the first turn. Omitted, the task runs on the pin of the agent profile agent_profile_id names when that profile pins a connection for the task's agent, else on the creator's default connection.

vm_size
enum<string>
Available options:
small,
medium,
large

Response

Accepted

id
string<uuid>
required
name
string
required
Minimum string length: 1