Skip to main content
GET
/
v1
/
agent
/
{id}
/
ready
Check Agent Ready
curl --request GET \
  --url https://api.app.shinzo.ai/v1/agent/{id}/ready \
  --header 'Authorization: Bearer <token>'
{
  "ready": true,
  "status": "<string>",
  "pod_status": "<string>",
  "last_heartbeat": "<string>",
  "reason": "<string>"
}

​
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/ready \
  -H "Authorization: Bearer <token>"

​
Example Response

​
Agent Ready

{
  "ready": true,
  "status": "active",
  "pod_status": "running",
  "last_heartbeat": "2026-02-24T14:30:00Z"
}

​
Agent Not Ready

{
  "ready": false,
  "status": "stopped",
  "pod_status": "not_running",
  "reason": "Agent pod is stopped"
}

​
Response Fields

​
ready
boolean
required
Whether the agent is ready to receive and process messages
​
status
string
required
Current agent status: active, paused, stopped, or error
​
pod_status
string
required
Kubernetes pod status: running, pending, not_running, or error
​
last_heartbeat
string
ISO 8601 timestamp of last health check from agent pod (only present if pod is running)
​
reason
string
Human-readable reason why agent is not ready (only present if ready is false)
Use this endpoint before sending messages to ensure the agent is available. An agent is ready when its status is active and its pod is running.

​
Status Codes

CodeDescription
200Readiness check completed
401Unauthorized - invalid or missing authentication
404Agent not found