Skip to main content
GET
/
v1
/
agent
/
{id}
/
summary
Get Agent Summary
curl --request GET \
  --url https://api.app.shinzo.ai/v1/agent/{id}/summary \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "<string>",
  "name": "<string>",
  "status": "<string>",
  "output_token_balance": 123,
  "total_output_tokens_used": 123,
  "message_count": 123,
  "mcp_server_count": 123,
  "created_at": "<string>",
  "updated_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.shinzo.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

Requires JWT token or Platform API key via Authorization: Bearer <token> header.
​
id
string
required
Agent UUID

​
Example Request

curl https://api.app.shinzo.ai/v1/agent/a1b2c3d4-e5f6-7890-abcd-ef1234567890/summary \
  -H "Authorization: Bearer <token>"

​
Example Response

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "My Assistant",
  "status": "active",
  "output_token_balance": 850000,
  "total_output_tokens_used": 150000,
  "message_count": 42,
  "mcp_server_count": 3,
  "created_at": "2026-02-15T10:00:00Z",
  "updated_at": "2026-02-24T14:30:00Z"
}

​
Response Fields

​
uuid
string
required
Agent UUID
​
name
string
required
Agent name
​
status
string
required
Current agent status: active, paused, stopped, or error
​
output_token_balance
number
required
Remaining output tokens available to the agent
​
total_output_tokens_used
number
required
Total output tokens consumed by the agent lifetime
​
message_count
number
required
Total number of messages sent to/from this agent
​
mcp_server_count
number
required
Number of MCP servers the agent has access to
​
created_at
string
required
ISO 8601 timestamp of agent creation
​
updated_at
string
required
ISO 8601 timestamp of last configuration update
Use this endpoint for status checks and monitoring. For full configuration including system prompts and MCP server details, use Get Agent instead.

​
Status Codes

CodeDescription
200Agent summary retrieved successfully
401Unauthorized - invalid or missing authentication
404Agent not found