Get an agent
Authorization
ApiKeyAuth API key from API Keys in the dashboard menu.
In: header
Path Parameters
Query Parameters
Add the agent's role and full draft definition.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/agents/string"{ "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"}Set up an agent POST
Set up an agent, or with `kind: automation` an automation, from a description of the work and, optionally, the procedure (SOP) to follow. An agent is something people give work and talk to; an automation runs on its own, its steps in order, with AI only inside a step. Its steps, tools and rules are worked out for you and saved as a **draft** to review in the dashboard; it takes tasks once published (`POST /api/v1/agents/{id}/publish`). `questions` lists anything the description left open. Uses AI credits.
Publish an agent POST
Make the draft the version that takes tasks, and switch on how it starts (its email address, form, schedule or webhook). A 422 lists what stops it publishing.