---
title: "Update Agent"
method: POST
path: "/v1/agents/update"
tags: ["agents"]
---

# Update Agent

`POST /v1/agents/update`

## Query parameters

- `id` string, uuid, required

## Request body

- AgentUpdateParams
  - `prompt` union
    - string, uuid
    - PromptUpdateParams
      - `content` union
        - string
        - Undefined
      - `collect_fields` union
        - CollectField[]
          - `field_type` 'field_type_email', required
          - `label` string, required
          - `name` string, required
          - `description` string
        - Undefined
      - `context_endpoint` union
        - string
        - Undefined
      - `prompt_template` union
        - string, uuid
        - PromptTemplate
          - `id` string, uuid, required
          - `user_id` string, uuid, required
          - `label` string
          - `required_context_keys` string[], required
        - Undefined
    - Undefined
  - `language` union
    - 'en' | 'es' | 'de' — An enumeration.
    - Undefined
  - `actions` union
    - union[]
      - union
        - string, uuid
        - union
          - TransferCallActionUpdateParams
            - `type` 'action_transfer_call', required
            - `config` union
              - …
          - EndConversationActionUpdateParams
            - `type` 'action_end_conversation', required
            - `config` union
              - …
          - DTMFActionUpdateParams
            - `type` 'action_dtmf', required
            - `config` union
              - …
    - Undefined
  - `voice` union
    - string, uuid
    - union
      - AzureVoiceUpdateParams
        - `type` 'voice_azure', required
        - `voice_name` union
          - string
          - Undefined
        - `pitch` union
          - integer
          - Undefined
        - `rate` union
          - integer
          - Undefined
      - RimeVoiceUpdateParams
        - `type` 'voice_rime', required
        - `speaker` union
          - string
          - Undefined
        - `speed_alpha` union
          - number
          - Undefined
      - ElevenLabsVoiceUpdateParams
        - `type` 'voice_eleven_labs', required
        - `voice_id` union
          - string
          - Undefined
        - `stability` union
          - number
          - Undefined
        - `similarity_boost` union
          - number
          - Undefined
        - `api_key` union
          - string
          - Undefined
        - `optimize_streaming_latency` union
          - integer
          - Undefined
        - `model_id` union
          - string
          - Undefined
      - PlayHtVoiceUpdateParams
        - `type` 'voice_play_ht', required
        - `voice_id` union
          - string
          - Undefined
        - `api_user_id` union
          - string
          - Undefined
        - `api_key` union
          - string
          - Undefined
        - `version` union
          - '1' | '2'
          - Undefined
        - `speed` union
          - number
          - Undefined
    - Undefined
  - `initial_message` union
    - string
    - Undefined
  - `webhook` union
    - string, uuid
    - WebhookUpdateParams
      - `subscriptions` union
        - EventType[]
        - Undefined
      - `url` union
        - string
        - Undefined
      - `method` union
        - 'GET' | 'POST' — An enumeration.
        - Undefined
    - Undefined
  - `vector_database` union
    - string, uuid
    - PineconeVectorDatabaseUpdateParams
      - `type` 'vector_database_pinecone', required
      - `index` union
        - string
        - Undefined
      - `api_key` union
        - string
        - Undefined
      - `api_environment` union
        - string
        - Undefined
    - Undefined
  - `interrupt_sensitivity` union
    - 'low' | 'high' — An enumeration.
    - Undefined
  - `context_endpoint` union
    - string
    - Undefined
  - `noise_suppression` union
    - boolean
    - Undefined
  - `endpointing_sensitivity` union
    - 'auto' | 'relaxed'
    - Undefined
  - `ivr_navigation_mode` union
    - 'default' | 'off'
    - Undefined
  - `conversation_speed` union
    - number
    - Undefined
  - `initial_message_delay` union
    - number
    - Undefined

## Response `200`

Successful Response

