Agent

Run an agent task

post

Spawn an ambient agent with a prompt and optional configuration. The agent will be queued for execution and assigned a unique task ID.

Authorizations
AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Body
promptstringRequired

The prompt/instruction for the agent to execute

titlestringOptional

Custom title for the task (auto-generated if not provided)

Responses
200

Task created successfully

application/json
post
/agent/run

List agent tasks

get

Retrieve a paginated list of agent tasks with optional filtering. Results are ordered by creation time (newest first).

Authorizations
AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Query parameters
limitinteger · min: 1 · max: 500Optional

Maximum number of tasks to return

Default: 20
cursorstringOptional

Pagination cursor from previous response

config_namestringOptional

Filter by agent config name

model_idstringOptional

Filter by model ID

creatorstringOptional

Filter by creator UID (user or service account)

sourcestring · enumOptional

Source that created the task:

  • LINEAR: Created from Linear integration
  • API: Created via the public API
  • SLACK: Created from Slack integration
  • LOCAL: Created from local CLI/app
  • SCHEDULED_AGENT: Created by a scheduled agent
Possible values:
created_afterstring · date-timeOptional

Filter tasks created after this timestamp (RFC3339 format)

created_beforestring · date-timeOptional

Filter tasks created before this timestamp (RFC3339 format)

Responses
200

List of tasks

application/json
get
/agent/tasks

Get task details

get

Retrieve detailed information about a specific agent task, including the full prompt, session link, and resolved configuration.

Authorizations
AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Path parameters
taskIdstringRequired

The unique identifier of the task

Responses
200

Task details

application/json
get
/agent/tasks/{taskId}

Last updated

Was this helpful?