Publish an agent
Authorization
ApiKeyAuth API key from API Keys in the dashboard menu.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/agents/string/publish" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "kind": "agent", "name": "string", "description": "string", "default": true, "status": "published", "version": 0, "mode": "agentic", "trigger": "string", "steps": [ { "id": "string", "name": "string", "kind": "ai" } ], "email": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Get an agent GET
Previous Page
Run an agent POST
Give an agent a task: `query` (what to do), `files`, `input` (data a trigger would carry). JSON, or multipart with one `files` field per upload. **Async (default):** returns `202` at once with the `task_id`. Poll `GET /api/v1/tasks/{task_id}` until `status` is `completed`, then read `/summary`, `/structured-response` or `/tool-result`. When it is `waiting_for_input`, read `/messages` and reply to `/message`. **async=false:** holds the connection (budget in `X-Sync-Budget-Seconds`, about 5 minutes) and returns the result you ask for with `result`: `summary`, `feed`, `structured` or `tool:<name>`. `200` with `outcome: terminal` when the task ended (a failed task too: check `status`); `202` with `outcome: waiting_for_input` or `awaiting_review` as soon as it waits on a person, or `budget_expired` if it is still working. Set your client's timeout above the budget.