List Agents
curl --request GET \
--url https://api.app.shinzo.ai/v1/agent/list \
--header 'Authorization: Bearer <token>'AI Agents
List Agents
Retrieve a list of all your AI agents.
GET
/
v1
/
agent
/
list
List Agents
curl --request GET \
--url https://api.app.shinzo.ai/v1/agent/list \
--header 'Authorization: Bearer <token>'Authentication
Requires JWT token or Platform API key viaAuthorization: Bearer <token> header.
number
default:"1"
Page number (min: 1)
number
default:"20"
Results per page (1-100)
string
Filter by status:
active, paused, stopped, or errorstring
default:"created_at"
Sort field:
created_at, updated_at, or namestring
default:"desc"
Sort order:
asc or descExample Request
curl -X GET "https://api.app.shinzo.ai/v1/agent/list?limit=10&status=active" \
-H "Authorization: Bearer <token>"
Example Response
{
"agents": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "code-review-agent",
"description": "Agent for automated code reviews",
"status": "active",
"created_at": "2025-01-15T10:00:00Z",
"updated_at": "2025-01-18T14:30:00Z",
"message_count": 45,
"mcp_server_count": 2
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "data-analysis-agent",
"description": "Agent for data analysis tasks",
"status": "paused",
"created_at": "2025-01-10T08:00:00Z",
"updated_at": "2025-01-12T09:15:00Z",
"message_count": 12,
"mcp_server_count": 0
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 2,
"total_pages": 1
}
}
Status Codes
| Code | Description |
|---|---|
200 | Success |
401 | Unauthorized - invalid or missing authentication |
403 | AI Agents feature not enabled for your account |