> ## Documentation Index > Fetch the complete documentation index at: https://doc.featherhq.com/llms.txt > Use this file to discover all available pages before exploring further. # Get the voice pipeline config for an agent ## OpenAPI ````yaml /api-reference/openapi.json get /v1/voice/agents/{agent_id}/voice-config openapi: 3.1.0 info: title: Feather API description: >- Unified customer experience platform API. Manages identity, conversations, memory, agents, procedures, policies, model routing, knowledge bases, integrations, and runtime execution. version: 1.21.0 servers: - url: https://api-sandbox.featherhq.com description: Sandbox - url: http://localhost:8000 description: Local dev security: [] paths: /v1/voice/agents/{agent_id}/voice-config: get: tags: - voice summary: Get the voice pipeline config for an agent operationId: getVoicePipelineConfigForAgent parameters: - name: agent_id in: path required: true schema: type: string format: uuid title: Agent Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VoicePipelineConfigResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] components: schemas: VoicePipelineConfigResponse: properties: id: type: string format: uuid title: Id organization_id: anyOf: - type: string format: uuid - type: 'null' title: Organization Id agent_id: anyOf: - type: string format: uuid - type: 'null' title: Agent Id team_id: anyOf: - type: string format: uuid - type: 'null' title: Team Id persona_id: anyOf: - type: string format: uuid - type: 'null' title: Persona Id voice_id: type: string format: uuid title: Voice Id voice: $ref: '#/components/schemas/VoiceOut' voice_tuning: additionalProperties: true type: object title: Voice Tuning stt_provider: type: string title: Stt Provider stt_model: anyOf: - type: string - type: 'null' title: Stt Model stt_language: type: string title: Stt Language stt_provider_data: additionalProperties: true type: object title: Stt Provider Data tts_speed: anyOf: - type: number - type: 'null' title: Tts Speed tts_provider_data: additionalProperties: true type: object title: Tts Provider Data vad_provider: type: string title: Vad Provider vad_provider_data: additionalProperties: true type: object title: Vad Provider Data local_vad_params: additionalProperties: true type: object title: Local Vad Params turn_analyzer_params: additionalProperties: true type: object title: Turn Analyzer Params interruptions_enabled: type: boolean title: Interruptions Enabled interruption_min_words: type: integer title: Interruption Min Words interruption_min_duration_ms: type: integer title: Interruption Min Duration Ms interruption_backoff_ms: type: integer title: Interruption Backoff Ms interruption_sensitivity: type: number title: Interruption Sensitivity interruption_trigger_phrases: items: type: string type: array title: Interruption Trigger Phrases interruption_hard_phrases: items: type: string type: array title: Interruption Hard Phrases interruption_final_transcript_grace_ms: type: integer title: Interruption Final Transcript Grace Ms hard_turn_timeout_ms: anyOf: - type: integer - type: 'null' title: Hard Turn Timeout Ms min_endpoint_delay_ms: type: integer title: Min Endpoint Delay Ms max_endpoint_delay_ms: type: integer title: Max Endpoint Delay Ms preemptive_generation_enabled: type: boolean title: Preemptive Generation Enabled voicemail_detection_mode: type: string title: Voicemail Detection Mode voicemail_detection_timeout_ms: type: integer title: Voicemail Detection Timeout Ms voicemail_detection_model: anyOf: - type: string - type: 'null' title: Voicemail Detection Model voicemail_message: anyOf: - type: string - type: 'null' title: Voicemail Message max_call_duration_ms: type: integer title: Max Call Duration Ms end_call_phrases: items: type: string type: array title: End Call Phrases silence_timeout_ms: type: integer title: Silence Timeout Ms silence_reminder_count: type: integer title: Silence Reminder Count silence_reminder_mode: type: string title: Silence Reminder Mode silence_reminder_message: anyOf: - type: string - type: 'null' title: Silence Reminder Message silence_end_action: type: string title: Silence End Action silence_end_message: anyOf: - type: string - type: 'null' title: Silence End Message dtmf_enabled: type: boolean title: Dtmf Enabled dtmf_termination_digit: type: string title: Dtmf Termination Digit dtmf_inter_digit_timeout_ms: type: integer title: Dtmf Inter Digit Timeout Ms dtmf_max_digits: type: integer title: Dtmf Max Digits dtmf_prefix: type: string title: Dtmf Prefix backchannel_enabled: type: boolean title: Backchannel Enabled backchannel_frequency: anyOf: - type: integer - type: 'null' title: Backchannel Frequency pronunciation_overrides: additionalProperties: type: string type: object title: Pronunciation Overrides background_audio_preset: anyOf: - type: string - type: 'null' title: Background Audio Preset background_audio_volume: type: number title: Background Audio Volume background_audio_loop: type: boolean title: Background Audio Loop background_audio_enabled: type: boolean title: Background Audio Enabled noise_cancellation_enabled: type: boolean title: Noise Cancellation Enabled recording_enabled: type: boolean title: Recording Enabled transcription_storage_enabled: type: boolean title: Transcription Storage Enabled normalize_for_speech: type: boolean title: Normalize For Speech audio_in_sample_rate: type: integer title: Audio In Sample Rate audio_out_sample_rate: type: integer title: Audio Out Sample Rate metrics_enabled: type: boolean title: Metrics Enabled usage_metrics_enabled: type: boolean title: Usage Metrics Enabled heartbeats_period_secs: anyOf: - type: integer - type: 'null' title: Heartbeats Period Secs idle_pipeline_timeout_ms: anyOf: - type: integer - type: 'null' title: Idle Pipeline Timeout Ms language: type: string title: Language locale: anyOf: - type: string - type: 'null' title: Locale multilingual_enabled: type: boolean title: Multilingual Enabled multilingual_languages: items: type: string type: array title: Multilingual Languages metadata_: additionalProperties: true type: object title: Metadata first_speaking_config: anyOf: - $ref: '#/components/schemas/FirstSpeakingConfig' - type: 'null' warnings: items: type: string type: array title: Warnings created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At additionalProperties: false type: object required: - id - voice_id - voice - stt_provider - stt_language - vad_provider - interruptions_enabled - interruption_min_words - interruption_min_duration_ms - interruption_backoff_ms - interruption_sensitivity - interruption_final_transcript_grace_ms - min_endpoint_delay_ms - max_endpoint_delay_ms - preemptive_generation_enabled - voicemail_detection_mode - voicemail_detection_timeout_ms - max_call_duration_ms - silence_timeout_ms - silence_reminder_count - silence_reminder_mode - silence_end_action - dtmf_enabled - dtmf_termination_digit - dtmf_inter_digit_timeout_ms - dtmf_max_digits - dtmf_prefix - backchannel_enabled - background_audio_volume - background_audio_loop - background_audio_enabled - noise_cancellation_enabled - recording_enabled - transcription_storage_enabled - normalize_for_speech - audio_in_sample_rate - audio_out_sample_rate - metrics_enabled - usage_metrics_enabled - language - multilingual_enabled - created_at - updated_at title: VoicePipelineConfigResponse ErrorResponse: properties: error: type: string title: Error message: type: string title: Message type: object required: - error - message title: ErrorResponse description: Standard error response returned by all API error handlers. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError VoiceOut: properties: id: type: string format: uuid title: Id provider: type: string const: elevenlabs title: Provider external_id: type: string title: External Id name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description preview_url: anyOf: - type: string - type: 'null' title: Preview Url language: anyOf: - type: string - type: 'null' title: Language accent: anyOf: - type: string - type: 'null' title: Accent category: anyOf: - type: string - type: 'null' title: Category labels: additionalProperties: type: string type: object title: Labels supported_models: items: type: string type: array title: Supported Models is_active: type: boolean title: Is Active default: true created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - provider - external_id - name - created_at - updated_at title: VoiceOut FirstSpeakingConfig: properties: first_speaker: type: string enum: - agent - user title: First Speaker default: agent mode: type: string enum: - static - dynamic title: Mode default: static text: anyOf: - type: string maxLength: 1000 - type: 'null' title: Text instructions: anyOf: - type: string maxLength: 2000 - type: 'null' title: Instructions interruptible: type: boolean title: Interruptible default: true ai_disclosure_text: anyOf: - type: string maxLength: 500 - type: 'null' title: Ai Disclosure Text type: object title: FirstSpeakingConfig description: |- Config for the AI's opening turn (no user input yet). Lives inside ``ChannelConfig`` — first-speaking is per-channel. Mode-agnostic fields: - ``first_speaker``: ``"agent"`` opens the call with the rendered message; ``"user"`` skips the greeting (caller speaks first). Non-voice channels treat the inbound user message as the ``"user"`` opener and ignore this field at runtime. Greeting source (only applies when ``first_speaker="agent"``): - ``static`` mode: ``text`` is required and emitted verbatim (templated via the shared ``{{var}}`` engine, ``src.shared.templating.render``). - ``dynamic`` mode: ``instructions`` are sent to the model router with the agent persona to render an opening line (instructions are templated). When omitted/empty, ``instructions`` falls back to ``DEFAULT_DYNAMIC_FIRST_SPEAKING_INSTRUCTIONS`` so operators who just want a generic friendly opener don't have to author copy. Voice-only fields (ignored on non-audio channels): - ``interruptible``: whether the caller can barge in mid-greeting. - ``ai_disclosure_text``: regulatory disclosure (e.g. CA SB 1001), played as an uninterruptible TTS frame BEFORE the greeting. Disclosure plays even when ``first_speaker="user"`` because the regulation requires the disclosure regardless of who speaks first. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: APIKeyHeader: type: apiKey in: header name: x-api-key ````