> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Call Agent

> Update Call Agent

Update voice and personality settings for the organization's call agent.



## OpenAPI

````yaml https://api.stuut.ai/openapi.json patch /v2/call-agent
openapi: 3.1.0
info:
  title: Stuut API
  termsOfService: https://stuut.ai/terms-and-conditions
  contact:
    name: Stuut Support
    url: https://stuut.ai/
    email: devs@stuut.co
  version: 2.0.0
servers: []
security:
  - HTTPBearer: []
tags:
  - name: adjustments
    description: Operations for managing payment adjustments (fees, discounts, write-offs).
    x-displayName: Adjustments
  - name: aether
    description: Operations for aether.
    x-displayName: Aether
  - name: analytics
    description: Operations for retrieving analytics and dashboard data.
    x-displayName: Analytics
  - name: assistant
    description: Operations for the in-app chat assistant.
    x-displayName: Assistant
  - name: audit-log
    description: Operations for retrieving the organization's audit log.
    x-displayName: Audit Log
  - name: bank-accounts
    description: Operations for retrieving and managing bank accounts.
    x-displayName: Bank Accounts
  - name: bank-statements
    description: Operations for retrieving and managing bank statements.
    x-displayName: Bank Statements
  - name: bank-transactions
    description: Operations for retrieving and managing bank transactions.
    x-displayName: Bank Transactions
  - name: business-units
    description: Operations for listing and managing business units.
    x-displayName: Business Units
  - name: call-agent
    description: >-
      Operations for initiating and managing real-time voice calls with
      partners.
    x-displayName: Call Agent
  - name: calls
    description: Operations for retrieving and managing voice call records.
    x-displayName: Calls
  - name: cash-app
    description: Operations for cash application — matching incoming payments to invoices.
    x-displayName: Cash Application
  - name: chats
    description: Operations for managing chat conversations.
    x-displayName: Chats
  - name: cnam-registration
    description: Operations for managing CNAM (caller ID name) registration.
    x-displayName: CNAM Registration
  - name: credit-memos
    description: Operations for retrieving and searching credit memos.
    x-displayName: Credit Memos
  - name: custom-table-templates
    description: >-
      Operations for managing custom table templates used in email template
      variables.
    x-displayName: Custom Table Templates
  - name: customer-segments
    description: Operations for managing customer segments.
    x-displayName: Customer Segments
  - name: deductions-knowledge
    description: Operations for managing deduction processing knowledge entries.
    x-displayName: Deductions Knowledge
  - name: email-threads
    description: Operations for managing email threads.
    x-displayName: Email Threads
  - name: emails
    description: Operations for retrieving and managing emails.
    x-displayName: Emails
  - name: exports
    description: Operations for requesting and retrieving async data exports.
    x-displayName: Exports
  - name: integrations
    description: >-
      Operations for managing integrations with external systems (e.g. ERP, CRM,
      etc.).
    x-displayName: Integrations
  - name: internal-contacts
    description: >-
      Operations for managing internal contacts (CSMs, account managers, etc.)
      and their assignments to partners.
    x-displayName: Internal Contacts
  - name: invoices
    description: Operations for retrieving and managing invoices.
    x-displayName: Invoices
  - name: kyb
    description: Operations for Know Your Business (KYB) verification.
    x-displayName: KYB
  - name: ledger-accounts
    description: Operations for retrieving and managing ledger accounts.
    x-displayName: Ledger Accounts
  - name: mailbox-settings
    description: >-
      Operations for an organization's mailbox provider configuration: Microsoft
      admin consent, shared-mailbox discovery, and provider health.
    x-displayName: Mailbox Settings
  - name: mailboxes
    description: >-
      Operations for connecting, listing, updating, and archiving user and
      shared mailboxes, including delegated OAuth sign-in.
    x-displayName: Mailboxes
  - name: media
    description: >-
      Operations for signing direct-to-storage media uploads (e.g. signature
      images).
    x-displayName: Media
  - name: organizations
    description: Operations for retrieving and managing the current organization.
    x-displayName: Organizations
  - name: outreach-workflows
    description: Operations for managing automated collections outreach workflows.
    x-displayName: Outreach Workflows
  - name: partners
    description: Operations for retrieving and managing customers.
    x-displayName: Partners
  - name: payments
    description: Operations for approving and managing payments.
    x-displayName: Payments
  - name: report-configs
    description: >-
      Operations for managing report configurations (frequency, recipients,
      schedule).
    x-displayName: Report Configs
  - name: sms-campaign-registration
    description: Operations for managing A2P 10DLC SMS campaign registration.
    x-displayName: SMS Campaign Registration
  - name: sms-templates
    description: >-
      Operations for defining, storing, and managing parameterized SMS message
      templates.
    x-displayName: SMS Templates
  - name: sms-threads
    description: Operations for retrieving and managing SMS conversation threads.
    x-displayName: SMS Threads
  - name: users
    description: Operations for retrieving and managing users.
    x-displayName: Users
  - name: users-ooo
    description: Operations for managing user out-of-office (OOO) status and coverage.
    x-displayName: Users OOO
