Automette

Authorization

ApiKeyAuth

AuthorizationBearer <token>

API key from API Keys in the dashboard menu.

In: header

Query Parameters

async?boolean

Defaulttrue

result?string

With async=false, which result to return. Required then.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

query?string

input?

output_config?

The shape you want the result in, for this run. It replaces the agent's Data Fields, if it has any. When the task finishes, the result is filled in from its work and becomes the task's structured_response (read it from /structured-response, or result=structured with async=false). With neither, there is no structured result.

files?array<>

Itemsitems <= 20

when_input_needed?string

What happens when the agent needs a person: a missing file or value, an approval, a review. wait asks and waits. fail is for a system that cannot wait: the task ends at once as failed, with error.code needs_input, needs_approval or needs_review and error.needed listing what was missing. Reply to the same task with it to carry on, or start a new one.

Default"wait"

Value in

"wait"
"fail"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/agents/string/run" \  -H "Content-Type: application/json" \  -d '{}'

{  "task_id": "string",  "agent_id": "string",  "status": "queued",  "outcome": "terminal",  "result": {}}

Run an agent

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Run an agent

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

202application/json

400application/json

401application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`