> ## Documentation Index > Fetch the complete documentation index at: https://docs.getoutbox.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Agent > Retrieve agent details including configuration, tools, files, and platform integrations ## OpenAPI ````yaml GET /agent/{agent_id}/ openapi: 3.1.0 info: title: Outbox AI API description: API for managing AI agents (chatbots and voicebots) on the Outbox platform version: 1.0.0 servers: - url: https://api.getoutbox.ai security: [] paths: /agent/{agent_id}/: get: summary: Get Agent description: >- Retrieve agent details including configuration, tools, files, and platform integrations parameters: - name: agent_id in: path description: The ID of the agent to retrieve required: true schema: type: string responses: '200': description: Agent details retrieved successfully content: application/json: schema: $ref: '#/components/schemas/Agent' '401': description: Unauthorized - Invalid or missing API key '404': description: Agent not found security: - CompanyApiKey: [] components: schemas: Agent: oneOf: - $ref: '#/components/schemas/ChatAgent' - $ref: '#/components/schemas/VoiceAgent' ChatAgent: title: Chat Agent allOf: - $ref: '#/components/schemas/AgentBase' - type: object properties: type: type: string enum: - chatbot description: Agent type discriminator platforms: type: array description: Messaging channels and triggers this chat agent responds to items: $ref: '#/components/schemas/Platform' prompt: type: string description: Chat agent prompt model: type: string default: gpt-4.1 description: Chat model name (defaults to gpt-4.1 if empty) first_message: type: string description: First message shown in supported chat surfaces auto_follow_up_prompt: type: string description: How/when to automatically follow up if a chat goes quiet advanced: $ref: '#/components/schemas/ChatAdvancedSettings' description: Chat agent advanced settings VoiceAgent: title: Voice Agent allOf: - $ref: '#/components/schemas/AgentBase' - type: object properties: type: type: string enum: - voicebot description: Agent type discriminator first_message: type: string description: First spoken message (blank means wait for caller) prompt: type: string description: Voice agent prompt (stored without internal context marker) model: type: object description: LLM configuration for voice calls properties: model: type: string description: Model name max_tokens: type: integer description: Max tokens for responses temperature: type: number description: Sampling temperature language: type: string description: Language code (e.g. "en") voice: $ref: '#/components/schemas/Voice' description: Resolved voice details (present only if voice lookup succeeds) background: type: string description: >- Background audio preset: "office", "lounge", or "off"; or a custom MP3 URL variables: type: array description: Filtered variables available to the voice agent items: $ref: '#/components/schemas/Variable' number_list: type: array description: Phone numbers linked to this voice agent items: $ref: '#/components/schemas/PhoneNumber' compliance: $ref: '#/components/schemas/VoiceComplianceSettings' description: Voice agent compliance and storage controls advanced: $ref: '#/components/schemas/VoiceAdvancedSettings' description: Voice agent advanced settings + white-labeled tuning fields AgentBase: type: object required: - id - name - type - tools - files properties: id: type: string format: uuid description: Unique identifier for the agent name: type: string description: Name of the agent type: type: string enum: - chatbot - voicebot description: Type of agent tools: type: array description: Tools attached to the agent items: $ref: '#/components/schemas/Tool' files: type: array description: Knowledge base files attached to the agent items: $ref: '#/components/schemas/File' Platform: type: object properties: id: type: string platform: type: string min_delay: type: number max_delay: type: number trigger: type: string active: type: boolean ChatAdvancedSettings: type: object properties: timezone: type: string interrupt_mode: type: boolean description: Chatbot only branding_colour: type: string description: 'Branding accent color ("" or hex #RGB / #RRGGBB)' Voice: type: object properties: id: type: string description: Unique identifier for the voice name: type: string description: Name of the voice description: type: string description: Description of the voice characteristics provider: type: string enum: - 11labs - openai description: Voice provider accent: type: string description: Voice accent (e.g., 'australian', 'american', 'british') gender: type: string description: Voice gender (e.g., 'male', 'female') previewUrl: type: string format: uri description: URL to preview the voice style: type: number description: >- 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: type: number description: 'Speed of speech generation (default: 1.00)' stability: type: number description: >- Stability control (default: 0.45). Increasing variability makes speech more expressive with output varying between re-generations, but can lead to instabilities. similarityBoost: type: number description: >- Clarity + Similarity (default: 0.65). Low values are recommended if background artifacts are present in generated speech. useSpeakerBoost: type: boolean description: >- Boost the similarity of synthesized speech and the voice at the cost of some generation speed optimizeStreamingLatency: type: integer description: 'Controls streaming latency optimization level (0-4, default: 1)' autoMode: type: boolean description: >- Reduces latency for complete sentences but may affect quality with partial phrases model: type: string description: >- ElevenLabs voice model (e.g., 'eleven_turbo_v2', 'eleven_turbo_v2_5', 'eleven_multilingual_v1', 'eleven_multilingual_v2', 'eleven_english_v1') Variable: type: object properties: variable: type: string default: type: string name: type: string description: Human-friendly label PhoneNumber: type: object properties: id: type: string number: type: string friendly_name: type: string VoiceComplianceSettings: type: object properties: hipaa_enabled: type: boolean description: >- Store logs, recordings, and transcriptions in HIPAA-compliant storage zdr_enabled: type: boolean description: >- Enable Zero Data Retention where supported so no call data is stored for this agent recording_enabled: type: boolean description: Controls whether call audio recordings are stored transcript_enabled: type: boolean description: Controls whether call transcripts are stored recording_consent_message: type: string description: >- Message the agent says at the start of the call to tell the user the call is being recorded VoiceAdvancedSettings: type: object properties: timezone: type: string branding_colour: type: string description: 'Branding accent color ("" or hex #RGB / #RRGGBB)' voicemail_message: type: string description: What the agent says if voicemail is detected end_call_message: type: string description: Last line the agent says before hanging up webhook_url: type: string description: Voicebot only summary_prompt: type: string description: Voicebot only unqualified_prompt: type: string description: Voicebot only success_prompt: type: string description: Prompt used to evaluate whether the call achieved the agent's goal scoring_prompt: type: string description: Voicebot only keyterms: type: string description: >- Space-separated transcription hints (names, brands, locations) to improve speech-to-text accuracy ("" clears) idle_messages: type: array items: type: string description: >- Voicebot idle messages plan (white-labeled). Default behavior is none (no idle messages). Empty strings are ignored server-side. idle_message_max_spoken_count: type: integer minimum: 1 maximum: 10 description: >- Voicebot only (white-labeled). Maximum number of idle messages spoken per call. idle_timeout_seconds: type: integer minimum: 0 maximum: 60 description: >- Voicebot only (white-labeled). Seconds of silence before the first idle message is eligible to be spoken. llm_request_delay_seconds: type: number nullable: true minimum: 0 maximum: 10 max_call_duration_seconds: type: integer nullable: true minimum: 10 maximum: 7200 interrupt_num_words: type: integer nullable: true minimum: 0 maximum: 50 speech_end_of_turn: type: object properties: threshold: type: number nullable: true minimum: 0 maximum: 1 timeout_ms: type: integer nullable: true minimum: 0 maximum: 60000 speech_stop: type: object properties: num_words: type: integer nullable: true minimum: 0 maximum: 50 voice_seconds: type: number nullable: true minimum: 0 maximum: 10 backoff_seconds: type: number nullable: true minimum: 0 maximum: 30 speech_start: type: object properties: wait_seconds: type: number nullable: true minimum: 0 maximum: 10 Tool: type: object properties: id: type: string name: type: string description: type: string type: type: string builtin_key: type: string nullable: true description: Built-in tool key (builtin tools only) display_name: type: string nullable: true description: Resolved display name for built-in or MCP tools url: type: string mcp_tool: type: string method: type: string auth_token: type: string is_async: type: boolean is_success: type: boolean is_prerun: type: boolean is_postrun: type: boolean config: type: object additionalProperties: true description: Preset tool inputs supplied by the developer icon_url: type: string application_icon_url: type: string nullable: true messages: type: array items: type: object properties: type: type: string content: type: string schema: type: array items: $ref: '#/components/schemas/ToolParameter' File: type: object properties: id: type: string name: type: string file: description: >- File reference (implementation-specific; may be a URL, path, or sentinel) oneOf: - type: string - type: boolean type: type: string created_at: type: string format: date-time description: 'Format: YYYY-MM-DD HH:MM:SS' ToolParameter: type: object properties: id: type: string name: type: string description: type: string type: type: string required: type: boolean securitySchemes: CompanyApiKey: type: apiKey in: header name: Authorization description: Company API Key ````