Skip to main content
GET
/
agent
/
:id
Get Agent
curl --request GET \
  --url https://api.example.com/agent/:id

Get Agent

Get detailed information about a specific agent.

Endpoint

GET /agent/:id

Authentication

Requires JWT token or Platform API key.

Path Parameters

ParameterTypeDescription
idstringAgent UUID

Example Request

curl -X GET https://api.app.shinzo.ai/agent/agt_abc123def456 \
  -H "Authorization: Bearer <jwt_token>"

Response

{
  "uuid": "agt_abc123def456",
  "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",
  "endpoint_url": "https://agent-abc123.shinzo.ai",
  "container_id": "k8s-pod-xyz789",
  "configuration": {
    "timeout_seconds": 1800,
    "memory_config": {
      "type": "hierarchical",
      "max_size_mb": 1024,
      "persistence": "persistent"
    },
    "webhooks": {
      "task_complete": "https://myapp.com/webhooks/task-complete"
    }
  },
  "stats": {
    "task_count": 45,
    "active_tasks": 1,
    "completed_tasks": 42,
    "failed_tasks": 2,
    "avg_task_duration_seconds": 125
  }
}

Response Fields

FieldTypeDescription
uuidstringUnique agent identifier
namestringAgent name
descriptionstringAgent description
statusstringCurrent status
endpoint_urlstringAgent’s API endpoint
container_idstringKubernetes pod identifier
configurationobjectAgent configuration
statsobjectUsage statistics

Status Codes

CodeDescription
200Success
401Invalid authentication
403AI Agents feature not enabled
404Agent not found