Skip to main content
POST
Launch the onboarding task

Authorizations

Authorization
string
header
required

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

Body

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

Response

OK

already_launched
boolean
required
task_id
string<uuid>
required