agents

Get Agent

Changed on Aug 27, 2024

get/v1/agents

Request

Base URL
https://api.vocode.dev
URL
https://api.vocode.dev/v1/agents
Auth
HTTP bearer

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

Aug 27, 2024ffca17c004e2 Revision changes
- info
  added the optional property to the response with the status
Aug 16, 202463991d99e2e1 Revision changes
- breaking
  response property context_endpoint list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property initial_message list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property name list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property openai_model_name_override list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property prompt/collect_fields list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property prompt/context_endpoint list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  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
- breaking
  added to the /// response property oneOf list for the response status
- breaking
  added to the /// response property oneOf list for the response status
- breaking
  added to the /// response property oneOf list for the response status
- breaking
  added to the /// response property oneOf list for the response status
- breaking
  added to the response property oneOf list for the response status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the / response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added to the /// response property allOf list for the response status
- info
  added to the /// response property allOf list for the response status
- info
  added subschema #2 to the response property anyOf list for the response status
- info
  added subschema #2 to the response property anyOf list for the response status
- info
  added subschema #2 to the / response property anyOf list for the response status
- info
  added subschema #2 to the response property anyOf list for the response status
- info
  added subschema #3 to the // response property anyOf list for the response status
- info
  the response property const value muted was added for the status
- info
  the response property const value action_add_to_conference was added for the status
- info
  the response property const value action_dtmf was added for the status
- info
  the response property const value action_end_conversation was added for the status
- info
  the response property const value action_external was added for the status
- info
  the response property const value action_set_hold was added for the status
- info
  the response property const value action_transfer_call was added for the status
- info
  the response property const value action_trigger_function_call was added for the status
- info
  the response property const value action_trigger_function_call was added for the status
- info
  the response property const value action_trigger_function_call was added for the status
- info
  the response property const value action_trigger_function_call was added for the status
- info
  the response property const value voice_azure was added for the status
- info
  the response property const value voice_eleven_labs was added for the status
- info
  the response property const value voice_play_ht was added for the status
- info
  the response property const value voice_rime was added for the status
- info
  added voice_vocode discriminator mapping keys to the response property for the response status
- info
  mapped value for discriminator key action_trigger_phrase_based changed from to for /// response property for the response status
- info
  mapped value for discriminator key action_trigger_phrase_based changed from to for /// response property for the response status
- info
  mapped value for discriminator key action_trigger_phrase_based changed from to for /// response property for the response status
- info
  mapped value for discriminator key action_trigger_phrase_based changed from to for /// response property for the response status
- info
  removed discriminator from /// response property for the response status
- info
  removed discriminator from /// response property for the response status
- info
  removed the draft enum value from the // response property for the response status
- info
  removed the faster enum value from the // response property for the response status
- info
  removed the high enum value from the // response property for the response status
- info
  removed the low enum value from the // response property for the response status
- info
  removed the medium enum value from the // response property for the response status
- info
  removed the premium enum value from the // response property for the response status
- info
  removed from the /// response property oneOf list for the response status
- info
  removed from the /// response property oneOf list for the response status
- info
  removed from the /// response property oneOf list for the response status
- info
  removed from the /// response property oneOf list for the response status
- info
  removed from the /// response property oneOf list for the response status
- info
  removed from the /// response property oneOf list for the response status

Operation history (21 revisions)

Get Agent

Request

Query parameters

Response 200OK

Changes

Response