REST API

Agent

The built-in agent.

startAgentTask

POST /v1/agent/tasks

Give the built-in agent a task on one or more devices

Request body: application/json (AgentTaskRequest).

Field	Type	What it is
`instruction`	string
`deviceIds`	array of string
`model`	string	Provider/model id, such as “anthropic:claude-sonnet-5” or “local:ui-tars”.
`maxSteps`	integer
`budgetUsd`	number
`policyProfile`	string

MCP tools on this operation: run_agent_task.

GET /v1/agent/tasks/{taskId}

Task status, steps and cost so far

Parameter	In	Required	Type	What it is
`taskId`	path	yes	string

MCP tools on this operation: get_agent_task.

DELETE /v1/agent/tasks/{taskId}

Stop the task

Parameter	In	Required	Type	What it is
`taskId`	path	yes	string

POST /v1/agent/tasks/{taskId}/messages

Add guidance to a running task

Parameter	In	Required	Type	What it is
`taskId`	path	yes	string

Request body: application/json.

Field	Type	What it is
`text`	string

POST /v1/agent/tasks/{taskId}/takeover

Pause the agent at the next step boundary and give input to the person

Parameter	In	Required	Type	What it is
`taskId`	path	yes	string

Response	Means
200	The person has control. `AgentTask`
4XX	Error (RFC 9457).
5XX	Error (RFC 9457).

POST /v1/agent/tasks/{taskId}/handback

Return control to the agent with an optional note

Parameter	In	Required	Type	What it is
`taskId`	path	yes	string

Request body: application/json.

Field	Type	What it is
`note`	string