Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl https://agent.example.com/v1/agents \
-H "Authorization: Bearer <api_key>"
{
"object": "list",
"data": [
{
"id": "ag_01J1234567890ABCDEF",
"object": "agent",
"name": "SupportBot",
"model": "gpt-4o",
"instructions": "You are a helpful support assistant.",
"tools": [],
"metadata": { "team": "support" }
}
]
}
Retrieve a list of all agents. Returns an OpenAI-compatible list object with agent data, supporting standard pagination fields.
curl https://agent.example.com/v1/agents \
-H "Authorization: Bearer <api_key>"
{
"object": "list",
"data": [
{
"id": "ag_01J1234567890ABCDEF",
"object": "agent",
"name": "SupportBot",
"model": "gpt-4o",
"instructions": "You are a helpful support assistant.",
"tools": [],
"metadata": { "team": "support" }
}
]
}
object field of list and a data array containing full agent objects.
GET /v1/agents
Authorization: Bearer <api_key> or Authorization: ApiKey <key>. Optional if AGENT_CLOUD_API_KEY is unset at server boot.
list.curl https://agent.example.com/v1/agents \
-H "Authorization: Bearer <api_key>"
{
"object": "list",
"data": [
{
"id": "ag_01J1234567890ABCDEF",
"object": "agent",
"name": "SupportBot",
"model": "gpt-4o",
"instructions": "You are a helpful support assistant.",
"tools": [],
"metadata": { "team": "support" }
}
]
}
Was this page helpful?