Sign in
agents

Get Agent

get/v1/agents

Query parameters

idstring uuid required

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

  • ffca17c004e21See the full diff
    • ○

      added the optional property idle_time_seconds to the response with the 200 status

      response-optional-property-added

  • 63991d99e2e146244See the full diff
    • ▲

      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 PhraseBasedActionTrigger-Output to the actions/items/oneOf[subschema #1: TransferCallAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added PhraseBasedActionTrigger-Output to the actions/items/oneOf[subschema #2: EndConversationAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added PhraseBasedActionTrigger-Output to the actions/items/oneOf[subschema #4: AddToConferenceAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added PhraseBasedActionTrigger-Output to the actions/items/oneOf[subschema #5: SetHoldAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added VocodeVoice to the voice response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the openai_account_connection response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the prompt/prompt_template response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the vector_database response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the webhook response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property openai_account_connection/credentials from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property openai_account_connection/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property openai_account_connection/type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property openai_account_connection/user_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property prompt/prompt_template/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property prompt/prompt_template/required_context_keys from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property prompt/prompt_template/user_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property vector_database/api_environment from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property vector_database/api_key from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property vector_database/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property vector_database/index from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property vector_database/type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property vector_database/user_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property webhook/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property webhook/subscriptions from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property webhook/url from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property webhook/user_id from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property prompt/prompt_template/label from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property webhook/method from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property actions/items/oneOf[subschema #6: ExternalAction]/config/signature_secret to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property deepgram_keywords to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property llm_fallback to the response with the 200 status

      response-optional-property-added

    • ○

      added FunctionCallActionTrigger to the actions/items/oneOf[subschema #3: DTMFAction]/action_trigger response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added FunctionCallActionTrigger to the actions/items/oneOf[subschema #6: ExternalAction]/action_trigger response property allOf list for the response status 200

      response-property-all-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

      added PromptTemplate subschema #2 to the prompt/prompt_template response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

      added subschema #3 to the voice/oneOf[subschema #2: RimeVoice]/model_id response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      the processing_mode response property const value muted was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_add_to_conference was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_dtmf was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_end_conversation was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_external was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_set_hold was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_transfer_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_trigger_function_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_trigger_function_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_trigger_function_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_trigger_function_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value voice_azure was added for the status 200

      response-property-const-added

    • ○

      the type response property const value voice_eleven_labs was added for the status 200

      response-property-const-added

    • ○

      the type response property const value voice_play_ht was added for the status 200

      response-property-const-added

    • ○

      the type response property const value voice_rime was added for the status 200

      response-property-const-added

    • ○

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

      response-property-discriminator-mapping-added

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from PhraseBasedActionTrigger to PhraseBasedActionTrigger-Output for actions/items/oneOf[subschema #1: TransferCallAction]/action_trigger response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from PhraseBasedActionTrigger to PhraseBasedActionTrigger-Output for actions/items/oneOf[subschema #2: EndConversationAction]/action_trigger response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from PhraseBasedActionTrigger to PhraseBasedActionTrigger-Output for actions/items/oneOf[subschema #4: AddToConferenceAction]/action_trigger response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from PhraseBasedActionTrigger to PhraseBasedActionTrigger-Output for actions/items/oneOf[subschema #5: SetHoldAction]/action_trigger response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      removed discriminator from actions/items/oneOf[subschema #3: DTMFAction]/action_trigger response property for the response status 200

      response-property-discriminator-removed

    • ○

      removed discriminator from actions/items/oneOf[subschema #6: ExternalAction]/action_trigger response property for the response status 200

      response-property-discriminator-removed

    • ○

      removed the draft enum value from the voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the faster enum value from the voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the high enum value from the voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the low enum value from the voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the medium enum value from the voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the premium enum value from the voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed FunctionCallActionTrigger PhraseBasedActionTrigger from the actions/items/oneOf[subschema #3: DTMFAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed FunctionCallActionTrigger PhraseBasedActionTrigger from the actions/items/oneOf[subschema #6: ExternalAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed PhraseBasedActionTrigger from the actions/items/oneOf[subschema #1: TransferCallAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed PhraseBasedActionTrigger from the actions/items/oneOf[subschema #2: EndConversationAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed PhraseBasedActionTrigger from the actions/items/oneOf[subschema #4: AddToConferenceAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed PhraseBasedActionTrigger from the actions/items/oneOf[subschema #5: SetHoldAction]/action_trigger response property oneOf list for the response status 200

      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

  • 47ab17602d6413See the full diff
    • ▲

      added ExternalAction to the actions/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property voice/oneOf[subschema #2: RimeVoice]/model_id to the response with the 200 status

      response-optional-property-added

    • ○

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

      response-property-discriminator-mapping-added

  • 3dbe7b5c464d1See the full diff
    • ○

      added the optional property llm_temperature to the response with the 200 status

      response-optional-property-added

  • 500a519452b015See the full diff
    • ●

      added the new event_phone_call_did_not_connect enum value to the webhook/subscriptions/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property voice/oneOf[subschema #3: ElevenLabsVoice]/experimental_input_streaming to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property voice/oneOf[subschema #4: PlayHtVoice]/experimental_remove_silence to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property voice/oneOf[subschema #4: PlayHtVoice]/text_guidance to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property voice/oneOf[subschema #4: PlayHtVoice]/top_p to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property voice/oneOf[subschema #4: PlayHtVoice]/voice_guidance to the response with the 200 status

      response-optional-property-added

  • 5086814bf16a14See the full diff
    • ▲

      added AddToConferenceAction SetHoldAction to the actions/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property actions/items/oneOf[subschema #1: TransferCallAction]/action_trigger to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property actions/items/oneOf[subschema #2: EndConversationAction]/action_trigger to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property actions/items/oneOf[subschema #3: DTMFAction]/action_trigger to the response with the 200 status

      response-optional-property-added

    • ○

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

      response-property-discriminator-mapping-added

  • 1111aff32f0a81See the full diff
    • ●

      added the new fr enum value to the language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new hi enum value to the language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new id enum value to the language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new it enum value to the language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ja enum value to the language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ko enum value to the language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new nl enum value to the language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pt enum value to the language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property ask_if_human_present_on_idle to the response with the 200 status

      response-optional-property-added

  • 5d83963279c92See the full diff
    • ○

      added the optional property voice/oneOf[subschema #4: PlayHtVoice]/quality to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property voice/oneOf[subschema #4: PlayHtVoice]/temperature to the response with the 200 status

      response-optional-property-added

  • 17fa3c507aa211See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      added the optional property run_do_not_call_detection to the response with the 200 status

      response-optional-property-added

  • e5b6e245d5221See the full diff
    • ○

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

      response-property-default-value-changed