curl -X GET "https://api.nedzo.ai/v1/agents" \
-H "Authorization: Bearer YOUR_API_KEY"
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Agent",
"agentType": "Voice",
"direction": "inbound",
"prompt": "You are a helpful customer support assistant.",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "english",
"voicemail": false,
"voicemailMessage": null,
"hipaaCompliance": false,
"callDuration": 30,
"speed": 1.0,
"voiceId": "voice_123",
"postConversationWebhookUrl": null,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
]
[
{
"workspaceId": "789e4567-e89b-12d3-a456-426614174000",
"workspaceName": "My Workspace",
"agents": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Agent",
"agentType": "Voice",
"direction": "inbound",
"prompt": "You are a helpful customer support assistant.",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "english",
"voicemail": false,
"voicemailMessage": null,
"hipaaCompliance": false,
"callDuration": 30,
"speed": 1.0,
"voiceId": "voice_123",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
]
}
]
Agents
List agents
Retrieve all AI agents via the Nedzo REST API. Workspace keys return agents in that workspace; account keys return agents across all workspaces.
GET
/
agents
curl -X GET "https://api.nedzo.ai/v1/agents" \
-H "Authorization: Bearer YOUR_API_KEY"
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Agent",
"agentType": "Voice",
"direction": "inbound",
"prompt": "You are a helpful customer support assistant.",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "english",
"voicemail": false,
"voicemailMessage": null,
"hipaaCompliance": false,
"callDuration": 30,
"speed": 1.0,
"voiceId": "voice_123",
"postConversationWebhookUrl": null,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
]
[
{
"workspaceId": "789e4567-e89b-12d3-a456-426614174000",
"workspaceName": "My Workspace",
"agents": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Agent",
"agentType": "Voice",
"direction": "inbound",
"prompt": "You are a helpful customer support assistant.",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "english",
"voicemail": false,
"voicemailMessage": null,
"hipaaCompliance": false,
"callDuration": 30,
"speed": 1.0,
"voiceId": "voice_123",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
]
}
]
List agents based on API key scope. Workspace API keys return agents in that workspace only. Account API keys return all agents across all workspaces, grouped by workspace.
curl -X GET "https://api.nedzo.ai/v1/agents" \
-H "Authorization: Bearer YOUR_API_KEY"
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Agent",
"agentType": "Voice",
"direction": "inbound",
"prompt": "You are a helpful customer support assistant.",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "english",
"voicemail": false,
"voicemailMessage": null,
"hipaaCompliance": false,
"callDuration": 30,
"speed": 1.0,
"voiceId": "voice_123",
"postConversationWebhookUrl": null,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
]
[
{
"workspaceId": "789e4567-e89b-12d3-a456-426614174000",
"workspaceName": "My Workspace",
"agents": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Agent",
"agentType": "Voice",
"direction": "inbound",
"prompt": "You are a helpful customer support assistant.",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "english",
"voicemail": false,
"voicemailMessage": null,
"hipaaCompliance": false,
"callDuration": 30,
"speed": 1.0,
"voiceId": "voice_123",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
]
}
]
Was this page helpful?
⌘I