> ## 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.

# Partial update of a voice pipeline config



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/voice/configs/{config_id}
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/configs/{config_id}:
    patch:
      tags:
        - voice
      summary: Partial update of a voice pipeline config
      operationId: updateVoicePipelineConfig
      parameters:
        - name: config_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Config Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoicePipelineConfigUpdate'
      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:
    VoicePipelineConfigUpdate:
      properties:
        voice_tuning:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Voice Tuning
        stt_provider:
          anyOf:
            - type: string
              maxLength: 32
            - type: 'null'
          title: Stt Provider
        stt_model:
          anyOf:
            - type: string
              maxLength: 64
            - type: 'null'
          title: Stt Model
        stt_provider_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Stt Provider Data
        tts_speed:
          anyOf:
            - type: number
              exclusiveMaximum: 10
              minimum: 0
            - type: 'null'
          title: Tts Speed
        tts_provider_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Tts Provider Data
        vad_provider_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Vad Provider Data
        local_vad_params:
          anyOf:
            - $ref: '#/components/schemas/LocalVADParams'
            - type: 'null'
        turn_analyzer_params:
          anyOf:
            - $ref: '#/components/schemas/TurnAnalyzerParams'
            - type: 'null'
        interruptions_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Interruptions Enabled
        interruption_min_words:
          anyOf:
            - type: integer
              maximum: 20
              minimum: 0
            - type: 'null'
          title: Interruption Min Words
        interruption_min_duration_ms:
          anyOf:
            - type: integer
              maximum: 10000
              minimum: 0
            - type: 'null'
          title: Interruption Min Duration Ms
        interruption_backoff_ms:
          anyOf:
            - type: integer
              maximum: 10000
              minimum: 0
            - type: 'null'
          title: Interruption Backoff Ms
        interruption_trigger_phrases:
          anyOf:
            - items:
                type: string
              type: array
              maxItems: 50
            - type: 'null'
          title: Interruption Trigger Phrases
        interruption_hard_phrases:
          anyOf:
            - items:
                type: string
              type: array
              maxItems: 20
            - type: 'null'
          title: Interruption Hard Phrases
        interruption_final_transcript_grace_ms:
          anyOf:
            - type: integer
              maximum: 2000
              minimum: 0
            - type: 'null'
          title: Interruption Final Transcript Grace Ms
        voicemail_detection_mode:
          anyOf:
            - $ref: '#/components/schemas/VoicemailDetectionMode'
            - type: 'null'
        voicemail_detection_timeout_ms:
          anyOf:
            - type: integer
              maximum: 60000
              minimum: 0
            - type: 'null'
          title: Voicemail Detection Timeout Ms
        voicemail_detection_model:
          anyOf:
            - type: string
              maxLength: 64
            - type: 'null'
          title: Voicemail Detection Model
        voicemail_message:
          anyOf:
            - type: string
              maxLength: 1000
            - type: 'null'
          title: Voicemail Message
        max_call_duration_ms:
          anyOf:
            - type: integer
              maximum: 14400000
              minimum: 1000
            - type: 'null'
          title: Max Call Duration Ms
        silence_timeout_ms:
          anyOf:
            - type: integer
              maximum: 600000
              minimum: 0
            - type: 'null'
          title: Silence Timeout Ms
        silence_reminder_count:
          anyOf:
            - type: integer
              maximum: 10
              minimum: 0
            - type: 'null'
          title: Silence Reminder Count
        silence_reminder_mode:
          anyOf:
            - $ref: '#/components/schemas/SilenceReminderMode'
            - type: 'null'
        silence_reminder_message:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Silence Reminder Message
        silence_end_action:
          anyOf:
            - $ref: '#/components/schemas/SilenceEndAction'
            - type: 'null'
        silence_end_message:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Silence End Message
        dtmf_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Dtmf Enabled
        dtmf_termination_digit:
          anyOf:
            - type: string
              maxLength: 1
            - type: 'null'
          title: Dtmf Termination Digit
        dtmf_inter_digit_timeout_ms:
          anyOf:
            - type: integer
              maximum: 60000
              minimum: 250
            - type: 'null'
          title: Dtmf Inter Digit Timeout Ms
        dtmf_max_digits:
          anyOf:
            - type: integer
              maximum: 64
              minimum: 1
            - type: 'null'
          title: Dtmf Max Digits
        dtmf_prefix:
          anyOf:
            - type: string
              maxLength: 32
            - type: 'null'
          title: Dtmf Prefix
        pronunciation_overrides:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Pronunciation Overrides
        noise_cancellation_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Noise Cancellation Enabled
        background_audio_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Background Audio Enabled
        background_audio_preset:
          anyOf:
            - $ref: '#/components/schemas/BackgroundAudioPreset'
            - type: 'null'
        background_audio_volume:
          anyOf:
            - type: number
              maximum: 1
              minimum: 0
            - type: 'null'
          title: Background Audio Volume
        background_audio_loop:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Background Audio Loop
        language:
          anyOf:
            - type: string
              maxLength: 16
            - type: 'null'
          title: Language
        locale:
          anyOf:
            - type: string
              maxLength: 16
            - type: 'null'
          title: Locale
        multilingual_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Multilingual Enabled
        multilingual_languages:
          anyOf:
            - items:
                type: string
              type: array
              maxItems: 50
            - type: 'null'
          title: Multilingual Languages
        first_speaker:
          anyOf:
            - type: string
              enum:
                - agent
                - user
            - type: 'null'
          title: First Speaker
        mode:
          anyOf:
            - type: string
              enum:
                - static
                - dynamic
            - type: 'null'
          title: Mode
        text:
          anyOf:
            - type: string
              maxLength: 1000
            - type: 'null'
          title: Text
        instructions:
          anyOf:
            - type: string
              maxLength: 2000
            - type: 'null'
          title: Instructions
        interruptible:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Interruptible
        ai_disclosure_text:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Ai Disclosure Text
        voice_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Voice Id
      additionalProperties: false
      type: object
      title: VoicePipelineConfigUpdate
    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
    LocalVADParams:
      properties:
        confidence:
          type: number
          maximum: 1
          minimum: 0
          title: Confidence
          default: 0.7
        start_secs:
          type: number
          maximum: 2
          minimum: 0
          title: Start Secs
          default: 0.2
        stop_secs:
          type: number
          maximum: 3
          minimum: 0
          title: Stop Secs
          default: 0.5
        min_volume:
          type: number
          maximum: 1
          minimum: 0
          title: Min Volume
          default: 0.6
      additionalProperties: false
      type: object
      title: LocalVADParams
      description: Silero VAD tuning. Always applied for Deepgram Nova; ignored otherwise.
    TurnAnalyzerParams:
      properties:
        stop_secs:
          type: number
          maximum: 8
          minimum: 0.5
          title: Stop Secs
          default: 2
        pre_speech_ms:
          type: number
          maximum: 2000
          minimum: 0
          title: Pre Speech Ms
          default: 500
        max_duration_secs:
          type: number
          maximum: 30
          minimum: 2
          title: Max Duration Secs
          default: 8
      additionalProperties: false
      type: object
      title: TurnAnalyzerParams
      description: >-
        Smart-turn-v3 tuning. Always applied for Deepgram Nova; ignored
        otherwise.
    VoicemailDetectionMode:
      type: string
      enum:
        - 'off'
        - leave_message
      title: VoicemailDetectionMode
    SilenceReminderMode:
      type: string
      enum:
        - static
        - auto
      title: SilenceReminderMode
    SilenceEndAction:
      type: string
      enum:
        - hangup_immediate
        - speak_then_hangup
      title: SilenceEndAction
    BackgroundAudioPreset:
      type: string
      enum:
        - office
        - cafe
        - city
        - keyboard_typing
        - keyboard_typing2
      title: BackgroundAudioPreset
      description: |-
        Bundled CC0 ambience presets resolved by the voice worker.

        String values MUST match the keys of ``_PRESET_FILES`` in
        ``src/communication/voice/agent/background_audio.py``; a unit test
        (``tests/voice/test_background_audio.py``) fails CI if the two ever
        drift.
    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

````