Agent
GET/api/v1/agents
Authorization
bearer_token In: header
Query Parameters
Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.
Full-text search over this list's searchable fields.
1 <= length <= 200Comma-separated sort keys, - for descending, at most 3. Keys: display_name, key, created_at. Default: -created_at.
Rows per page, 1 to 100 (default 25).
1 <= value <= 100The page.next_cursor of the previous page. Cannot be combined with page.
A 1-based page number, for jumping. Cannot be combined with cursor.
1 <= valueSet to true to include the number of matching rows in page.total.
Response Body
application/json
curl -X GET "https://example.com/api/v1/agents"{ "agents": [ { "agent_id": "string", "created_at": "2019-08-24T14:15:22Z", "description": "string", "display_name": "string", "key": "string", "org_id": "string", "owner_id": "string", "profile_url": "string", "status": "active", "updated_at": "2019-08-24T14:15:22Z", "visibility": "private" } ], "page": { "has_more": true, "next_cursor": "string", "page": 0, "total": 0 }}POST/api/v1/agents
Authorization
bearer_token In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/agents" \ -H "Content-Type: application/json" \ -d '{ "agent_toml": "string", "description": "string", "display_name": "string", "key": "string", "prompt_text": "string" }'{ "agent_id": "string", "created_at": "2019-08-24T14:15:22Z", "display_name": "string", "key": "string"}POST/api/v1/agents/resolve
Authorization
bearer_token In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/agents/resolve" \ -H "Content-Type: application/json" \ -d '{ "keys": [ "string" ] }'{ "missing": [ "string" ], "resolved": [ { "agent_id": "string", "created_at": "2019-08-24T14:15:22Z", "description": "string", "display_name": "string", "key": "string", "org_id": "string", "owner_id": "string", "profile_url": "string", "status": "active", "updated_at": "2019-08-24T14:15:22Z", "visibility": "private", "agent_toml": "string", "compaction_toml": "string", "intent_toml": "string", "memory_toml": "string", "procedures": null, "prompt_text": "string", "rag_toml": "string", "shield_toml": "string" } ]}GET/api/v1/agents/resolve/{key}
Authorization
bearer_token In: header
Path Parameters
Response Body
application/json
curl -X GET "https://example.com/api/v1/agents/resolve/string"{ "agent_id": "string", "created_at": "2019-08-24T14:15:22Z", "description": "string", "display_name": "string", "key": "string", "org_id": "string", "owner_id": "string", "profile_url": "string", "status": "active", "updated_at": "2019-08-24T14:15:22Z", "visibility": "private", "agent_toml": "string", "compaction_toml": "string", "intent_toml": "string", "memory_toml": "string", "procedures": null, "prompt_text": "string", "rag_toml": "string", "shield_toml": "string"}GET/api/v1/agents/{agent_id}
Authorization
bearer_token In: header
Path Parameters
Query Parameters
Response detail level: "full" (default, includes prompt/TOML payloads) or "summary" (metadata only).
Response Body
application/json
curl -X GET "https://example.com/api/v1/agents/string"{ "agent_id": "string", "created_at": "2019-08-24T14:15:22Z", "description": "string", "display_name": "string", "key": "string", "org_id": "string", "owner_id": "string", "profile_url": "string", "status": "active", "updated_at": "2019-08-24T14:15:22Z", "visibility": "private", "agent_toml": "string", "compaction_toml": "string", "intent_toml": "string", "memory_toml": "string", "procedures": null, "prompt_text": "string", "rag_toml": "string", "shield_toml": "string"}DELETE/api/v1/agents/{agent_id}
Authorization
bearer_token In: header
Path Parameters
Response Body
curl -X DELETE "https://example.com/api/v1/agents/string"PUT/api/v1/agents/{agent_id}
Authorization
bearer_token In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/api/v1/agents/string" \ -H "Content-Type: application/json" \ -d '{}'{ "agent_id": "string", "created_at": "2019-08-24T14:15:22Z", "description": "string", "display_name": "string", "key": "string", "org_id": "string", "owner_id": "string", "profile_url": "string", "status": "active", "updated_at": "2019-08-24T14:15:22Z", "visibility": "private", "agent_toml": "string", "compaction_toml": "string", "intent_toml": "string", "memory_toml": "string", "procedures": null, "prompt_text": "string", "rag_toml": "string", "shield_toml": "string"}