Skip to main content
PUT
Report a task a computer started

Authorizations

Authorization
string
header
required

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

Path Parameters

computerID
string<uuid>
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
startID
string<uuid>
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

application/json
report
enum<string>
required

prepared once the work tree is made, on the task's branch at the start's folder; failed, with reason, when it could not be.

Available options:
prepared,
failed
reason
enum<string>

With failed, and only with it: checkout_missing when the start's checkout is no checkout of the repository; base_branch_unreachable when git could not fetch the base branch from the checkout's origin; work_tree_failed when git could not add the work tree.

Available options:
checkout_missing,
base_branch_unreachable,
work_tree_failed,
session_unplaced

Response

OK

A task started on the computer, as its machine bridge carries it out: the work tree to make, the session the task's main chat is, and where the start stands.

base_branch
string
required

The branch on the checkout's origin the task's branch starts from, and its pull request goes to.

Required string length: 1 - 255
Pattern: ^[^-\0- \x7f-\xa0  - 

   ][^\0- \x7f-\xa0  - 

   ]*$
branch
string
required

The task's own branch, which the work tree is made on: a new task's is cut from base_branch on origin, a fork's is on origin already, pushed with the source's work.

Required string length: 1 - 255
Pattern: ^[^-\0- \x7f-\xa0  - 

   ][^\0- \x7f-\xa0  - 

   ]*$
checkout
string
required

The person's checkout of the repository on the computer the work tree is added from.

Required string length: 1 - 4096
Pattern: ^/
folder
string
required

The folder the work tree is made at.

Required string length: 1 - 4096
Pattern: ^/
fork
object | null
required

The session the main chat's first run forks, for a task forked to the computer from another chat; null for a new task.

id
string<uuid>
required

The start's id, its start_task command's.

prompt
string
required

The task's prompt, the main chat's first message.

Required string length: 1 - 65536
repository
object
required
session_id
string<uuid>
required

The id Claude Code's session takes when the task's first run starts it: the task's main chat.

state
enum<string>
required
Available options:
pending
task_id
string<uuid>
required

The task the start is of.

agent
string

The catalog type of the agent the task's main chat runs, such as claude-code. Always sent.

Minimum string length: 1