Automette docs
API Reference

List tasks

GET
/api/v1/tasks

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key from API Keys in the dashboard menu.

In: header

Query Parameters

agent_id?string
status?string

Value in

  • "working"
  • "waiting"
  • "finished"
limit?integer
Rangevalue <= 100
Default25

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/tasks"
{  "data": [    {      "id": "string",      "agent": {        "id": "string",        "name": "string"      },      "title": "string",      "status": "queued",      "summary": "string",      "created_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z"    }  ]}

Give an agent a task (same as POST /run) POST

Give an agent work: a `message` saying what to do and the `files` to work on. `input` is the data the agent's trigger would carry, for an agent that starts from a form, record or webhook. Returns `202` with the task id at once; follow it with `GET /api/v1/tasks/{id}` or a `task.*` webhook. With `wait` (up to 60 seconds) the call holds until the task finishes or waits on a person and returns the whole task (`200`), or `202` if it is still working.

Get a task's status GET

The light status to poll: `status`, title, times, and `error` once failed. Poll every 1 to 2 seconds, backing off to about 10. When `completed`, read `/summary`, `/structured-response` or `/tool-result`; when `waiting_for_input`, read `/messages` and reply to `/message`.