AgentPhone agents API

openapi: 3.1.0
info:
  title: API Reference agent-webhooks agents API
  version: 1.0.0
servers:
- url: https://api.agentphone.ai
  description: Production
tags:
- name: agents
paths:
  /v1/agents/voices:
    get:
      operationId: list-voices-v-1-agents-voices-get
      summary: List Voices
      description: Return available voices from the configured voice provider.
      tags:
      - agents
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                description: Any type
  /v1/agents:
    get:
      operationId: list-agents-v-1-agents-get
      summary: List Agents
      description: List all agents for this account.
      tags:
      - agents
      parameters:
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Sub-Account-Id
        in: header
        description: Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.
        required: false
        schema:
          type: string
          default: 20
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      operationId: create-agent-v-1-agents-post
      summary: Create Agent
      description: "Create a new agent.\n\nAn agent represents an AI persona (Support Bot, Sales Agent, etc.)\nthat can have phone numbers attached to it.\n\nvoiceMode: \"webhook\" (default) forwards transcripts to your webhook.\n           \"hosted\" uses a built-in LLM with systemPrompt (no webhook needed)."
      tags:
      - agents
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Sub-Account-Id
        in: header
        description: Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentRequest'
  /v1/agents/{agent_id}:
    get:
      operationId: get-agent-v-1-agents-agent-id-get
      summary: Get Agent
      description: Get a single agent with its attached numbers.
      tags:
      - agents
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Sub-Account-Id
        in: header
        description: Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      operationId: delete-agent-v-1-agents-agent-id-delete
      summary: Delete Agent
      description: 'Delete an agent.


        Phone numbers, conversations, and calls associated with the agent will have their

        agent reference cleared (set to null) but will not be deleted themselves.'
      tags:
      - agents
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Sub-Account-Id
        in: header
        description: Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAgentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      operationId: update-agent-v-1-agents-agent-id-patch
      summary: Update Agent
      description: 'Update an agent''s configuration.


        Use this to change voice mode, system prompt, greeting, or voice.

        Switching voiceMode to "hosted" re-provisions the voice agent with built-in LLM.'
      tags:
      - agents
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Sub-Account-Id
        in: header
        description: Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAgentRequest'
  /v1/agents/{agent_id}/numbers:
    post:
      operationId: attach-number-to-agent-v-1-agents-agent-id-numbers-post
      summary: Attach Number To Agent
      description: 'Attach an existing phone number to an agent.


        The number must belong to the same account and not be released.'
      tags:
      - agents
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachNumberResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachNumberRequest'
  /v1/agents/{agent_id}/numbers/{number_id}:
    delete:
      operationId: detach-number-from-agent-v-1-agents-agent-id-numbers-number-id-delete
      summary: Detach Number From Agent
      description: 'Detach a phone number from an agent (sets agentId to null).


        The number remains active and can be re-attached to any agent.'
      tags:
      - agents
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
      - name: number_id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                description: Any type
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/agents/{agent_id}/conversations:
    get:
      operationId: list-agent-conversations-v-1-agents-agent-id-conversations-get
      summary: List Agent Conversations
      description: List all conversations for an agent.
      tags:
      - agents
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app__routes__agents__ConversationListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/agents/{agent_id}/calls:
    get:
      operationId: list-agent-calls-v-1-agents-agent-id-calls-get
      summary: List Agent Calls
      description: List all calls for an agent.
      tags:
      - agents
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CallSummary:
      type: object
      properties:
        id:
          type: string
        agentId:
          type:
          - string
          - 'null'
        phoneNumberId:
          type:
          - string
          - 'null'
        phoneNumber:
          type:
          - string
          - 'null'
        fromNumber:
          type: string
        toNumber:
          type: string
        status:
          type: string
        startedAt:
          type: string
          format: date-time
        endedAt:
          type:
          - string
          - 'null'
          format: date-time
        durationSeconds:
          type:
          - integer
          - 'null'
        lastTranscriptSnippet:
          type:
          - string
          - 'null'
      required:
      - id
      - agentId
      - phoneNumberId
      - phoneNumber
      - fromNumber
      - toNumber
      - status
      - startedAt
      - endedAt
      - durationSeconds
      - lastTranscriptSnippet
      title: CallSummary
    DeleteAgentResponse:
      type: object
      properties:
        success:
          type: boolean
        id:
          type: string
        name:
          type: string
      required:
      - success
      - id
      - name
      title: DeleteAgentResponse
    ValidationError:
      type: object
      properties:
        loc:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorLocItems'
        msg:
          type: string
        type:
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
    UpdateAgentRequestAmbientSound:
      type: string
      enum:
      - none
      - office
      - coffee-shop
      - outdoor
      description: Background ambience to mask synthetic silence between turns. 'none' disables; 'office', 'coffee-shop', 'outdoor' enable a quiet bed.
      title: UpdateAgentRequestAmbientSound
    CallListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CallSummary'
        hasMore:
          type: boolean
        total:
          type: integer
      required:
      - data
      - hasMore
      - total
      title: CallListResponse
    AgentResponseAmbientSound:
      type: string
      enum:
      - none
      - office
      - coffee-shop
      - outdoor
      default: none
      description: Background ambience to mask synthetic silence between turns. 'none' disables; 'office', 'coffee-shop', 'outdoor' enable a quiet bed.
      title: AgentResponseAmbientSound
    UpdateAgentRequestVoiceMode:
      type: string
      enum:
      - webhook
      - hosted
      title: UpdateAgentRequestVoiceMode
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      title: HTTPValidationError
    AgentResponseVoiceMode:
      type: string
      enum:
      - webhook
      - hosted
      title: AgentResponseVoiceMode
    CreateAgentRequestLanguage:
      type: string
      enum:
      - af-ZA
      - ar-SA
      - az-AZ
      - bg-BG
      - bs-BA
      - ca-ES
      - cs-CZ
      - cy-GB
      - da-DK
      - de-DE
      - el-GR
      - en-AU
      - en-GB
      - en-IN
      - en-NZ
      - en-US
      - es-419
      - es-ES
      - fa-IR
      - fi-FI
      - fil-PH
      - fr-CA
      - fr-FR
      - gl-ES
      - he-IL
      - hi-IN
      - hr-HR
      - hu-HU
      - hy-AM
      - id-ID
      - is-IS
      - it-IT
      - ja-JP
      - kk-KZ
      - kn-IN
      - ko-KR
      - lt-LT
      - lv-LV
      - mk-MK
      - mr-IN
      - ms-MY
      - ne-NP
      - nl-BE
      - nl-NL
      - no-NO
      - pl-PL
      - pt-BR
      - pt-PT
      - ro-RO
      - ru-RU
      - sk-SK
      - sl-SI
      - sr-RS
      - sv-SE
      - sw-KE
      - ta-IN
      - th-TH
      - tr-TR
      - uk-UA
      - ur-IN
      - vi-VN
      - yue-CN
      - zh-CN
      description: BCP-47 locale that drives the agent's speech recognition and pronunciation. Defaults to 'en-US'. See the enum for the full set of supported codes.
      title: CreateAgentRequestLanguage
    ValidationErrorLocItems:
      oneOf:
      - type: string
      - type: integer
      title: ValidationErrorLocItems
    AgentResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        voiceMode:
          $ref: '#/components/schemas/AgentResponseVoiceMode'
        enableMessaging:
          type: boolean
          default: true
        modelTier:
          $ref: '#/components/schemas/AgentResponseModelTier'
          default: balanced
        systemPrompt:
          type:
          - string
          - 'null'
        beginMessage:
          type:
          - string
          - 'null'
        voice:
          type: string
        transferNumber:
          type:
          - string
          - 'null'
        customTools:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AgentResponseCustomToolsItems'
        voicemailMessage:
          type:
          - string
          - 'null'
        callScreeningIdentity:
          type:
          - string
          - 'null'
        callScreeningPurpose:
          type:
          - string
          - 'null'
        sttMode:
          $ref: '#/components/schemas/AgentResponseSttMode'
          default: fast
          description: Speech-to-text mode. 'fast' optimizes for latency, 'accurate' optimizes for transcription accuracy (~200ms additional latency).
        ambientSound:
          $ref: '#/components/schemas/AgentResponseAmbientSound'
          default: none
          description: Background ambience to mask synthetic silence between turns. 'none' disables; 'office', 'coffee-shop', 'outdoor' enable a quiet bed.
        denoisingMode:
          $ref: '#/components/schemas/AgentResponseDenoisingMode'
          default: noise-cancellation
          description: Audio denoising. 'noise-cancellation' (default) handles general noise. 'noise-and-background-speech-cancellation' is more aggressive for callers in cars, cafes, or near TVs ($0.005/min surcharge).
        maxSilenceMs:
          type: integer
          default: 600000
          description: Hang up the call after this many milliseconds of caller silence. Range 10000 (10s) to 3600000 (1 hour). Default 600000 (10 min).
        voiceSpeed:
          type: number
          format: double
          default: 1
          description: Voice speed multiplier. Range 0.5 to 2.0. Default 1.0.
        interruptionSensitivity:
          type: number
          format: double
          default: 0.8
          description: How easily callers can interrupt the agent. Range 0.0 to 1.0. Default 0.8.
        enableBackchannel:
          type: boolean
          default: true
          description: When true, the agent interjects short filler words like 'uh-huh' or 'mhmm' during longer caller utterances. Defaults to true.
        language:
          type: string
          default: en-US
          description: BCP-47 locale that drives the agent's speech recognition and pronunciation. Defaults to 'en-US'.
        createdAt:
          type: string
          format: date-time
        numbers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AgentNumberResponse'
      required:
      - id
      - name
      - description
      - voiceMode
      - voice
      - createdAt
      title: AgentResponse
    CreateAgentRequestVoiceMode:
      type: string
      enum:
      - webhook
      - hosted
      title: CreateAgentRequestVoiceMode
    CreateAgentRequestSttMode:
      type: string
      enum:
      - fast
      - accurate
      description: Speech-to-text mode. 'fast' optimizes for latency, 'accurate' optimizes for transcription accuracy (~200ms additional latency).
      title: CreateAgentRequestSttMode
    CreateAgentRequestAmbientSound:
      type: string
      enum:
      - none
      - office
      - coffee-shop
      - outdoor
      description: Background ambience to mask synthetic silence between turns. 'none' disables; 'office', 'coffee-shop', 'outdoor' enable a quiet bed.
      title: CreateAgentRequestAmbientSound
    UpdateAgentRequestModelTier:
      type: string
      enum:
      - turbo
      - balanced
      - max
      title: UpdateAgentRequestModelTier
    CustomToolParamParameters:
      type: object
      properties: {}
      description: JSON Schema object describing the arguments the agent fills in. Omit for a no-argument tool.
      title: CustomToolParamParameters
    CustomToolParamMethod:
      type: string
      enum:
      - GET
      - POST
      description: HTTP method. Defaults to POST.
      title: CustomToolParamMethod
    CreateAgentRequestModelTier:
      type: string
      enum:
      - turbo
      - balanced
      - max
      title: CreateAgentRequestModelTier
    AgentListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AgentResponse'
        total:
          type: integer
      required:
      - data
      - total
      title: AgentListResponse
    CustomToolParam:
      type: object
      properties:
        name:
          type: string
          description: Function name the agent calls. Letters, numbers, underscores, hyphens; max 64 chars. Must be unique and not a reserved built-in name.
        description:
          type: string
          description: What the tool does and when to use it. The agent relies on this to decide when to call it.
        url:
          type: string
          description: HTTPS endpoint the voice provider calls when the agent invokes this tool.
        method:
          $ref: '#/components/schemas/CustomToolParamMethod'
          description: HTTP method. Defaults to POST.
        headers:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
          description: Optional HTTP headers sent with the request (e.g. an Authorization token for your endpoint).
        parameters:
          oneOf:
          - $ref: '#/components/schemas/CustomToolParamParameters'
          - type: 'null'
          description: JSON Schema object describing the arguments the agent fills in. Omit for a no-argument tool.
        timeoutMs:
          type:
          - integer
          - 'null'
          description: How long to wait for your endpoint before giving up. Range 1000-120000 ms.
        speakDuringExecution:
          type:
          - boolean
          - 'null'
          description: When true, the agent speaks executionMessage while the tool runs.
        executionMessage:
          type:
          - string
          - 'null'
          description: What the agent says while the tool runs (used when speakDuringExecution is true).
      required:
      - name
      - description
      - url
      title: CustomToolParam
    AgentResponseCustomToolsItems:
      type: object
      properties: {}
      title: AgentResponseCustomToolsItems
    AttachNumberResponse:
      type: object
      properties:
        agentId:
          type: string
        number:
          $ref: '#/components/schemas/AgentNumberResponse'
      required:
      - agentId
      - number
      title: AttachNumberResponse
    CreateAgentRequest:
      type: object
      properties:
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        voiceMode:
          $ref: '#/components/schemas/CreateAgentRequestVoiceMode'
        enableMessaging:
          type:
          - boolean
          - 'null'
          description: When true, hosted-mode agents can send and read SMS/iMessage during calls. Defaults to true.
        modelTier:
          $ref: '#/components/schemas/CreateAgentRequestModelTier'
        systemPrompt:
          type:
          - string
          - 'null'
        beginMessage:
          type:
          - string
          - 'null'
        voice:
          type:
          - string
          - 'null'
        transferNumber:
          type:
          - string
          - 'null'
        customTools:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomToolParam'
          description: Hosted-mode only. User-defined function tools the agent can call during a call (look up a record, save call notes, etc.). Each points at your HTTPS endpoint; the voice provider invokes it and feeds the JSON response back to the agent. Ignored in webhook mode. Maximum 20 tools.
        voicemailMessage:
          type:
          - string
          - 'null'
        callScreeningIdentity:
          type:
          - string
          - 'null'
        callScreeningPurpose:
          type:
          - string
          - 'null'
        sttMode:
          $ref: '#/components/schemas/CreateAgentRequestSttMode'
          description: Speech-to-text mode. 'fast' optimizes for latency, 'accurate' optimizes for transcription accuracy (~200ms additional latency).
        ambientSound:
          $ref: '#/components/schemas/CreateAgentRequestAmbientSound'
          description: Background ambience to mask synthetic silence between turns. 'none' disables; 'office', 'coffee-shop', 'outdoor' enable a quiet bed.
        denoisingMode:
          $ref: '#/components/schemas/CreateAgentRequestDenoisingMode'
          description: Audio denoising. 'noise-cancellation' (default) handles general noise. 'noise-and-background-speech-cancellation' is more aggressive for callers in cars, cafes, or near TVs ($0.005/min surcharge).
        maxSilenceMs:
          type:
          - integer
          - 'null'
          description: Hang up the call after this many milliseconds of caller silence. Default 600000 (10 min). Raise for IVR/hold-music workflows; lower to fail fast on dead lines. Range 10000 (10s) to 3600000 (1 hour).
        voiceSpeed:
          type:
          - number
          - 'null'
          format: double
          description: Voice speed multiplier. 1.0 is normal pace; lower values slow speech (0.5 is half speed), higher values speed it up (2.0 is double). Range 0.5 to 2.0.
        interruptionSensitivity:
          type:
          - number
          - 'null'
          format: double
          description: How easily callers can interrupt the agent. 0 means the agent is never interrupted, 1 means the agent stops at the first sound. Default 0.8. Range 0.0 to 1.0.
        enableBackchannel:
          type:
          - boolean
          - 'null'
          description: When true, the agent interjects short filler words like 'uh-huh' or 'mhmm' during longer caller utterances. Set false to keep the agent silent while the caller is speaking. Defaults to true.
        language:
          $ref: '#/components/schemas/CreateAgentRequestLanguage'
          description: BCP-47 locale that drives the agent's speech recognition and pronunciation. Defaults to 'en-US'. See the enum for the full set of supported codes.
      required:
      - name
      title: CreateAgentRequest
    AgentNumberResponse:
      type: object
      properties:
        id:
          type: string
        phoneNumber:
          type: string
        status:
          type: string
        type:
          type: string
          default: sms
      required:
      - id
      - phoneNumber
      - status
      title: AgentNumberResponse
    AgentResponseDenoisingMode:
      type: string
      enum:
      - noise-cancellation
      - noise-and-background-speech-cancellation
      default: noise-cancellation
      description: Audio denoising. 'noise-cancellation' (default) handles general noise. 'noise-and-background-speech-cancellation' is more aggressive for callers in cars, cafes, or near TVs ($0.005/min surcharge).
      title: AgentResponseDenoisingMode
    CreateAgentRequestDenoisingMode:
      type: string
      enum:
      - noise-cancellation
      - noise-and-background-speech-cancellation
      description: Audio denoising. 'noise-cancellation' (default) handles general noise. 'noise-and-background-speech-cancellation' is more aggressive for callers in cars, cafes, or near TVs ($0.005/min surcharge).
      title: CreateAgentRequestDenoisingMode
    UpdateAgentRequestSttMode:
      type: string
      enum:
      - fast
      - accurate
      description: Speech-to-text mode. 'fast' optimizes for latency, 'accurate' optimizes for transcription accuracy (~200ms additional latency).
      title: UpdateAgentRequestSttMode
    AgentResponseSttMode:
      type: string
      enum:
      - fast
      - accurate
      default: fast
      description: Speech-to-text mode. 'fast' optimizes for latency, 'accurate' optimizes for transcription accuracy (~200ms additional latency).
      title: AgentResponseSttMode
    app__routes__agents__ConversationListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/app__routes__agents__ConversationSummary'
        hasMore:
          type: boolean
        total:
          type: integer
      required:
      - data
      - hasMore
      - total
      title: app__routes__agents__ConversationListResponse
    AttachNumberRequest:
      type: object
      properties:
        numberId:
          type: string
      required:
      - numberId
      title: AttachNumberRequest
    UpdateAgentRequestDenoisingMode:
      type: string
      enum:
      - noise-cancellation
      - noise-and-background-speech-cancellation
      description: Audio denoising. 'noise-cancellation' (default) handles general noise. 'noise-and-background-speech-cancellation' is more aggressive for callers in cars, cafes, or near TVs ($0.005/min surcharge).
      title: UpdateAgentRequestDenoisingMode
    app__routes__agents__ConversationSummary:
      type: object
      properties:
        id:
          type: string
        agentId:
          type:
          - string
          - 'null'
        phoneNumberId:
          type: string
        phoneNumber:
          type: string
        participant:
          type: string
        lastMessageAt:
          type: string
          format: date-time
        lastMessagePreview:
          type: string
        messageCount:
          type: integer
        createdAt:
          type: string
          format: date-time
      required:
      - id
      - agentId
      - phoneNumberId
      - phoneNumber
      - participant
      - lastMessageAt
      - lastMessagePreview
      - messageCount
      - createdAt
      title: app__routes__agents__ConversationSummary
    UpdateAgentRequestLanguage:
      type: string
      enum:
      - af-ZA
      - ar-SA
      - az-AZ
      - bg-BG
      - bs-BA
      - ca-ES
      - cs-CZ
      - cy-GB
      - da-DK
      - de-DE
      - el-GR
      - en-AU
      - en-GB
      - en-IN
      - en-NZ
      - en-US
      - es-419
      - es-ES
      - fa-IR
      - fi-FI
      - fil-PH
      - fr-CA
      - fr-FR
      - gl-ES
      - he-IL
      - hi-IN
      - hr-HR
      - hu-HU
      - hy-AM
      - id-ID
      - is-IS
      - it-IT
      - ja-JP
      - kk-KZ
      - kn-IN
      - ko-KR
      - lt-LT
      - lv-LV
      - mk-MK
      - mr-IN
      - ms-MY
      - ne-NP
      - nl-BE
      - nl-NL
      - no-NO
      - pl-PL
      - pt-BR
      - pt-PT
      - ro-RO
      - ru-RU
      - sk-SK
      - sl-SI
      - sr-RS
      - sv-SE
      - sw-KE
      - ta-IN
      - th-TH
      - tr-TR
      - uk-UA
      - ur-IN
      - vi-VN
      - yue-CN
      - zh-CN
      description: BCP-47 locale that drives the agent's speech recognition and pronunciation. See the enum for the full set of supported codes.
      title: UpdateAgentRequestLanguage
    AgentResponseModelTier:
      type: string
      enum:
      - turbo
      - balanced
      - max
      default: balanced
      title: AgentResponseModelTier
    UpdateAgentRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        voiceMode:
          $ref: '#/components/schemas/UpdateAgentRequestVoiceMode'
        enableMessaging:
          type:
          - boolean
          - 'null'
          description: When true, hosted-mode agents can send and read SMS/iMessage during calls.
        modelTier:
          $ref: '#/components/schemas/UpdateAgentRequestModelTier'
        systemPrompt:
          type:
          - string
          - 'null'
        beginMessage:
          type:
          - string
          - 'null'
        voice:
          type:
          - string
          - 'null'
        transferNumber:
          type:
          - string
          - 'null'
        customTools:
          type:
          - array
          - 

# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/agentphone/refs/heads/main/openapi/agentphone-agents-api-openapi.yml