Get Agent

Retrieve detailed information about a specific agent.

GET /v1/agent/{id}

Get Agent

cURL

curl --request GET \
  --url https://api.app.shinzo.ai/v1/agent/{id} \
  --header 'Authorization: Bearer <token>'

Authentication

Requires JWT token or Platform API key via Authorization: Bearer <token> header.

id · string · required

Agent UUID

Example Request

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

Example Response

{
  "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",
  "configuration": {
    "timeout_seconds": 1800,
    "memory_config": {
      "type": "hierarchical",
      "max_size_mb": 1024,
      "persistence": "persistent"
    },
    "webhooks": {
      "message_complete": "https://myapp.com/webhooks/complete"
    },
    "compaction": {
      "enabled": true,
      "model": "claude-haiku-4-5-20251001",
      "threshold_trigger": 120000
    }
  },
  "system_prompt": "You are a senior code reviewer.",
  "system_prompt_type": "append",
  "mcp_servers": [
    {
      "id": "srv_abc123",
      "name": "github-mcp",
      "access_mode": "all",
      "status": "active"
    }
  ],
  "filesystem_summary": {
    "total_files": 15,
    "total_size_mb": 2.4,
    "last_modified": "2025-01-18T14:30:00Z"
  }
}

Status Codes

Code	Description
200	Success
401	Unauthorized - invalid or missing authentication
403	AI Agents feature not enabled for your account
404	Agent not found