Skip to main content
GET
/
api
/
agents
/
{agentId}
/
full
curl -X GET "https://api.zudu.ai/api/agents/agent_1234567890abcdef/full" \
  -H "X-API-KEY: sk_Abc123Def456Ghi789Jkl012Mno345Pqr678Stu901Vwx234Yz" \
  -H "X-API-SECRET: s3cr3t_Xyz789Abc123Def456Ghi789Jkl012Mno345Pqr678Stu901Vwx234" \

{
  "message": "Full agent data retrieved successfully",
  "status": "success",
  "error": null,
  "data": {
    "agent_id": "agent_1234567890abcdef",
    "agent_name": "Customer Support Agent",
    "organization_id": "org_1234567890",
    "language": "en",
    "voice": {
      "provider": "openai",
      "voice_id": "alloy"
    },
    "first_message": "Hello! How can I help you today?",
    "model": "gpt-4",
    "transcription_model": "whisper-1",
    "rag_config": {
      "chunks_to_retrieve": 10,
      "similarity_threshold": 0.2
    },
    "knowledge_base_ids": ["kb_123", "kb_456"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
Retrieve the complete, detailed information for a specific agent including all configuration, settings, and internal details. 
curl -X GET "https://api.zudu.ai/api/agents/agent_1234567890abcdef/full" \
  -H "X-API-KEY: sk_Abc123Def456Ghi789Jkl012Mno345Pqr678Stu901Vwx234Yz" \
  -H "X-API-SECRET: s3cr3t_Xyz789Abc123Def456Ghi789Jkl012Mno345Pqr678Stu901Vwx234" \

{
  "message": "Full agent data retrieved successfully",
  "status": "success",
  "error": null,
  "data": {
    "agent_id": "agent_1234567890abcdef",
    "agent_name": "Customer Support Agent",
    "organization_id": "org_1234567890",
    "language": "en",
    "voice": {
      "provider": "openai",
      "voice_id": "alloy"
    },
    "first_message": "Hello! How can I help you today?",
    "model": "gpt-4",
    "transcription_model": "whisper-1",
    "rag_config": {
      "chunks_to_retrieve": 10,
      "similarity_threshold": 0.2
    },
    "knowledge_base_ids": ["kb_123", "kb_456"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }

​
Path Parameters

​
agentId
string
required
The ID of the agent to retrieve (format: agent_...)Example: agent_1234567890abcdef

​
Headers

​
X-API-KEY
string
required
Your API key (format: sk_...)
​
X-API-SECRET
string
required
Your API secret (format: s3cr3t_...)

​
Response Fields

​
agent_id
string
The unique identifier for the agent
​
agent_name
string
The name of the agent
​
organization_id
string
The organization ID the agent belongs to
​
language
string
Language code for the agent (ISO 639-1)
​
voice
object
Voice configuration including provider and voice ID
​
first_message
string
The initial message the agent will say when a call starts
​
model
string
LLM model being used
​
transcription_model
string
Transcription model being used
​
rag_config
object
RAG configuration for knowledge base retrieval
  • chunks_to_retrieve: Number of chunks retrieved
  • similarity_threshold: Similarity threshold used
​
knowledge_base_ids
array
Array of knowledge base IDs attached to the agent
​
created_at
string
ISO 8601 timestamp when the agent was created
​
updated_at
string
ISO 8601 timestamp when the agent was last updated

​
Error Responses

​
error
string
Unauthorized - Missing or invalid API key/secret
​
error
string
Not Found - Agent does not exist
{
  "message": "Agent not found",
  "status": "error",
  "error": "Agent with ID 'agent_123' does not exist in organization 'org_1234567890'"
}
​
error
string
Internal Server Error - Failed to retrieve agent data
{
  "message": "Failed to retrieve full agent data",
  "status": "error",
  "error": "Database connection failed"
}

​
Notes

  • This endpoint returns the complete agent data including all internal configuration details
  • RAG config is automatically synced from database fields if present
  • Use this endpoint for administrative purposes or when you need full agent details
  • For frontend display, consider using GET /api/agents/{agentId} which returns a frontend-safe version