- Agent
  - `id` string, uuid, required
  - `user_id` string, uuid, required
  - `prompt` Prompt, required
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `content` string
    - `collect_fields` CollectField[]
      - `field_type` 'field_type_email', required
      - `label` string, required
      - `name` string, required
      - `description` string
    - `context_endpoint` string
    - `prompt_template` PromptTemplate
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `label` string
      - `required_context_keys` string[], required
  - `language` 'en' | 'es' | 'de' — An enumeration.
  - `actions` union[], required
    - union
      - TransferCallAction
        - `id` string, uuid, required
        - `user_id` string, uuid, required
        - `type` 'action_transfer_call', required
        - `config` TransferCallConfig, required
          - `phone_number` string, required
      - EndConversationAction
        - `id` string, uuid, required
        - `user_id` string, uuid, required
        - `type` 'action_end_conversation', required
        - `config` EmptyActionConfig
      - DTMFAction
        - `id` string, uuid, required
        - `user_id` string, uuid, required
        - `type` 'action_dtmf', required
        - `config` EmptyActionConfig
  - `voice` union, required
    - AzureVoice
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `type` 'voice_azure', required
      - `voice_name` string, required
      - `pitch` integer
      - `rate` integer
    - RimeVoice
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `type` 'voice_rime', required
      - `speaker` string, required
      - `speed_alpha` number
    - ElevenLabsVoice
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `type` 'voice_eleven_labs', required
      - `voice_id` string, required
      - `stability` number
      - `similarity_boost` number
      - `api_key` string
      - `optimize_streaming_latency` integer
      - `model_id` string
    - PlayHtVoice
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `type` 'voice_play_ht', required
      - `voice_id` string, required
      - `api_user_id` string
      - `api_key` string
      - `version` '1' | '2'
      - `speed` number
  - `initial_message` string
  - `webhook` Webhook
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `subscriptions` EventType[], required
    - `url` string, required
    - `method` 'GET' | 'POST' — An enumeration.
  - `vector_database` PineconeVectorDatabase
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `type` 'vector_database_pinecone', required
    - `index` string, required
    - `api_key` string, required
    - `api_environment` string, required
  - `interrupt_sensitivity` 'low' | 'high' — An enumeration.
  - `context_endpoint` string
  - `noise_suppression` boolean
  - `endpointing_sensitivity` 'auto' | 'relaxed'
  - `ivr_navigation_mode` 'default' | 'off'
  - `conversation_speed` number
  - `initial_message_delay` number

## Other responses

- `422` — Validation Error

## Changes

- **2023-11-25** `97850bfccb2c` — 6 info
  - added the new optional request property `initial_message_delay`
  - added the new optional request property `voice/anyOf[subschema #2]/oneOf[subschema #3: ElevenLabsVoiceUpdateParams]/model_id`
  - added the new optional request property `voice/anyOf[subschema #2]/oneOf[subschema #3: ElevenLabsVoiceUpdateParams]/optimize_streaming_latency`
  - added the optional property `initial_message_delay` to the response with the `200` status
  - …2 more
- **2023-10-25** `712314def757` — 2 info
  - added the new optional request property `voice/anyOf[subschema #2]/oneOf[subschema #4: PlayHtVoiceUpdateParams]/speed`
  - added the optional property `voice/oneOf[subschema #4: PlayHtVoice]/speed` to the response with the `200` status
- **2023-10-13** `9feade6bcba8` — 2 breaking, 2 info
  - the response property `voice/oneOf[subschema #4: PlayHtVoice]/api_key` became optional for the status `200`
  - the response property `voice/oneOf[subschema #4: PlayHtVoice]/api_user_id` became optional for the status `200`
  - added the new optional request property `voice/anyOf[subschema #2]/oneOf[subschema #4: PlayHtVoiceUpdateParams]/version`
  - added the optional property `voice/oneOf[subschema #4: PlayHtVoice]/version` to the response with the `200` status
- …earlier changes not shown

[Full history](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/changes/v1/agents/update/post.md)

---

[API](https://skmtc.dev/vocodedev/apis/vocode-hosted-api.md) · [All operations](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/revisions/97850bfccb2c?raw)