Get Assistant

Authorizations

Authorization

string

headerrequired

Retrieve your key from Dashboard.

Path Parameters

id

string

required

Response

200 - application/json

id

string

required

This is the unique identifier for the assistant.

orgId

string

required

This is the unique identifier for the org that this assistant belongs to.

createdAt

string

required

This is the ISO 8601 date-time string of when the assistant was created.

updatedAt

string

required

This is the ISO 8601 date-time string of when the assistant was last updated.

transcriber

object

These are the options for the assistant's transcriber.

• DeepgramTranscriber
• TalkscriberTranscriber

Show child attributes

transcriber.provider

enum<string>

required

This is the transcription provider that will be used.

Available options:

deepgram

transcriber.model

This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview

Available options:

nova-2,

nova-2-general,

nova-2-meeting,

nova-2-phonecall,

nova-2-finance,

nova-2-conversationalai,

nova-2-voicemail,

nova-2-video,

nova-2-medical,

nova-2-drivethru,

nova-2-automotive

transcriber.language

enum<string>

This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview

Available options:

cs,

da,

da-DK,

de-CH,

nl,

en,

en-US,

en-AU,

en-GB,

en-NZ,

en-IN,

nl-BE,

fr,

fr-CA,

de,

el,

hi,

hi-Latn,

id,

it,

ja,

ko,

ko-KR,

no,

pl,

pt,

pt-BR,

ru,

es,

es-419,

sv,

sv-SE,

tr,

uk,

ja,

zh,

zh-CN,

zh-TW

transcriber.keywords

string[]

These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.

model

object

These are the options for the assistant's LLM.

• OpenAIModel
• TogetherAIModel
• AnyscaleModel
• OpenRouterModel
• PerplexityAIModel
• DeepInfraModel
• GroqModel
• AnthropicModel
• CustomLLMModel

Show child attributes

model.provider

enum<string>

required

This is the provider that will be used for the model.

Available options:

openai

model.model

enum<string>

required

This is the OpenAI model that will be used.

Available options:

gpt-4-1106-preview,

gpt-4-0125-preview,

gpt-4-0613,

gpt-3.5-turbo-1106,

gpt-3.5-turbo-16k,

gpt-3.5-turbo-0613,

gpt-3.5-turbo-0125,

gpt-4,

gpt-3.5-turbo

model.messages

object[]

This is the starting state for the conversation.

Show child attributes

model.messages.content

string | null

required

model.messages.role

enum<string>

required

Available options:

assistant,

function,

user,

system

model.messages.function_call

object

model.messages.tool_calls

object[]

model.fallbackModels

enum<string>[]

Available options:

gpt-4-1106-preview,

gpt-4-0125-preview,

gpt-4-0613,

gpt-3.5-turbo-1106,

gpt-3.5-turbo-16k,

gpt-3.5-turbo-0613,

gpt-3.5-turbo-0125,

gpt-4,

gpt-3.5-turbo

model.semanticCachingEnabled

boolean

model.temperature

number

This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.

Required range: 0 < x < 2

model.functions

object[]

These are the functions that the assistant can execute during the call.

Show child attributes

model.functions.name

string

required

This is the the name of the function to be called.

Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Maximum length: 64

model.functions.async

boolean

Setting async: true will cause the function to be called asynchronously, meaning that the Assistant will not wait for the function to return before continuing.

model.functions.description

string

This is the description of what the function does, used by the AI to choose when and how to call the function.

Maximum length: 1000

model.functions.parameters

object

These are the parameters the functions accepts, described as a JSON Schema object.

See the OpenAI guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

Show child attributes

model.functions.parameters.type

enum<string>

required

This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.

Available options:

object

model.functions.parameters.properties

object

required

This provides a description of the properties required by the function. JSON Schema can be used to specify expectations for each property. Refer to this doc for a comprehensive guide on JSON Schema.

Show child attributes

model.functions.parameters.properties.{key}

object

Show child attributes

model.functions.parameters.required

string[]

This specifies the properties that are required by the function.

model.functions.serverUrl

string

This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.

All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.

This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl

model.functions.serverUrlSecret

string

This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.

Same precendence logic as serverUrl.

model.maxTokens

number

This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.

Required range: 50 < x < 1000

voice

object

These are the options for the assistant's voice.

• AzureVoice
• ElevenLabsVoice
• PlayHTVoice
• RimeAIVoice
• DeepgramVoice
• OpenAIVoice
• LMNTVoice
• NeetsVoice

Show child attributes

voice.provider

enum<string>

required

This is the voice provider that will be used.

Available options:

azure

voice.voiceId

required

This is the provider-specific ID that will be used.

Available options:

andrew,

brian,

emma

voice.speed

number

This is the speed multiplier that will be used.

Required range: 0.5 < x < 2

forwardingPhoneNumber

string

This is the number to forward to if assistant runs into issues.

recordingEnabled

boolean

This sets whether the assistant's calls are recorded. Defaults to true.

endCallFunctionEnabled

boolean

This sets whether the assistant will be able to hang up the call. Defaults to false.

dialKeypadFunctionEnabled

boolean

This sets whether the assistant can dial digits on the keypad. Defaults to false.

hipaaEnabled

boolean

When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.

clientMessages

enum<string>[]

These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call', 'speech-update', 'metadata', 'conversation-update']

Available options:

status-update,

speech-update,

transcript,

hang,

function-call,

metadata,

conversation-update

serverMessages

enum<string>[]

These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call']

Available options:

status-update,

transcript,

hang,

function-call,

end-of-call-report,

conversation-update,

phone-call-control

silenceTimeoutSeconds

number

How many seconds of silence to wait before ending the call. Defaults to 30.

Required range: 10 < x < 600

responseDelaySeconds

number

The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.

Required range: 0 < x < 2

llmRequestDelaySeconds

number

The minimum number of seconds to wait after punctuation before sending a request to the LLM. Defaults to 0.1.

Required range: 0 < x < 3

numWordsToInterruptAssistant

number

The number of words to wait for before interrupting the assistant. Words like "stop", "actually", "no", etc. will always interrupt immediately regardless of this value. Words like "okay", "yeah", "right" will never interrupt. Defaults to 2.

Required range: 1 < x < 10

maxDurationSeconds

number

This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.

Required range: 10 < x < 3600

backgroundSound

enum<string>

This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.

Available options:

off,

office

name

string

This is the name of the assistant. This is just for your own reference.

Maximum length: 100

forwardingPhoneNumbers

object[]

You can provide a set of phone numbers to forward to. You'll want to tell the assistant when to use each of these numbers in the system prompt.

Show child attributes

forwardingPhoneNumbers.number

string

This is the number to forward to. Pass one of number or sipUri.

forwardingPhoneNumbers.sipUri

string

This is the SIP URI to forward to. Pass one of number or sipUri.

forwardingPhoneNumbers.message

string

This is the message that the assistant will say when the call is forwarded to this number.

firstMessage

string

This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).

If unspecified, it will wait for the user to speak.

Maximum length: 1000

voicemailDetectionEnabled

boolean

This sets whether the assistant should detect voicemail. Defaults to true.

voicemailMessage

string

This is the message that the assistant will say if the call is forwarded to voicemail.

If unspecified, it will hang up.

Maximum length: 1000

endCallMessage

string

This is the message that the assistant will say if it ends the call.

If unspecified, it will hang up without saying anything.

Maximum length: 400

endCallPhrases

string[]

This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.

metadata

object

This is the metadata associated with the call.

serverUrl

string

This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.

All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.

This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl

serverUrlSecret

string

This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.

Same precendence logic as serverUrl.