@vapi-ai/web 1.0.232 → 1.0.234

package/README.md

@@ -72,6 +72,11 @@ vapi.on('volume-level', (volume) => {
   console.log(`Assistant volume level: ${volume}`);
 });
 
+// Function calls and transcripts will be sent via messages
+vapi.on('message', (message) => {
+  console.log(message);
+});
+
 vapi.on('error', (e) => {
   console.error(e)
 });

package/api.ts

@@ -29,7 +29,7 @@ export interface CustomModel {
    * 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. */
+  /** These is the URL we'll POST during the conversation. */
   url: string;
   /** This sets the objective and understanding for the assistant. */
   systemPrompt?: string;
@@ -115,7 +115,11 @@ export interface OpenAIModel {
   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. */
+  /**
+   * This is the temperature that will be used for OpenAI calls.
+   * @min 0
+   * @max 2
+   */
   temperature?: number;
   /** These are the functions that the assistant can execute during the call. */
   functions?: OpenAIFunction[];
@@ -148,15 +152,19 @@ export interface RimeAIVoice {
 }
 
 export interface CreateAssistantDTO {
+  /**
+   * 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;
   /** 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. */
+  model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
+  /**
+   * These are the options for the assistant's voice.
+   * @default "jennifer-playht"
+   */
   voice?:
     | "jennifer-playht"
     | "melissa-playht"
@@ -222,38 +230,6 @@ export interface CreateAssistantDTO {
     | "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;
   /**
@@ -261,6 +237,7 @@ export interface CreateAssistantDTO {
    *
    * If unspecified, it will wait for the user to speak.
    * @maxLength 1000
+   * @default "Hey there!"
    */
   firstMessage?: string;
   /**
@@ -288,15 +265,19 @@ export interface CreateAssistantDTO {
 }
 
 export interface Assistant {
+  /**
+   * 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;
   /** 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. */
+  model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
+  /**
+   * These are the options for the assistant's voice.
+   * @default "jennifer-playht"
+   */
   voice?:
     | "jennifer-playht"
     | "melissa-playht"
@@ -362,38 +343,6 @@ export interface Assistant {
     | "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;
   /**
@@ -401,6 +350,7 @@ export interface Assistant {
    *
    * If unspecified, it will wait for the user to speak.
    * @maxLength 1000
+   * @default "Hey there!"
    */
   firstMessage?: string;
   /**
@@ -442,15 +392,19 @@ export interface Assistant {
 }
 
 export interface UpdateAssistantDTO {
+  /**
+   * 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;
   /** 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. */
+  model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
+  /**
+   * These are the options for the assistant's voice.
+   * @default "jennifer-playht"
+   */
   voice?:
     | "jennifer-playht"
     | "melissa-playht"
@@ -516,38 +470,6 @@ export interface UpdateAssistantDTO {
     | "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;
   /**
@@ -555,6 +477,7 @@ export interface UpdateAssistantDTO {
    *
    * If unspecified, it will wait for the user to speak.
    * @maxLength 1000
+   * @default "Hey there!"
    */
   firstMessage?: string;
   /**
@@ -614,30 +537,26 @@ export interface ImportTwilioPhoneNumberDTO {
 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-ended-call"
     | "assistant-error"
-    | "assistant-join-timeout"
-    | "busy"
-    | "canceled"
-    | "customer-ended"
-    | "forwarded"
-    | "max-duration-timeout"
-    | "no-answer"
+    | "assistant-forwarded-call"
+    | "assistant-join-timed-out"
+    | "assistant-not-found"
+    | "manually-canceled"
+    | "customer-busy"
+    | "customer-ended-call"
+    | "customer-did-not-answer"
+    | "db-error"
+    | "exceeded-max-duration"
     | "no-server-available"
     | "server-shutdown"
-    | "silence-timeout"
-    | "twilio-call-error"
-    | "twilio-websocket-close"
-    | "twilio-websocket-error"
+    | "silence-timed-out"
+    | "twilio-failed-to-connect-call"
+    | "twilio-closed-websocket"
     | "unknown-error"
     | "voicemail";
   /** This is the unique identifier for the call. */
@@ -715,11 +634,6 @@ export interface Call {
 }
 
 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. */
@@ -757,6 +671,111 @@ export interface CreateWebCallDTO {
   assistant?: CreateAssistantDTO;
 }
 
+export interface CreateTwilioCredentialDTO {
+  provider: "twilio";
+  /** This is hidden in the API responses. */
+  authToken: string;
+  accountSid: string;
+}
+
+export interface CreateDeepgramCredentialDTO {
+  provider: "deepgram";
+  /** This is hidden in the API responses. */
+  apiKey: string;
+}
+
+export interface CreateAzureCredentialDTO {
+  provider: "azure-openai";
+  /** This is hidden in the API responses. */
+  openAIKey: string;
+  openAIEndpoint: string;
+}
+
+export interface CreateElevenLabsCredentialDTO {
+  provider: "11labs";
+  /** This is hidden in the API responses. */
+  apiKey: string;
+}
+
+export interface CreatePlayHTCredentialDTO {
+  provider: "playht";
+  /** This is hidden in the API responses. */
+  apiKey: string;
+  userId: string;
+}
+
+export interface CreateRimeAICredentialDTO {
+  provider: "rimeai";
+  /** This is hidden in the API responses. */
+  apiKey: string;
+}
+
+export interface UpdateTwilioCredentialDTO {
+  provider: "twilio";
+  /** This is hidden in the API responses. */
+  authToken: string;
+  accountSid: string;
+}
+
+export interface UpdateDeepgramCredentialDTO {
+  provider: "deepgram";
+  /** This is hidden in the API responses. */
+  apiKey: string;
+}
+
+export interface UpdateAzureCredentialDTO {
+  provider: "azure-openai";
+  /** This is hidden in the API responses. */
+  openAIKey: string;
+  openAIEndpoint: string;
+}
+
+export interface UpdateElevenLabsCredentialDTO {
+  provider: "11labs";
+  /** This is hidden in the API responses. */
+  apiKey: string;
+}
+
+export interface UpdatePlayHTCredentialDTO {
+  provider: "playht";
+  /** This is hidden in the API responses. */
+  apiKey: string;
+  userId: string;
+}
+
+export interface UpdateRimeAICredentialDTO {
+  provider: "rimeai";
+  /** This is hidden in the API responses. */
+  apiKey: string;
+}
+
+export interface Credential {
+  /** This is hidden in the API responses. */
+  authToken?: string;
+  /** This is hidden in the API responses. */
+  apiKey?: string;
+  /** This is hidden in the API responses. */
+  openAIKey?: string;
+  provider: "twilio" | "deepgram" | "azure-openai" | "11labs" | "playht" | "rimeai";
+  /** This is the unique identifier for the credential. */
+  id: string;
+  /** This is the unique identifier for the org that this credential belongs to. */
+  orgId: string;
+  /**
+   * This is the ISO 8601 date-time string of when the credential was created.
+   * @format date-time
+   */
+  createdAt: string;
+  /**
+   * This is the ISO 8601 date-time string of when the assistant was last updated.
+   * @format date-time
+   */
+  updatedAt: string;
+  accountSid?: string;
+  openAIEndpoint?: string;
+  userId?: string;
+}
+
 export interface BuyPhoneNumberDTO {
   /**
    * This is the area code of the phone number to purchase.
@@ -1233,6 +1252,144 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
   };
+  credential = {
+    /**
+     * No description
+     *
+     * @tags Credentials
+     * @name CredentialControllerCreate
+     * @summary Create Credential
+     * @request POST:/credential
+     * @secure
+     */
+    credentialControllerCreate: (
+      data:
+        | ({
+            provider: "twilio";
+          } & CreateTwilioCredentialDTO)
+        | ({
+            provider: "deepgram";
+          } & CreateDeepgramCredentialDTO)
+        | ({
+            provider: "azure-openai";
+          } & CreateAzureCredentialDTO)
+        | ({
+            provider: "11labs";
+          } & CreateElevenLabsCredentialDTO)
+        | ({
+            provider: "playht";
+          } & CreatePlayHTCredentialDTO)
+        | ({
+            provider: "rimeai";
+          } & CreateRimeAICredentialDTO),
+      params: RequestParams = {},
+    ) =>
+      this.request<Credential, any>({
+        path: `/credential`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags Credentials
+     * @name CredentialControllerFindAll
+     * @summary List Credentials
+     * @request GET:/credential
+     * @secure
+     */
+    credentialControllerFindAll: (params: RequestParams = {}) =>
+      this.request<Credential[], any>({
+        path: `/credential`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags Credentials
+     * @name CredentialControllerFindOne
+     * @summary Get Credential
+     * @request GET:/credential/{id}
+     * @secure
+     */
+    credentialControllerFindOne: (id: string, params: RequestParams = {}) =>
+      this.request<Credential, any>({
+        path: `/credential/${id}`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags Credentials
+     * @name CredentialControllerUpdate
+     * @summary Update Credential
+     * @request PUT:/credential/{id}
+     * @secure
+     */
+    credentialControllerUpdate: (
+      id: string,
+      data:
+        | ({
+            provider: "twilio";
+          } & UpdateTwilioCredentialDTO)
+        | ({
+            provider: "deepgram";
+          } & UpdateDeepgramCredentialDTO)
+        | ({
+            provider: "azure-openai";
+          } & UpdateAzureCredentialDTO)
+        | ({
+            provider: "11labs";
+          } & UpdateElevenLabsCredentialDTO)
+        | ({
+            provider: "playht";
+          } & UpdatePlayHTCredentialDTO)
+        | ({
+            provider: "rimeai";
+          } & UpdateRimeAICredentialDTO),
+      params: RequestParams = {},
+    ) =>
+      this.request<Credential, any>({
+        path: `/credential/${id}`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags Credentials
+     * @name CredentialControllerRemove
+     * @summary Delete Credential
+     * @request DELETE:/credential/{id}
+     * @secure
+     */
+    credentialControllerRemove: (id: string, params: RequestParams = {}) =>
+      this.request<Credential, any>({
+        path: `/credential/${id}`,
+        method: "DELETE",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+  };
   phoneNumber = {
     /**
      * No description
@@ -1340,10 +1497,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     phoneNumberControllerRemove: (id: string, params: RequestParams = {}) =>
-      this.request<void, any>({
+      this.request<PhoneNumber, any>({
         path: `/phone-number/${id}`,
         method: "DELETE",
         secure: true,
+        format: "json",
         ...params,
       }),
   };

package/dist/api.d.ts

@@ -17,7 +17,7 @@ export interface CustomModel {
      * 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. */
+    /** These is the URL we'll POST during the conversation. */
     url: string;
     /** This sets the objective and understanding for the assistant. */
     systemPrompt?: string;
@@ -84,7 +84,11 @@ export interface OpenAIModel {
     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. */
+    /**
+     * This is the temperature that will be used for OpenAI calls.
+     * @min 0
+     * @max 2
+     */
     temperature?: number;
     /** These are the functions that the assistant can execute during the call. */
     functions?: OpenAIFunction[];
@@ -114,44 +118,6 @@ export interface RimeAIVoice {
     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" | "will-playht" | "chris-playht" | "matt-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "michael-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai" | "apollo-beta" | "orion-beta" | "aurora-beta" | "asteria-beta" | "stella-beta" | "artemis-beta" | "andromeda-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
@@ -159,6 +125,18 @@ export interface CreateAssistantDTO {
     name?: string;
     /** These are the options for the assistant's transcriber. */
     transcriber?: DeepgramTranscriber;
+    /** These are the options for the assistant's LLM. */
+    model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
+    /**
+     * These are the options for the assistant's voice.
+     * @default "jennifer-playht"
+     */
+    voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "chris-playht" | "matt-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "michael-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai" | "apollo-beta" | "orion-beta" | "aurora-beta" | "asteria-beta" | "stella-beta" | "artemis-beta" | "andromeda-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";
     /** This is the number to forward to if assistant runs into issues. */
     forwardingPhoneNumber?: string;
     /**
@@ -166,6 +144,7 @@ export interface CreateAssistantDTO {
      *
      * If unspecified, it will wait for the user to speak.
      * @maxLength 1000
+     * @default "Hey there!"
      */
     firstMessage?: string;
     /**
@@ -192,44 +171,6 @@ export interface CreateAssistantDTO {
     fillersEnabled?: boolean;
 }
 export interface Assistant {
-    /** 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" | "will-playht" | "chris-playht" | "matt-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "michael-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai" | "apollo-beta" | "orion-beta" | "aurora-beta" | "asteria-beta" | "stella-beta" | "artemis-beta" | "andromeda-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
@@ -237,6 +178,18 @@ export interface Assistant {
     name?: string;
     /** These are the options for the assistant's transcriber. */
     transcriber?: DeepgramTranscriber;
+    /** These are the options for the assistant's LLM. */
+    model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
+    /**
+     * These are the options for the assistant's voice.
+     * @default "jennifer-playht"
+     */
+    voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "chris-playht" | "matt-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "michael-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai" | "apollo-beta" | "orion-beta" | "aurora-beta" | "asteria-beta" | "stella-beta" | "artemis-beta" | "andromeda-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";
     /** This is the number to forward to if assistant runs into issues. */
     forwardingPhoneNumber?: string;
     /**
@@ -244,6 +197,7 @@ export interface Assistant {
      *
      * If unspecified, it will wait for the user to speak.
      * @maxLength 1000
+     * @default "Hey there!"
      */
     firstMessage?: string;
     /**
@@ -284,44 +238,6 @@ export interface Assistant {
     updatedAt: string;
 }
 export interface UpdateAssistantDTO {
-    /** 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" | "will-playht" | "chris-playht" | "matt-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "michael-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai" | "apollo-beta" | "orion-beta" | "aurora-beta" | "asteria-beta" | "stella-beta" | "artemis-beta" | "andromeda-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
@@ -329,6 +245,18 @@ export interface UpdateAssistantDTO {
     name?: string;
     /** These are the options for the assistant's transcriber. */
     transcriber?: DeepgramTranscriber;
+    /** These are the options for the assistant's LLM. */
+    model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
+    /**
+     * These are the options for the assistant's voice.
+     * @default "jennifer-playht"
+     */
+    voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "chris-playht" | "matt-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "michael-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai" | "apollo-beta" | "orion-beta" | "aurora-beta" | "asteria-beta" | "stella-beta" | "artemis-beta" | "andromeda-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";
     /** This is the number to forward to if assistant runs into issues. */
     forwardingPhoneNumber?: string;
     /**
@@ -336,6 +264,7 @@ export interface UpdateAssistantDTO {
      *
      * If unspecified, it will wait for the user to speak.
      * @maxLength 1000
+     * @default "Hey there!"
      */
     firstMessage?: string;
     /**
@@ -392,15 +321,10 @@ export interface ImportTwilioPhoneNumberDTO {
 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";
+    endedReason?: "assistant-ended-call" | "assistant-error" | "assistant-forwarded-call" | "assistant-join-timed-out" | "assistant-not-found" | "manually-canceled" | "customer-busy" | "customer-ended-call" | "customer-did-not-answer" | "db-error" | "exceeded-max-duration" | "no-server-available" | "server-shutdown" | "silence-timed-out" | "twilio-failed-to-connect-call" | "twilio-closed-websocket" | "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. */
@@ -475,11 +399,6 @@ export interface Call {
     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. */
@@ -515,6 +434,98 @@ export interface CreateWebCallDTO {
     /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
     assistant?: CreateAssistantDTO;
 }
+export interface CreateTwilioCredentialDTO {
+    provider: "twilio";
+    /** This is hidden in the API responses. */
+    authToken: string;
+    accountSid: string;
+}
+export interface CreateDeepgramCredentialDTO {
+    provider: "deepgram";
+    /** This is hidden in the API responses. */
+    apiKey: string;
+}
+export interface CreateAzureCredentialDTO {
+    provider: "azure-openai";
+    /** This is hidden in the API responses. */
+    openAIKey: string;
+    openAIEndpoint: string;
+}
+export interface CreateElevenLabsCredentialDTO {
+    provider: "11labs";
+    /** This is hidden in the API responses. */
+    apiKey: string;
+}
+export interface CreatePlayHTCredentialDTO {
+    provider: "playht";
+    /** This is hidden in the API responses. */
+    apiKey: string;
+    userId: string;
+}
+export interface CreateRimeAICredentialDTO {
+    provider: "rimeai";
+    /** This is hidden in the API responses. */
+    apiKey: string;
+}
+export interface UpdateTwilioCredentialDTO {
+    provider: "twilio";
+    /** This is hidden in the API responses. */
+    authToken: string;
+    accountSid: string;
+}
+export interface UpdateDeepgramCredentialDTO {
+    provider: "deepgram";
+    /** This is hidden in the API responses. */
+    apiKey: string;
+}
+export interface UpdateAzureCredentialDTO {
+    provider: "azure-openai";
+    /** This is hidden in the API responses. */
+    openAIKey: string;
+    openAIEndpoint: string;
+}
+export interface UpdateElevenLabsCredentialDTO {
+    provider: "11labs";
+    /** This is hidden in the API responses. */
+    apiKey: string;
+}
+export interface UpdatePlayHTCredentialDTO {
+    provider: "playht";
+    /** This is hidden in the API responses. */
+    apiKey: string;
+    userId: string;
+}
+export interface UpdateRimeAICredentialDTO {
+    provider: "rimeai";
+    /** This is hidden in the API responses. */
+    apiKey: string;
+}
+export interface Credential {
+    /** This is hidden in the API responses. */
+    authToken?: string;
+    /** This is hidden in the API responses. */
+    apiKey?: string;
+    /** This is hidden in the API responses. */
+    openAIKey?: string;
+    provider: "twilio" | "deepgram" | "azure-openai" | "11labs" | "playht" | "rimeai";
+    /** This is the unique identifier for the credential. */
+    id: string;
+    /** This is the unique identifier for the org that this credential belongs to. */
+    orgId: string;
+    /**
+     * This is the ISO 8601 date-time string of when the credential was created.
+     * @format date-time
+     */
+    createdAt: string;
+    /**
+     * This is the ISO 8601 date-time string of when the assistant was last updated.
+     * @format date-time
+     */
+    updatedAt: string;
+    accountSid?: string;
+    openAIEndpoint?: string;
+    userId?: string;
+}
 export interface BuyPhoneNumberDTO {
     /**
      * This is the area code of the phone number to purchase.
@@ -758,6 +769,82 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         callControllerCreateWebCall: (data: CreateWebCallDTO, params?: RequestParams) => Promise<HttpResponse<Call, any>>;
     };
+    credential: {
+        /**
+         * No description
+         *
+         * @tags Credentials
+         * @name CredentialControllerCreate
+         * @summary Create Credential
+         * @request POST:/credential
+         * @secure
+         */
+        credentialControllerCreate: (data: ({
+            provider: "twilio";
+        } & CreateTwilioCredentialDTO) | ({
+            provider: "deepgram";
+        } & CreateDeepgramCredentialDTO) | ({
+            provider: "azure-openai";
+        } & CreateAzureCredentialDTO) | ({
+            provider: "11labs";
+        } & CreateElevenLabsCredentialDTO) | ({
+            provider: "playht";
+        } & CreatePlayHTCredentialDTO) | ({
+            provider: "rimeai";
+        } & CreateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<Credential, any>>;
+        /**
+         * No description
+         *
+         * @tags Credentials
+         * @name CredentialControllerFindAll
+         * @summary List Credentials
+         * @request GET:/credential
+         * @secure
+         */
+        credentialControllerFindAll: (params?: RequestParams) => Promise<HttpResponse<Credential[], any>>;
+        /**
+         * No description
+         *
+         * @tags Credentials
+         * @name CredentialControllerFindOne
+         * @summary Get Credential
+         * @request GET:/credential/{id}
+         * @secure
+         */
+        credentialControllerFindOne: (id: string, params?: RequestParams) => Promise<HttpResponse<Credential, any>>;
+        /**
+         * No description
+         *
+         * @tags Credentials
+         * @name CredentialControllerUpdate
+         * @summary Update Credential
+         * @request PUT:/credential/{id}
+         * @secure
+         */
+        credentialControllerUpdate: (id: string, data: ({
+            provider: "twilio";
+        } & UpdateTwilioCredentialDTO) | ({
+            provider: "deepgram";
+        } & UpdateDeepgramCredentialDTO) | ({
+            provider: "azure-openai";
+        } & UpdateAzureCredentialDTO) | ({
+            provider: "11labs";
+        } & UpdateElevenLabsCredentialDTO) | ({
+            provider: "playht";
+        } & UpdatePlayHTCredentialDTO) | ({
+            provider: "rimeai";
+        } & UpdateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<Credential, any>>;
+        /**
+         * No description
+         *
+         * @tags Credentials
+         * @name CredentialControllerRemove
+         * @summary Delete Credential
+         * @request DELETE:/credential/{id}
+         * @secure
+         */
+        credentialControllerRemove: (id: string, params?: RequestParams) => Promise<HttpResponse<Credential, any>>;
+    };
     phoneNumber: {
         /**
          * No description
@@ -818,7 +905,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request DELETE:/phone-number/{id}
          * @secure
          */
-        phoneNumberControllerRemove: (id: string, params?: RequestParams) => Promise<HttpResponse<void, any>>;
+        phoneNumberControllerRemove: (id: string, params?: RequestParams) => Promise<HttpResponse<PhoneNumber, any>>;
     };
 }
 export {};

package/dist/api.js

@@ -258,6 +258,58 @@ class Api extends HttpClient {
              */
             callControllerCreateWebCall: (data, params = {}) => this.request(Object.assign({ path: `/call/web`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
         };
+        this.credential = {
+            /**
+             * No description
+             *
+             * @tags Credentials
+             * @name CredentialControllerCreate
+             * @summary Create Credential
+             * @request POST:/credential
+             * @secure
+             */
+            credentialControllerCreate: (data, params = {}) => this.request(Object.assign({ path: `/credential`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Credentials
+             * @name CredentialControllerFindAll
+             * @summary List Credentials
+             * @request GET:/credential
+             * @secure
+             */
+            credentialControllerFindAll: (params = {}) => this.request(Object.assign({ path: `/credential`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Credentials
+             * @name CredentialControllerFindOne
+             * @summary Get Credential
+             * @request GET:/credential/{id}
+             * @secure
+             */
+            credentialControllerFindOne: (id, params = {}) => this.request(Object.assign({ path: `/credential/${id}`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Credentials
+             * @name CredentialControllerUpdate
+             * @summary Update Credential
+             * @request PUT:/credential/{id}
+             * @secure
+             */
+            credentialControllerUpdate: (id, data, params = {}) => this.request(Object.assign({ path: `/credential/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Credentials
+             * @name CredentialControllerRemove
+             * @summary Delete Credential
+             * @request DELETE:/credential/{id}
+             * @secure
+             */
+            credentialControllerRemove: (id, params = {}) => this.request(Object.assign({ path: `/credential/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
+        };
         this.phoneNumber = {
             /**
              * No description
@@ -318,7 +370,7 @@ class Api extends HttpClient {
              * @request DELETE:/phone-number/{id}
              * @secure
              */
-            phoneNumberControllerRemove: (id, params = {}) => this.request(Object.assign({ path: `/phone-number/${id}`, method: "DELETE", secure: true }, params)),
+            phoneNumberControllerRemove: (id, params = {}) => this.request(Object.assign({ path: `/phone-number/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
         };
     }
 }

package/dist/vapi.d.ts

@@ -1,13 +1,14 @@
 /// <reference types="node" />
 import { Call, CreateAssistantDTO } from "./api";
 import EventEmitter from "events";
-type VapiEventNames = "call-end" | "call-start" | "volume-level" | "speech-start" | "speech-end" | "error";
+type VapiEventNames = "call-end" | "call-start" | "volume-level" | "speech-start" | "speech-end" | "message" | "error";
 type VapiEventListeners = {
     "call-end": () => void;
     "call-start": () => void;
     "volume-level": (volume: number) => void;
     "speech-start": () => void;
     "speech-end": () => void;
+    message: (message: any) => void;
     error: (error: any) => void;
 };
 declare class VapiEventEmitter extends EventEmitter {
@@ -24,6 +25,7 @@ export default class Vapi extends VapiEventEmitter {
     constructor(apiToken: string, apiBaseUrl?: string);
     private cleanup;
     start(assistant: CreateAssistantDTO | string): Promise<Call | null>;
+    private onAppMessage;
     private handleRemoteParticipantsAudioLevel;
     stop(): void;
 }

package/dist/vapi.js

@@ -139,6 +139,7 @@ class Vapi extends VapiEventEmitter {
                 });
                 this.call.startRemoteParticipantsAudioLevelObserver(100);
                 this.call.on("remote-participants-audio-level", (e) => this.handleRemoteParticipantsAudioLevel(e));
+                this.call.on("app-message", (e) => this.onAppMessage(e));
                 this.call.updateInputSettings({
                     audio: {
                         processor: {
@@ -156,6 +157,17 @@ class Vapi extends VapiEventEmitter {
             }
         });
     }
+    onAppMessage(e) {
+        if (!e)
+            return;
+        try {
+            const parsedMessage = JSON.parse(e.data);
+            this.emit("message", parsedMessage);
+        }
+        catch (e) {
+            console.error(e);
+        }
+    }
     handleRemoteParticipantsAudioLevel(e) {
         const speechLevel = Object.values(e.participantsAudioLevel).reduce((a, b) => a + b, 0);
         this.emit("volume-level", Math.min(1, speechLevel / 0.15));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vapi-ai/web",
-  "version": "1.0.232",
+  "version": "1.0.234",
   "description": "",
   "main": "dist/vapi.js",
   "types": "dist/vapi.d.ts",

package/vapi.ts

@@ -2,6 +2,7 @@ import { Call, CreateAssistantDTO } from "./api";
 import DailyIframe, {
   DailyCall,
   DailyEventObjectActiveSpeakerChange,
+  DailyEventObjectAppMessage,
   DailyEventObjectParticipant,
   DailyEventObjectRemoteParticipantsAudioLevel,
 } from "@daily-co/daily-js";
@@ -47,13 +48,16 @@ type VapiEventNames =
   | "volume-level"
   | "speech-start"
   | "speech-end"
+  | "message"
   | "error";
+
 type VapiEventListeners = {
   "call-end": () => void;
   "call-start": () => void;
   "volume-level": (volume: number) => void;
   "speech-start": () => void;
   "speech-end": () => void;
+  message: (message: any) => void;
   error: (error: any) => void;
 };
 
@@ -170,6 +174,7 @@ export default class Vapi extends VapiEventEmitter {
       this.call.on("remote-participants-audio-level", (e) =>
         this.handleRemoteParticipantsAudioLevel(e)
       );
+      this.call.on("app-message", (e) => this.onAppMessage(e));
 
       this.call.updateInputSettings({
         audio: {
@@ -188,6 +193,16 @@ export default class Vapi extends VapiEventEmitter {
     }
   }
 
+  private onAppMessage(e?: DailyEventObjectAppMessage) {
+    if (!e) return;
+    try {
+      const parsedMessage = JSON.parse(e.data);
+      this.emit("message", parsedMessage);
+    } catch (e) {
+      console.error(e);
+    }
+  }
+
   private handleRemoteParticipantsAudioLevel(
     e: DailyEventObjectRemoteParticipantsAudioLevel
   ) {