@vapi-ai/web 1.0.230 → 1.0.232

package/api.ts

@@ -9,6 +9,67 @@
  * ---------------------------------------------------------------
  */
 
+export interface BetaVoice {
+  /**
+   * This is the voice provider that will be used.
+   *
+   * Pro Voices: `11labs`, `playht`
+   *
+   * Basic Voices: `rimeai`, `beta`
+   */
+  provider: "beta";
+  /** This is the provider-specific ID that will be used. */
+  voiceId: string;
+}
+
+export interface CustomModel {
+  /**
+   * This is the provider that will be used for the model. Currently, only OpenAI and Custom LLM URLs are supported.
+   *
+   * If you have your own LLM, you can use the URL of your LLM endpoint here.
+   */
+  provider: "custom";
+  /** These are the options that will be passed to the provider. */
+  url: string;
+  /** This sets the objective and understanding for the assistant. */
+  systemPrompt?: string;
+}
+
+export interface DeepgramTranscriber {
+  /** This is the transcription provider that will be used. Currently, only Deepgram is supported. */
+  provider: "deepgram";
+  /** 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 */
+  model?:
+    | "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"
+    | "nova-2-custom"
+    | 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. */
+  keywords?: string[];
+}
+
+export interface ElevenLabsVoice {
+  /**
+   * This is the voice provider that will be used.
+   *
+   * Pro Voices: `11labs`, `playht`
+   *
+   * Basic Voices: `rimeai`, `beta`
+   */
+  provider: "11labs";
+  /** This is the provider-specific ID that will be used. */
+  voiceId: string;
+}
+
 export interface OpenAIFunctionParameterProperty {
   type: "string" | "number" | "boolean";
   enum?: string[];
@@ -43,16 +104,59 @@ export interface OpenAIFunction {
   parameters: OpenAIFunctionParameters;
 }
 
-export interface CreateAssistantDTO {
+export interface OpenAIModel {
+  /**
+   * This is the provider that will be used for the model. Currently, only OpenAI and Custom LLM URLs are supported.
+   *
+   * If you have your own LLM, you can use the URL of your LLM endpoint here.
+   */
+  provider: "openai";
   /** This is the OpenAI model that will be used. */
-  model?: "gpt-4" | "gpt-3.5-turbo";
+  model: "gpt-4" | "gpt-3.5-turbo";
+  /** This sets the objective and understanding for the assistant. */
+  systemPrompt?: string;
+  /** This is the temperature that will be used for OpenAI calls. */
+  temperature?: number;
+  /** These are the functions that the assistant can execute during the call. */
+  functions?: OpenAIFunction[];
+}
+
+export interface PlayHTVoice {
   /**
-   * This is the voice that will be used.
+   * This is the voice provider that will be used.
    *
-   * Pro Voices: `*-11labs`, `*-playht`
+   * Pro Voices: `11labs`, `playht`
    *
-   * Basic Voices: `*-rimeai`
+   * Basic Voices: `rimeai`, `beta`
    */
+  provider: "playht";
+  /** This is the provider-specific ID that will be used. */
+  voiceId: string;
+}
+
+export interface RimeAIVoice {
+  /**
+   * This is the voice provider that will be used.
+   *
+   * Pro Voices: `11labs`, `playht`
+   *
+   * Basic Voices: `rimeai`, `beta`
+   */
+  provider: "rimeai";
+  /** This is the provider-specific ID that will be used. */
+  voiceId: string;
+}
+
+export interface CreateAssistantDTO {
+  /** These are the options for the assistant's LLM. */
+  model?:
+    | ({
+        provider: "openai";
+      } & OpenAIModel)
+    | ({
+        provider: "custom";
+      } & CustomModel);
+  /** These are the options for the assistant's voice. */
   voice?:
     | "jennifer-playht"
     | "melissa-playht"
@@ -93,10 +197,14 @@ export interface CreateAssistantDTO {
     | "stella-beta"
     | "artemis-beta"
     | "andromeda-beta"
-    | "atlas-beta";
+    | "atlas-beta"
+    | ElevenLabsVoice
+    | PlayHTVoice
+    | RimeAIVoice
+    | BetaVoice;
   /**
    * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
-   * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
+   * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
    */
   language?:
     | "en"
@@ -115,46 +223,60 @@ export interface CreateAssistantDTO {
     | "es"
     | "es-419";
   /**
-   * This is the name of the assistant. This is just for your own reference.
-   * @maxLength 100
+   * Use `model.systemPrompt` instead.
+   * @deprecated
    */
-  name?: string;
-  /** This sets the objective and understanding for the assistant. */
   context?: string;
-  /** These are the functions that the assistant can execute during the call. */
+  /**
+   * Use `model.functions` instead.
+   * @deprecated
+   */
   functions?: OpenAIFunction[];
   /**
-   * This is the URL Vapi will send GET / POST requests 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 callback. You can find more details in the Function Calling documentation.
+   * Add a Server URL to your Org on the Account page in the dashboard instead.
+   * @deprecated
    */
   callbackUrl?: string;
   /**
-   * If you are using a custom LLM, this is the URL Vapi will use instead of hitting OpenAI.
-   *
-   * A POST request will be sent with an array of messages, and the response should be like so:
-   *
-   * ```
-   * { message: "Oh hey! How are..." }
-   * ```
+   * Use `model.url` instead.
+   * @deprecated
    */
   customLlmUrl?: string;
+  /**
+   * Use `transcriber.keywords` instead.
+   * @deprecated
+   */
+  keywords?: string[];
+  /**
+   * This is the name of the assistant. This is just for your own reference.
+   * @maxLength 100
+   */
+  name?: string;
+  /** These are the options for the assistant's transcriber. */
+  transcriber?: DeepgramTranscriber;
   /** This is the number to forward to if assistant runs into issues. */
   forwardingPhoneNumber?: string;
   /**
    * This is the first message that the assistant will say.
    *
    * If unspecified, it will wait for the user to speak.
-   * @maxLength 400
+   * @maxLength 1000
    */
   firstMessage?: string;
   /**
    * This is the message that the assistant will say if the call is forwarded to voicemail.
    *
    * If unspecified, it will hang up.
-   * @maxLength 400
+   * @maxLength 1000
    */
   voicemailMessage?: string;
+  /**
+   * This is the message that the assistant will say if it ends the call.
+   *
+   * If unspecified, it will hang up without saying anything.
+   * @maxLength 400
+   */
+  endCallMessage?: string;
   /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
   interruptionsEnabled?: boolean;
   /** This sets whether the assistant's calls are recorded. Defaults to true. */
@@ -163,177 +285,18 @@ export interface CreateAssistantDTO {
   endCallFunctionEnabled?: boolean;
   /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
   fillersEnabled?: boolean;
-  /** These keywords are passed to the transcription model to help it pick up use-case specific words. */
-  keywords?: string[];
-}
-
-export interface CreateCustomerDTO {
-  /** This is the number of the customer. */
-  number?: string;
-  /**
-   * This is the name of the customer. This is just for your own reference.
-   * @maxLength 40
-   */
-  name?: string;
-}
-
-export interface ImportTwilioPhoneNumberDTO {
-  /** These are the digits of the phone number you own on your Twilio. */
-  twilioPhoneNumber: string;
-  /** This is your Twilio Account SID that will be used to handle this phone number. */
-  twilioAccountSid: string;
-  /** This is the Twilio Auth Token that will be used to handle this phone number. */
-  twilioAuthToken: string;
-  /**
-   * This is the name of the phone number. This is just for your own reference.
-   * @maxLength 40
-   */
-  name?: string;
-  /**
-   * This is the assistant that will be used for incoming calls to this phone number.
-   *
-   * If this is not set, then the phone number will not handle incoming calls.
-   */
-  assistantId?: string;
-}
-
-export interface Call {
-  type?: "inboundPhoneCall" | "outboundPhoneCall" | "webCall";
-  /** This is the unique identifier for the call. */
-  id: string;
-  /** This is the unique identifier for the org that this call belongs to. */
-  orgId: string;
-  /**
-   * This is the ISO 8601 date-time string of when the call was created.
-   * @format date-time
-   */
-  createdAt: string;
-  /**
-   * This is the ISO 8601 date-time string of when the call was last updated.
-   * @format date-time
-   */
-  updatedAt: string;
-  /**
-   * This is the ISO 8601 date-time string of when the call was started.
-   * @format date-time
-   */
-  startedAt?: string;
-  /**
-   * This is the ISO 8601 date-time string of when the call was ended.
-   * @format date-time
-   */
-  endedAt?: string;
-  /** This is the cost of the call in USD. */
-  cost?: number;
-  /** This is the transcript of the call. */
-  transcript?: string;
-  /** This is the URL of the recording of the call. */
-  recordingUrl?: string;
-  /** This is the summary of the call. */
-  summary?: string;
-  /**
-   * This is the callSid of the phone call.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  twilioCallSid?: string;
-  /**
-   * This is the current status of the call.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  twilioCallStatus?: string;
-  /**
-   * This is the URL of the call that the assistant will join.
-   *
-   * Only relevant for `webCall` type.
-   */
-  webCallUrl?: string;
-  /** This is set if the call experienced an error. */
-  error?: string;
-  /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
-  assistantId?: string;
-  /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
-  assistant?: CreateAssistantDTO;
-  /**
-   * This is the customer that will be called. To call a transient customer , use `customer` instead.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  customerId?: string;
-  /**
-   * This is the customer that will be called. To call an existing customer, use `customerId` instead.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  customer?: CreateCustomerDTO;
-  /**
-   * This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  phoneNumberId?: string;
-  /**
-   * This is the phone number that will be used for the call. To use an existing number, use `phoneNumberId` instead.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  phoneNumber?: ImportTwilioPhoneNumberDTO;
-}
-
-export interface CreateOutboundCallDTO {
-  /**
-   * Use `customer` instead.
-   * @deprecated
-   */
-  customerPhoneNumber?: string;
-  /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
-  assistantId?: string;
-  /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
-  assistant?: CreateAssistantDTO;
-  /**
-   * This is the customer that will be called. To call a transient customer , use `customer` instead.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  customerId?: string;
-  /**
-   * This is the customer that will be called. To call an existing customer, use `customerId` instead.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  customer?: CreateCustomerDTO;
-  /**
-   * This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  phoneNumberId?: string;
-  /**
-   * This is the phone number that will be used for the call. To use an existing number, use `phoneNumberId` instead.
-   *
-   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-   */
-  phoneNumber?: ImportTwilioPhoneNumberDTO;
-}
-
-export interface CreateWebCallDTO {
-  /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
-  assistantId?: string;
-  /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
-  assistant?: CreateAssistantDTO;
 }
 
 export interface Assistant {
-  /** This is the OpenAI model that will be used. */
-  model?: "gpt-4" | "gpt-3.5-turbo";
-  /**
-   * This is the voice that will be used.
-   *
-   * Pro Voices: `*-11labs`, `*-playht`
-   *
-   * Basic Voices: `*-rimeai`
-   */
+  /** These are the options for the assistant's LLM. */
+  model?:
+    | ({
+        provider: "openai";
+      } & OpenAIModel)
+    | ({
+        provider: "custom";
+      } & CustomModel);
+  /** These are the options for the assistant's voice. */
   voice?:
     | "jennifer-playht"
     | "melissa-playht"
@@ -374,10 +337,14 @@ export interface Assistant {
     | "stella-beta"
     | "artemis-beta"
     | "andromeda-beta"
-    | "atlas-beta";
+    | "atlas-beta"
+    | ElevenLabsVoice
+    | PlayHTVoice
+    | RimeAIVoice
+    | BetaVoice;
   /**
    * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
-   * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
+   * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
    */
   language?:
     | "en"
@@ -396,46 +363,60 @@ export interface Assistant {
     | "es"
     | "es-419";
   /**
-   * This is the name of the assistant. This is just for your own reference.
-   * @maxLength 100
+   * Use `model.systemPrompt` instead.
+   * @deprecated
    */
-  name?: string;
-  /** This sets the objective and understanding for the assistant. */
   context?: string;
-  /** These are the functions that the assistant can execute during the call. */
+  /**
+   * Use `model.functions` instead.
+   * @deprecated
+   */
   functions?: OpenAIFunction[];
   /**
-   * This is the URL Vapi will send GET / POST requests 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 callback. You can find more details in the Function Calling documentation.
+   * Add a Server URL to your Org on the Account page in the dashboard instead.
+   * @deprecated
    */
   callbackUrl?: string;
   /**
-   * If you are using a custom LLM, this is the URL Vapi will use instead of hitting OpenAI.
-   *
-   * A POST request will be sent with an array of messages, and the response should be like so:
-   *
-   * ```
-   * { message: "Oh hey! How are..." }
-   * ```
+   * Use `model.url` instead.
+   * @deprecated
    */
   customLlmUrl?: string;
+  /**
+   * Use `transcriber.keywords` instead.
+   * @deprecated
+   */
+  keywords?: string[];
+  /**
+   * This is the name of the assistant. This is just for your own reference.
+   * @maxLength 100
+   */
+  name?: string;
+  /** These are the options for the assistant's transcriber. */
+  transcriber?: DeepgramTranscriber;
   /** This is the number to forward to if assistant runs into issues. */
   forwardingPhoneNumber?: string;
   /**
    * This is the first message that the assistant will say.
    *
    * If unspecified, it will wait for the user to speak.
-   * @maxLength 400
+   * @maxLength 1000
    */
   firstMessage?: string;
   /**
    * This is the message that the assistant will say if the call is forwarded to voicemail.
    *
    * If unspecified, it will hang up.
-   * @maxLength 400
+   * @maxLength 1000
    */
   voicemailMessage?: string;
+  /**
+   * This is the message that the assistant will say if it ends the call.
+   *
+   * If unspecified, it will hang up without saying anything.
+   * @maxLength 400
+   */
+  endCallMessage?: string;
   /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
   interruptionsEnabled?: boolean;
   /** This sets whether the assistant's calls are recorded. Defaults to true. */
@@ -444,8 +425,6 @@ export interface Assistant {
   endCallFunctionEnabled?: boolean;
   /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
   fillersEnabled?: boolean;
-  /** These keywords are passed to the transcription model to help it pick up use-case specific words. */
-  keywords?: string[];
   /** This is the unique identifier for the assistant. */
   id: string;
   /** This is the unique identifier for the org that this assistant belongs to. */
@@ -463,15 +442,15 @@ export interface Assistant {
 }
 
 export interface UpdateAssistantDTO {
-  /** This is the OpenAI model that will be used. */
-  model?: "gpt-4" | "gpt-3.5-turbo";
-  /**
-   * This is the voice that will be used.
-   *
-   * Pro Voices: `*-11labs`, `*-playht`
-   *
-   * Basic Voices: `*-rimeai`
-   */
+  /** These are the options for the assistant's LLM. */
+  model?:
+    | ({
+        provider: "openai";
+      } & OpenAIModel)
+    | ({
+        provider: "custom";
+      } & CustomModel);
+  /** These are the options for the assistant's voice. */
   voice?:
     | "jennifer-playht"
     | "melissa-playht"
@@ -512,78 +491,270 @@ export interface UpdateAssistantDTO {
     | "stella-beta"
     | "artemis-beta"
     | "andromeda-beta"
-    | "atlas-beta";
+    | "atlas-beta"
+    | ElevenLabsVoice
+    | PlayHTVoice
+    | RimeAIVoice
+    | BetaVoice;
+  /**
+   * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
+   * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
+   */
+  language?:
+    | "en"
+    | "en-US"
+    | "en-AU"
+    | "en-GB"
+    | "en-NZ"
+    | "en-IN"
+    | "fr"
+    | "fr-CA"
+    | "de"
+    | "hi"
+    | "hi-Latn"
+    | "pt"
+    | "pt-BR"
+    | "es"
+    | "es-419";
+  /**
+   * Use `model.systemPrompt` instead.
+   * @deprecated
+   */
+  context?: string;
+  /**
+   * Use `model.functions` instead.
+   * @deprecated
+   */
+  functions?: OpenAIFunction[];
+  /**
+   * Add a Server URL to your Org on the Account page in the dashboard instead.
+   * @deprecated
+   */
+  callbackUrl?: string;
+  /**
+   * Use `model.url` instead.
+   * @deprecated
+   */
+  customLlmUrl?: string;
+  /**
+   * Use `transcriber.keywords` instead.
+   * @deprecated
+   */
+  keywords?: string[];
+  /**
+   * This is the name of the assistant. This is just for your own reference.
+   * @maxLength 100
+   */
+  name?: string;
+  /** These are the options for the assistant's transcriber. */
+  transcriber?: DeepgramTranscriber;
+  /** This is the number to forward to if assistant runs into issues. */
+  forwardingPhoneNumber?: string;
+  /**
+   * This is the first message that the assistant will say.
+   *
+   * If unspecified, it will wait for the user to speak.
+   * @maxLength 1000
+   */
+  firstMessage?: string;
+  /**
+   * This is the message that the assistant will say if the call is forwarded to voicemail.
+   *
+   * If unspecified, it will hang up.
+   * @maxLength 1000
+   */
+  voicemailMessage?: string;
+  /**
+   * This is the message that the assistant will say if it ends the call.
+   *
+   * If unspecified, it will hang up without saying anything.
+   * @maxLength 400
+   */
+  endCallMessage?: string;
+  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
+  interruptionsEnabled?: boolean;
+  /** This sets whether the assistant's calls are recorded. Defaults to true. */
+  recordingEnabled?: boolean;
+  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
+  endCallFunctionEnabled?: boolean;
+  /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
+  fillersEnabled?: boolean;
+}
+
+export interface CreateCustomerDTO {
+  /** This is the number of the customer. */
+  number?: string;
+  /**
+   * This is the name of the customer. This is just for your own reference.
+   * @maxLength 40
+   */
+  name?: string;
+}
+
+export interface ImportTwilioPhoneNumberDTO {
+  /** These are the digits of the phone number you own on your Twilio. */
+  twilioPhoneNumber: string;
+  /** This is your Twilio Account SID that will be used to handle this phone number. */
+  twilioAccountSid: string;
+  /** This is the Twilio Auth Token that will be used to handle this phone number. */
+  twilioAuthToken: string;
+  /**
+   * This is the name of the phone number. This is just for your own reference.
+   * @maxLength 40
+   */
+  name?: string;
+  /**
+   * This is the assistant that will be used for incoming calls to this phone number.
+   *
+   * If this is not set, then the phone number will not handle incoming calls.
+   */
+  assistantId?: string;
+}
+
+export interface Call {
+  /** This is the type of call. */
+  type?: "inboundPhoneCall" | "outboundPhoneCall" | "webCall";
+  /**
+   * Use `status` instead.
+   * @deprecated
+   */
+  twilioCallStatus?: string;
+  /** This is the status of the call. */
+  status?: "queued" | "ringing" | "in-progress" | "forwarding" | "ended";
+  /** This is the explanation for how the call ended. */
+  endedReason?:
+    | "assistant-ended"
+    | "assistant-error"
+    | "assistant-join-timeout"
+    | "busy"
+    | "canceled"
+    | "customer-ended"
+    | "forwarded"
+    | "max-duration-timeout"
+    | "no-answer"
+    | "no-server-available"
+    | "server-shutdown"
+    | "silence-timeout"
+    | "twilio-call-error"
+    | "twilio-websocket-close"
+    | "twilio-websocket-error"
+    | "unknown-error"
+    | "voicemail";
+  /** This is the unique identifier for the call. */
+  id: string;
+  /** This is the unique identifier for the org that this call belongs to. */
+  orgId: string;
+  /**
+   * This is the ISO 8601 date-time string of when the call was created.
+   * @format date-time
+   */
+  createdAt: string;
+  /**
+   * This is the ISO 8601 date-time string of when the call was last updated.
+   * @format date-time
+   */
+  updatedAt: string;
+  /**
+   * This is the ISO 8601 date-time string of when the call was started.
+   * @format date-time
+   */
+  startedAt?: string;
+  /**
+   * This is the ISO 8601 date-time string of when the call was ended.
+   * @format date-time
+   */
+  endedAt?: string;
+  /** This is the cost of the call in USD. */
+  cost?: number;
+  /** This is the transcript of the call. */
+  transcript?: string;
+  /** This is the URL of the recording of the call. */
+  recordingUrl?: string;
+  /** This is the summary of the call. */
+  summary?: string;
+  /**
+   * This is the callSid of the phone call.
+   *
+   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+   */
+  twilioCallSid?: string;
   /**
-   * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
-   * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
+   * This is the URL of the call that the assistant will join.
+   *
+   * Only relevant for `webCall` type.
    */
-  language?:
-    | "en"
-    | "en-US"
-    | "en-AU"
-    | "en-GB"
-    | "en-NZ"
-    | "en-IN"
-    | "fr"
-    | "fr-CA"
-    | "de"
-    | "hi"
-    | "hi-Latn"
-    | "pt"
-    | "pt-BR"
-    | "es"
-    | "es-419";
+  webCallUrl?: string;
+  /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
+  assistantId?: string;
+  /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
+  assistant?: CreateAssistantDTO;
   /**
-   * This is the name of the assistant. This is just for your own reference.
-   * @maxLength 100
+   * This is the customer that will be called. To call a transient customer , use `customer` instead.
+   *
+   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
    */
-  name?: string;
-  /** This sets the objective and understanding for the assistant. */
-  context?: string;
-  /** These are the functions that the assistant can execute during the call. */
-  functions?: OpenAIFunction[];
+  customerId?: string;
   /**
-   * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
+   * This is the customer that will be called. To call an existing customer, use `customerId` instead.
    *
-   * All requests will be sent with the `call` object among other things relevant to that callback. You can find more details in the Function Calling documentation.
+   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
    */
-  callbackUrl?: string;
+  customer?: CreateCustomerDTO;
   /**
-   * If you are using a custom LLM, this is the URL Vapi will use instead of hitting OpenAI.
+   * This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.
    *
-   * A POST request will be sent with an array of messages, and the response should be like so:
+   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+   */
+  phoneNumberId?: string;
+  /**
+   * This is the phone number that will be used for the call. To use an existing number, use `phoneNumberId` instead.
    *
-   * ```
-   * { message: "Oh hey! How are..." }
-   * ```
+   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
    */
-  customLlmUrl?: string;
-  /** This is the number to forward to if assistant runs into issues. */
-  forwardingPhoneNumber?: string;
+  phoneNumber?: ImportTwilioPhoneNumberDTO;
+}
+
+export interface CreateOutboundCallDTO {
   /**
-   * This is the first message that the assistant will say.
+   * Use `customer` instead.
+   * @deprecated
+   */
+  customerPhoneNumber?: string;
+  /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
+  assistantId?: string;
+  /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
+  assistant?: CreateAssistantDTO;
+  /**
+   * This is the customer that will be called. To call a transient customer , use `customer` instead.
    *
-   * If unspecified, it will wait for the user to speak.
-   * @maxLength 400
+   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
    */
-  firstMessage?: string;
+  customerId?: string;
   /**
-   * This is the message that the assistant will say if the call is forwarded to voicemail.
+   * This is the customer that will be called. To call an existing customer, use `customerId` instead.
    *
-   * If unspecified, it will hang up.
-   * @maxLength 400
+   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
    */
-  voicemailMessage?: string;
-  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
-  interruptionsEnabled?: boolean;
-  /** This sets whether the assistant's calls are recorded. Defaults to true. */
-  recordingEnabled?: boolean;
-  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
-  endCallFunctionEnabled?: boolean;
-  /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
-  fillersEnabled?: boolean;
-  /** These keywords are passed to the transcription model to help it pick up use-case specific words. */
-  keywords?: string[];
+  customer?: CreateCustomerDTO;
+  /**
+   * This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.
+   *
+   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+   */
+  phoneNumberId?: string;
+  /**
+   * This is the phone number that will be used for the call. To use an existing number, use `phoneNumberId` instead.
+   *
+   * Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+   */
+  phoneNumber?: ImportTwilioPhoneNumberDTO;
+}
+
+export interface CreateWebCallDTO {
+  /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
+  assistantId?: string;
+  /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
+  assistant?: CreateAssistantDTO;
 }
 
 export interface BuyPhoneNumberDTO {
@@ -890,21 +1061,23 @@ export class HttpClient<SecurityDataType = unknown> {
  * API for building voice assistants
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
-  call = {
+  assistant = {
     /**
      * No description
      *
-     * @tags Calls
-     * @name CallControllerFindAll
-     * @summary List Calls
-     * @request GET:/call
+     * @tags Assistants
+     * @name AssistantControllerCreate
+     * @summary Create Assistant
+     * @request POST:/assistant
      * @secure
      */
-    callControllerFindAll: (params: RequestParams = {}) =>
-      this.request<Call[], any>({
-        path: `/call`,
-        method: "GET",
+    assistantControllerCreate: (data: CreateAssistantDTO, params: RequestParams = {}) =>
+      this.request<Assistant, any>({
+        path: `/assistant`,
+        method: "POST",
+        body: data,
         secure: true,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -912,15 +1085,15 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     /**
      * No description
      *
-     * @tags Calls
-     * @name CallControllerFindOne
-     * @summary Get Call
-     * @request GET:/call/{id}
+     * @tags Assistants
+     * @name AssistantControllerFindAll
+     * @summary List Assistants
+     * @request GET:/assistant
      * @secure
      */
-    callControllerFindOne: (id: string, params: RequestParams = {}) =>
-      this.request<Call, any>({
-        path: `/call/${id}`,
+    assistantControllerFindAll: (params: RequestParams = {}) =>
+      this.request<Assistant[], any>({
+        path: `/assistant`,
         method: "GET",
         secure: true,
         format: "json",
@@ -930,19 +1103,17 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     /**
      * No description
      *
-     * @tags Calls
-     * @name CallControllerCreatePhoneCall
-     * @summary Create Phone Call
-     * @request POST:/call/phone
+     * @tags Assistants
+     * @name AssistantControllerFindOne
+     * @summary Get Assistant
+     * @request GET:/assistant/{id}
      * @secure
      */
-    callControllerCreatePhoneCall: (data: CreateOutboundCallDTO, params: RequestParams = {}) =>
-      this.request<Call, any>({
-        path: `/call/phone`,
-        method: "POST",
-        body: data,
+    assistantControllerFindOne: (id: string, params: RequestParams = {}) =>
+      this.request<Assistant, any>({
+        path: `/assistant/${id}`,
+        method: "GET",
         secure: true,
-        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -950,56 +1121,54 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     /**
      * No description
      *
-     * @tags Calls
-     * @name CallControllerCreateWebCall
-     * @summary Create Web Call
-     * @request POST:/call/web
+     * @tags Assistants
+     * @name AssistantControllerUpdate
+     * @summary Update Assistant
+     * @request PATCH:/assistant/{id}
      * @secure
      */
-    callControllerCreateWebCall: (data: CreateWebCallDTO, params: RequestParams = {}) =>
-      this.request<Call, any>({
-        path: `/call/web`,
-        method: "POST",
+    assistantControllerUpdate: (id: string, data: UpdateAssistantDTO, params: RequestParams = {}) =>
+      this.request<Assistant, any>({
+        path: `/assistant/${id}`,
+        method: "PATCH",
         body: data,
         secure: true,
         type: ContentType.Json,
         format: "json",
         ...params,
       }),
-  };
-  assistant = {
+
     /**
      * No description
      *
      * @tags Assistants
-     * @name AssistantControllerCreate
-     * @summary Create Assistant
-     * @request POST:/assistant
+     * @name AssistantControllerRemove
+     * @summary Delete Assistant
+     * @request DELETE:/assistant/{id}
      * @secure
      */
-    assistantControllerCreate: (data: CreateAssistantDTO, params: RequestParams = {}) =>
+    assistantControllerRemove: (id: string, params: RequestParams = {}) =>
       this.request<Assistant, any>({
-        path: `/assistant`,
-        method: "POST",
-        body: data,
+        path: `/assistant/${id}`,
+        method: "DELETE",
         secure: true,
-        type: ContentType.Json,
         format: "json",
         ...params,
       }),
-
+  };
+  call = {
     /**
      * No description
      *
-     * @tags Assistants
-     * @name AssistantControllerFindAll
-     * @summary List Assistants
-     * @request GET:/assistant
+     * @tags Calls
+     * @name CallControllerFindAll
+     * @summary List Calls
+     * @request GET:/call
      * @secure
      */
-    assistantControllerFindAll: (params: RequestParams = {}) =>
-      this.request<Assistant[], any>({
-        path: `/assistant`,
+    callControllerFindAll: (params: RequestParams = {}) =>
+      this.request<Call[], any>({
+        path: `/call`,
         method: "GET",
         secure: true,
         format: "json",
@@ -1009,15 +1178,15 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     /**
      * No description
      *
-     * @tags Assistants
-     * @name AssistantControllerFindOne
-     * @summary Get Assistant
-     * @request GET:/assistant/{id}
+     * @tags Calls
+     * @name CallControllerFindOne
+     * @summary Get Call
+     * @request GET:/call/{id}
      * @secure
      */
-    assistantControllerFindOne: (id: string, params: RequestParams = {}) =>
-      this.request<Assistant, any>({
-        path: `/assistant/${id}`,
+    callControllerFindOne: (id: string, params: RequestParams = {}) =>
+      this.request<Call, any>({
+        path: `/call/${id}`,
         method: "GET",
         secure: true,
         format: "json",
@@ -1027,16 +1196,16 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     /**
      * No description
      *
-     * @tags Assistants
-     * @name AssistantControllerUpdate
-     * @summary Update Assistant
-     * @request PATCH:/assistant/{id}
+     * @tags Calls
+     * @name CallControllerCreatePhoneCall
+     * @summary Create Phone Call
+     * @request POST:/call/phone
      * @secure
      */
-    assistantControllerUpdate: (id: string, data: UpdateAssistantDTO, params: RequestParams = {}) =>
-      this.request<Assistant, any>({
-        path: `/assistant/${id}`,
-        method: "PATCH",
+    callControllerCreatePhoneCall: (data: CreateOutboundCallDTO, params: RequestParams = {}) =>
+      this.request<Call, any>({
+        path: `/call/phone`,
+        method: "POST",
         body: data,
         secure: true,
         type: ContentType.Json,
@@ -1047,17 +1216,19 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     /**
      * No description
      *
-     * @tags Assistants
-     * @name AssistantControllerRemove
-     * @summary Delete Assistant
-     * @request DELETE:/assistant/{id}
+     * @tags Calls
+     * @name CallControllerCreateWebCall
+     * @summary Create Web Call
+     * @request POST:/call/web
      * @secure
      */
-    assistantControllerRemove: (id: string, params: RequestParams = {}) =>
-      this.request<Assistant, any>({
-        path: `/assistant/${id}`,
-        method: "DELETE",
+    callControllerCreateWebCall: (data: CreateWebCallDTO, params: RequestParams = {}) =>
+      this.request<Call, any>({
+        path: `/call/web`,
+        method: "POST",
+        body: data,
         secure: true,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),