curl --request GET \
--url https://api.getoutbox.ai/agent/{agent_id}/ \
--header 'Authorization: <api-key>'{
"id": "<string>",
"name": "<string>",
"type": "chatbot",
"prompt": "<string>",
"model": {
"model": "<string>",
"max_tokens": 123,
"temperature": 123
},
"first_message": "<string>",
"tools": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"url": "<string>",
"mcp_tool": "<string>",
"method": "<string>",
"auth_token": "<string>",
"is_async": true,
"is_success": true,
"icon_url": "<string>",
"messages": [
{
"type": "<string>",
"content": "<string>"
}
],
"schema": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"required": true
}
]
}
],
"files": [
{
"id": "<string>",
"name": "<string>",
"file": true,
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"platforms": [
{
"id": "<string>",
"platform": "<string>",
"min_delay": 123,
"max_delay": 123,
"trigger": "<string>",
"active": true
}
],
"language": "<string>",
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"provider": "<string>",
"accent": "<string>",
"gender": "<string>",
"previewUrl": "<string>",
"style": 123,
"speed": 123,
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": true,
"optimizeStreamingLatency": 123,
"autoMode": true,
"model": "<string>"
},
"background": "lounge",
"background_url": "<string>",
"variables": [
{
"variable": "<string>",
"default": "<string>"
}
],
"number_list": [
{
"id": "<string>",
"number": "<string>",
"friendly_name": "<string>"
}
],
"advanced": {
"timezone": "<string>",
"interrupt_mode": true,
"hipaa_enabled": true,
"forwarding_number": "<string>",
"voicemail_message": "<string>",
"end_call_message": "<string>",
"unqualified_prompt": "<string>",
"scoring_prompt": "<string>",
"summary_prompt": "<string>",
"keyterms": "<string>",
"webhook_url": "<string>",
"log_to_crm": true,
"recording_consent_message": "<string>"
}
}Retrieve agent details including configuration, tools, files, and platform integrations
curl --request GET \
--url https://api.getoutbox.ai/agent/{agent_id}/ \
--header 'Authorization: <api-key>'{
"id": "<string>",
"name": "<string>",
"type": "chatbot",
"prompt": "<string>",
"model": {
"model": "<string>",
"max_tokens": 123,
"temperature": 123
},
"first_message": "<string>",
"tools": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"url": "<string>",
"mcp_tool": "<string>",
"method": "<string>",
"auth_token": "<string>",
"is_async": true,
"is_success": true,
"icon_url": "<string>",
"messages": [
{
"type": "<string>",
"content": "<string>"
}
],
"schema": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"required": true
}
]
}
],
"files": [
{
"id": "<string>",
"name": "<string>",
"file": true,
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"platforms": [
{
"id": "<string>",
"platform": "<string>",
"min_delay": 123,
"max_delay": 123,
"trigger": "<string>",
"active": true
}
],
"language": "<string>",
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"provider": "<string>",
"accent": "<string>",
"gender": "<string>",
"previewUrl": "<string>",
"style": 123,
"speed": 123,
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": true,
"optimizeStreamingLatency": 123,
"autoMode": true,
"model": "<string>"
},
"background": "lounge",
"background_url": "<string>",
"variables": [
{
"variable": "<string>",
"default": "<string>"
}
],
"number_list": [
{
"id": "<string>",
"number": "<string>",
"friendly_name": "<string>"
}
],
"advanced": {
"timezone": "<string>",
"interrupt_mode": true,
"hipaa_enabled": true,
"forwarding_number": "<string>",
"voicemail_message": "<string>",
"end_call_message": "<string>",
"unqualified_prompt": "<string>",
"scoring_prompt": "<string>",
"summary_prompt": "<string>",
"keyterms": "<string>",
"webhook_url": "<string>",
"log_to_crm": true,
"recording_consent_message": "<string>"
}
}Company API Key
The ID of the agent to retrieve
Agent details retrieved successfully
Unique identifier for the agent
Name of the agent
Type of agent
chatbot, voicebot System prompt for the agent
AI model configuration
Show child attributes
Initial message sent by the agent
Show child attributes
Show child attributes
Platform integrations (chatbot only)
Show child attributes
Language for the agent (voicebot only)
Voice settings (voicebot only)
Show child attributes
Background audio (voicebot only)
lounge, off, url Custom background audio URL used when background is set to url (voicebot only)
Custom variables (voicebot only)
Show child attributes
Associated phone numbers (voicebot only)
Show child attributes
Show child attributes