paths:
  /v2/call-agent:
    patch:
      tags:
        - call-agent
      summary: Update Call Agent
      description: |-
        Update Call Agent

        Update voice and personality settings for the organization's call agent.
      operationId: PatchCallAgent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCallAgentRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallAgentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    UpdateCallAgentRequest:
      properties:
        end_call_on_recording_refusal:
          anyOf:
            - type: boolean
            - type: 'null'
          title: ''
          description: >-
            Whether to hang up the call if the user does not consent to
            recording
        recording_disclaimer_required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: ''
          description: >-
            Whether the call agent must include the recording disclaimer. Only
            Stuut staff can update this field.
        outbound_begin_message:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: The opening line of the call agent.
        voice_id:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: Voice DB ID (vce_...)
        voice_speed:
          anyOf:
            - $ref: '#/components/schemas/Speed'
            - type: 'null'
          title: ''
          description: Voice speed
        voice_temperature:
          anyOf:
            - type: number
              maximum: 2
              minimum: 0
            - type: 'null'
          title: ''
          description: Voice temperature 0.0-2.0
        language_code:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: >-
            BCP-47 starting language for the call agent (e.g. 'en-US', 'nl-NL').
            When stt_mode=AUTO, this is the starting hint (observer may swap).
            When stt_mode=OFF, this is a hard pin and required. Overridden
            per-call by partner.retell_language_code when set.
        stt_mode:
          anyOf:
            - $ref: '#/components/schemas/SttMode'
            - type: 'null'
          title: ''
          description: STT mode (auto/off; flux and scribe are legacy values)
        custom_prompt:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: >-
            Admin-only override for the base outbound prompt. Jinja-rendered
            against the call context. Include `{{ base_prompt }}` anywhere in
            the text to inject the rendered OUTBOUND_AGENT_TEMPLATE at that
            position; omit the token to fully replace the base prompt.
      type: object
      title: UpdateCallAgentRequest
      description: Update call agent voice and personality settings.
    CallAgentResponse:
      properties:
        id:
          type: string
          title: ''
        end_call_on_recording_refusal:
          type: boolean
          title: ''
        recording_disclaimer_required:
          type: boolean
          title: ''
        outbound_begin_message:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
        voice_id:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
        voice:
          anyOf:
            - $ref: '#/components/schemas/VoiceSchema'
            - type: 'null'
          title: ''
        voice_speed:
          $ref: '#/components/schemas/Speed'
          title: ''
        voice_temperature:
          type: number
          title: ''
        stt_mode:
          $ref: '#/components/schemas/SttMode'
          title: ''
        language_code:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
        custom_prompt:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
      type: object
      required:
        - id
        - end_call_on_recording_refusal
        - recording_disclaimer_required
        - outbound_begin_message
        - voice_id
        - voice
        - voice_speed
        - voice_temperature
        - stt_mode
        - language_code
        - custom_prompt
      title: CallAgentResponse
      description: Call agent with current voice details.
    HTTPValidationError:
      $defs:
        ValidationError:
          properties:
            loc:
              items:
                anyOf:
                  - type: string
                  - type: integer
              title: Location
              type: array
            msg:
              title: Message
              type: string
            type:
              title: Type
              type: string
          required:
            - loc
            - msg
            - type
          title: ValidationError
          type: object
          x-speakeasy-include: true
      properties:
        type:
          const: request-validation
          title: Type
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Human-readable description of this specific problem.
          title: Detail
          x-speakeasy-error-message: true
        status:
          const: 422
          title: Status
          type: integer
        title:
          description: Short human-readable summary of the problem.
          title: Title
          type: string
          x-speakeasy-error-message: true
        errors:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Errors
          type: array
      required:
        - type
        - status
        - title
        - errors
      title: APIError
      type: object
    Speed:
      type: string
      enum:
        - slowest
        - slow
        - normal
        - fast
        - fastest
      title: Speed
    SttMode:
      type: string
      enum:
        - auto
        - flux
        - 'off'
        - scribe
      title: SttMode
      description: >-
        STT model selection mode for voice agents.


        AUTO: Multilingual Scribe (never pinned) + LanguageObserver hot-swaps
        STT to the
              detected language; a configured `language_code` is only a detection hint.
        FLUX: Legacy — equivalent to OFF + English (Deepgram Flux, built-in turn
        detection).
              Hidden from the dropdown; kept for existing rows. No observer; ignores `language_code`.
        OFF:  Hard pin to `language_code` (required) — Flux when English, else
        pinned Scribe. No observer.

        SCRIBE: Legacy multilingual Scribe, no observer. Hidden from the UI;
        kept for existing rows.
    VoiceSchema:
      properties:
        id:
          type: string
          title: ''
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
        accent:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
        age:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
        gender:
          type: string
          title: ''
        provider:
          type: string
          title: ''
        preview_audio_url:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
      type: object
      required:
        - id
        - name
        - accent
        - age
        - gender
        - provider
        - preview_audio_url
      title: Voice
      description: ElevenLabs voice from the synced voice catalog.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          type: string
          title: Type
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
      x-speakeasy-include: true
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````