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
AI model name (e.g., 'gpt-4.1-mini', 'gpt-4.1', 'gpt-4o', 'gpt-5')
Maximum number of tokens in the model's response
Controls randomness and creativity of responses (0.0 to 1.0). Lower values make responses more focused and deterministic, while higher values allow for more varied responses.
Initial message sent by the agent
Show child attributes
Language for the agent (voicebot only)
Voice settings (voicebot only)
Show child attributes
Unique identifier for the voice
Name of the voice
Description of the voice characteristics
Voice provider (e.g., '11labs')
Voice accent (e.g., 'australian', 'american', 'british')
Voice gender (e.g., 'male', 'female')
URL to preview the voice
Style exaggeration (default: 0.00). High values exaggerate the style compared to uploaded audio but can lead to instability. Setting to 0.0 greatly increases generation speed.
Speed of speech generation (default: 1.00)
Stability control (default: 0.45). Increasing variability makes speech more expressive with output varying between re-generations, but can lead to instabilities.
Clarity + Similarity (default: 0.65). Low values are recommended if background artifacts are present in generated speech.
Boost the similarity of synthesized speech and the voice at the cost of some generation speed
Controls streaming latency optimization level (0-4, default: 1)
Reduces latency for complete sentences but may affect quality with partial phrases
ElevenLabs voice model (e.g., 'eleven_turbo_v2', 'eleven_turbo_v2_5', 'eleven_multilingual_v1', 'eleven_multilingual_v2', 'eleven_english_v1')
Background audio (voicebot only)
lounge, off, url Custom background audio URL used when background is set to url (voicebot only)
Show child attributes
Chatbot only
Voicebot only
Voicebot only
Voicebot only
Voicebot only
Voicebot only
Voicebot only
Voicebot only
Space-separated keywords (voicebot only)
Voicebot only
Voicebot only
Voicebot only