agents

Update Agent

post/v1/agents/update

Query parameters

idstring uuid required

Request body

Response

Successful Response

idstring uuid required
user_idstring uuid required
namestring nullable
language'en' | 'es' | 'de' | 'hi' | 'pt' | 'fr' | 'nl' | 'id' | 'it' | 'ja' | 'ko'
initial_messagestring nullable
interrupt_sensitivity'low' | 'high'
context_endpointstring nullable
noise_suppressionboolean
endpointing_sensitivity'auto' | 'relaxed' | 'sensitive'
ivr_navigation_mode'default' | 'off'
conversation_speednumber
initial_message_delaynumber
openai_model_name_overridestring nullable
ask_if_human_present_on_idleboolean
run_do_not_call_detectionboolean
deepgram_keywordsobject nullable
idle_time_secondsinteger nullable
llm_temperaturenumber

Changes

Changed in 21 of the 31 revisions of this API.8014169

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 63991d99e2e170285See the full diff
    • ▲

      removed subschema #1 from the ///// request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 from the ///// request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 from the // request property anyOf list

      request-property-any-of-removed

    • ▲

      the request property const value muted was added

      request-property-const-added

    • ▲

      the request property const value account_connection_openai was added

      request-property-const-added

    • ▲

      the request property const value action_add_to_conference was added

      request-property-const-added

    • ▲

      the request property const value action_dtmf was added

      request-property-const-added

    • ▲

      the request property const value action_end_conversation was added

      request-property-const-added

    • ▲

      the request property const value action_external was added

      request-property-const-added

    • ▲

      the request property const value action_set_hold was added

      request-property-const-added

    • ▲

      the request property const value action_transfer_call was added

      request-property-const-added

    • ▲

      the request property const value action_trigger_function_call was added

      request-property-const-added

    • ▲

      the request property const value action_trigger_function_call was added

      request-property-const-added

    • ▲

      the request property const value action_trigger_function_call was added

      request-property-const-added

    • ▲

      the request property const value action_trigger_function_call was added

      request-property-const-added

    • ▲

      the request property const value vector_database_pinecone was added

      request-property-const-added

    • ▲

      the request property const value voice_azure was added

      request-property-const-added

    • ▲

      the request property const value voice_eleven_labs was added

      request-property-const-added

    • ▲

      the request property const value voice_play_ht was added

      request-property-const-added

    • ▲

      the request property const value voice_rime was added

      request-property-const-added

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      response property context_endpoint list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property initial_message list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property name list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property openai_model_name_override list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property prompt/collect_fields list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property prompt/context_endpoint list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #2: RimeVoice]/speed_alpha list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #3: ElevenLabsVoice]/api_key list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #3: ElevenLabsVoice]/model_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #3: ElevenLabsVoice]/optimize_streaming_latency list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #3: ElevenLabsVoice]/similarity_boost list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #3: ElevenLabsVoice]/stability list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #4: PlayHtVoice]/api_key list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #4: PlayHtVoice]/api_user_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #4: PlayHtVoice]/quality list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #4: PlayHtVoice]/speed list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #4: PlayHtVoice]/temperature list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #4: PlayHtVoice]/text_guidance list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #4: PlayHtVoice]/top_p list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property voice/oneOf[subschema #4: PlayHtVoice]/voice_guidance list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      added to the /// response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      added to the /// response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      added to the /// response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      added to the /// response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      added to the response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      added the new optional request property ///////

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added to the ///// request property anyOf list

      request-property-any-of-added

    • ○

      added to the ///// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #1 subschema #3 to the // request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the // request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #3 to the /// request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #4 to the request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #4 to the // request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #4 to the request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #4 to the request property anyOf list

      request-property-any-of-added

    • ○

      added discriminator to /// request property

      request-property-discriminator-added

    • ○

      added discriminator to ////// request property

      request-property-discriminator-added

    • ○

      added discriminator to ////// request property

      request-property-discriminator-added

    • ○

      added discriminator to ////// request property

      request-property-discriminator-added

    • ○

      added discriminator to ////// request property

      request-property-discriminator-added

    • ○

      added discriminator to / request property

      request-property-discriminator-added

    • ○

      added to the ////// request property oneOf list

      request-property-one-of-added

    • ○

      added to the ////// request property oneOf list

      request-property-one-of-added

    • ○

      added to the ////// request property oneOf list

      request-property-one-of-added

    • ○

      added to the ////// request property oneOf list

      request-property-one-of-added

    • ○

      added to the / request property oneOf list

      request-property-one-of-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added to the /// response property allOf list for the response status

      response-property-all-of-added

    • ○

      added to the /// response property allOf list for the response status

      response-property-all-of-added

    • ○

      added subschema #2 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the / response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #3 to the // response property anyOf list for the response status

      response-property-any-of-added

    • ○

      the response property const value muted was added for the status

      response-property-const-added

    • ○

      the response property const value action_add_to_conference was added for the status

      response-property-const-added

    • ○

      the response property const value action_dtmf was added for the status

      response-property-const-added

    • ○

      the response property const value action_end_conversation was added for the status

      response-property-const-added

    • ○

      the response property const value action_external was added for the status

      response-property-const-added

    • ○

      the response property const value action_set_hold was added for the status

      response-property-const-added

    • ○

      the response property const value action_transfer_call was added for the status

      response-property-const-added

    • ○

      the response property const value action_trigger_function_call was added for the status

      response-property-const-added

    • ○

      the response property const value action_trigger_function_call was added for the status

      response-property-const-added

    • ○

      the response property const value action_trigger_function_call was added for the status

      response-property-const-added

    • ○

      the response property const value action_trigger_function_call was added for the status

      response-property-const-added

    • ○

      the response property const value voice_azure was added for the status

      response-property-const-added

    • ○

      the response property const value voice_eleven_labs was added for the status

      response-property-const-added

    • ○

      the response property const value voice_play_ht was added for the status

      response-property-const-added

    • ○

      the response property const value voice_rime was added for the status

      response-property-const-added

    • ○

      added voice_vocode discriminator mapping keys to the response property for the response status

      response-property-discriminator-mapping-added

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from to for /// response property for the response status

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from to for /// response property for the response status

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from to for /// response property for the response status

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from to for /// response property for the response status

      response-property-discriminator-mapping-changed

    • ○

      removed discriminator from /// response property for the response status

      response-property-discriminator-removed

    • ○

      removed discriminator from /// response property for the response status

      response-property-discriminator-removed

    • ○

      removed the draft enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the faster enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the high enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the low enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the medium enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the premium enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed from the /// response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed from the /// response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed from the /// response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed from the /// response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed from the /// response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed from the /// response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 47ab17602d6416See the full diff
    • ▲

      added to the / response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added to the /// request property oneOf list

      request-property-one-of-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added action_external discriminator mapping keys to the / response property for the response status

      response-property-discriminator-mapping-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 500a519452b0111See the full diff
    • ●

      added the new event_phone_call_did_not_connect enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new event_phone_call_did_not_connect enum value to the request property ////

      request-property-enum-value-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ▲

      added to the / response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added to the /// request property oneOf list

      request-property-one-of-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added action_add_to_conference action_set_hold discriminator mapping keys to the / response property for the response status

      response-property-discriminator-mapping-added

  • 1111aff32f0a810See the full diff
    • ●

      added the new fr enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new hi enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new id enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new it enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ja enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ko enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new nl enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new pt enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new fr enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new hi enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new id enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new it enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new ja enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new ko enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new nl enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new pt enum value to the request property /

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ●

      added the new sensitive enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new sensitive enum value to the request property /

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      the response's property default value changed from high to low for the status

      response-property-default-value-changed