@vapi-ai/web 1.0.249 → 1.0.250

package/README.md

@@ -28,8 +28,12 @@ You can start a new call by calling the `start` method and passing an `assistant
 
 ```javascript
 vapi.start({
-  context: "You are a shopping assistant...",
-  voice: "steve",
+  model: {
+    provider: "openai",
+    model: "gpt-3.5-turbo",
+    systemPrompt: "You're an assistant..."
+  },
+  voice: "jennifer-playht",
   ...
 });
 ```

package/api.ts

@@ -440,11 +440,10 @@ export interface CreateAssistantDTO {
    * @default null
    */
   fillersEnabled?: boolean;
-  /**
-   * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
-   * @default null
-   */
-  liveTranscriptsEnabled?: boolean;
+  /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
+  clientMessages?: "function-call" | "transcript" | "hang";
+  /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
+  serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
   /**
    * How many seconds of silence to wait before ending the call. Defaults to 30.
    * @min 10
@@ -452,6 +451,13 @@ export interface CreateAssistantDTO {
    * @default null
    */
   silenceTimeoutSeconds?: number;
+  /**
+   * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
+   * @min 0
+   * @max 10
+   * @default null
+   */
+  responseDelaySeconds?: number;
 }
 
 export interface Assistant {
@@ -547,11 +553,10 @@ export interface Assistant {
    * @default null
    */
   fillersEnabled?: boolean;
-  /**
-   * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
-   * @default null
-   */
-  liveTranscriptsEnabled?: boolean;
+  /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
+  clientMessages?: "function-call" | "transcript" | "hang";
+  /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
+  serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
   /**
    * How many seconds of silence to wait before ending the call. Defaults to 30.
    * @min 10
@@ -559,6 +564,13 @@ export interface Assistant {
    * @default null
    */
   silenceTimeoutSeconds?: number;
+  /**
+   * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
+   * @min 0
+   * @max 10
+   * @default null
+   */
+  responseDelaySeconds?: number;
   /** This is the unique identifier for the assistant. */
   id: string;
   /** This is the unique identifier for the org that this assistant belongs to. */
@@ -668,11 +680,10 @@ export interface UpdateAssistantDTO {
    * @default null
    */
   fillersEnabled?: boolean;
-  /**
-   * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
-   * @default null
-   */
-  liveTranscriptsEnabled?: boolean;
+  /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
+  clientMessages?: "function-call" | "transcript" | "hang";
+  /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
+  serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
   /**
    * How many seconds of silence to wait before ending the call. Defaults to 30.
    * @min 10
@@ -680,6 +691,13 @@ export interface UpdateAssistantDTO {
    * @default null
    */
   silenceTimeoutSeconds?: number;
+  /**
+   * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
+   * @min 0
+   * @max 10
+   * @default null
+   */
+  responseDelaySeconds?: number;
 }
 
 export interface CreateCustomerDTO {
@@ -751,6 +769,13 @@ export interface Call {
     | "twilio-closed-websocket"
     | "unknown-error"
     | "voicemail";
+  /**
+   * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
+   * @min 10
+   * @max 3600
+   * @default null
+   */
+  maxDurationSeconds?: number;
   /** This is the unique identifier for the call. */
   id: string;
   /** This is the unique identifier for the org that this call belongs to. */
@@ -828,6 +853,13 @@ export interface Call {
 }
 
 export interface CreateOutboundCallDTO {
+  /**
+   * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
+   * @min 10
+   * @max 3600
+   * @default null
+   */
+  maxDurationSeconds?: number;
   /** 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. */
@@ -1107,6 +1139,26 @@ export interface CustomLLMCredential {
   updatedAt: string;
 }
 
+export interface RunpodCredential {
+  provider: "runpod";
+  /** This is not returned in the API. */
+  apiKey: string;
+  /** 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;
+}
+
 export interface CreateTwilioCredentialDTO {
   provider: "twilio";
   /** This is not returned in the API. */
@@ -1181,6 +1233,12 @@ export interface CreateRimeAICredentialDTO {
   apiKey: string;
 }
 
+export interface CreateRunpodCredentialDTO {
+  provider: "runpod";
+  /** This is not returned in the API. */
+  apiKey: string;
+}
+
 export interface UpdateTwilioCredentialDTO {
   provider: "twilio";
   /** This is not returned in the API. */
@@ -1255,6 +1313,12 @@ export interface UpdateRimeAICredentialDTO {
   apiKey: string;
 }
 
+export interface UpdateRunpodCredentialDTO {
+  provider: "runpod";
+  /** This is not returned in the API. */
+  apiKey: string;
+}
+
 export interface BuyPhoneNumberDTO {
   /**
    * This is the area code of the phone number to purchase.
@@ -1636,6 +1700,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags Assistants
+     * @name AssistantControllerReplace
+     * @summary Replace Assistant
+     * @request PUT:/assistant/{id}
+     * @secure
+     */
+    assistantControllerReplace: (id: string, data: UpdateAssistantDTO, params: RequestParams = {}) =>
+      this.request<Assistant, any>({
+        path: `/assistant/${id}`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -1778,7 +1862,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
           } & CreatePlayHTCredentialDTO)
         | ({
             provider: "rime-ai";
-          } & CreateRimeAICredentialDTO),
+          } & CreateRimeAICredentialDTO)
+        | ({
+            provider: "runpod";
+          } & CreateRunpodCredentialDTO),
       params: RequestParams = {},
     ) =>
       this.request<
@@ -1817,7 +1904,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
           } & PlayHTCredential)
         | ({
             provider: "rime-ai";
-          } & RimeAICredential),
+          } & RimeAICredential)
+        | ({
+            provider: "runpod";
+          } & RunpodCredential),
         any
       >({
         path: `/credential`,
@@ -1877,6 +1967,9 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
           | ({
               provider: "rime-ai";
             } & RimeAICredential)
+          | ({
+              provider: "runpod";
+            } & RunpodCredential)
         )[],
         any
       >({
@@ -1933,7 +2026,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
           } & PlayHTCredential)
         | ({
             provider: "rime-ai";
-          } & RimeAICredential),
+          } & RimeAICredential)
+        | ({
+            provider: "runpod";
+          } & RunpodCredential),
         any
       >({
         path: `/credential/${id}`,
@@ -1990,7 +2086,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
           } & UpdatePlayHTCredentialDTO)
         | ({
             provider: "rime-ai";
-          } & UpdateRimeAICredentialDTO),
+          } & UpdateRimeAICredentialDTO)
+        | ({
+            provider: "runpod";
+          } & UpdateRunpodCredentialDTO),
       params: RequestParams = {},
     ) =>
       this.request<
@@ -2029,7 +2128,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
           } & PlayHTCredential)
         | ({
             provider: "rime-ai";
-          } & RimeAICredential),
+          } & RimeAICredential)
+        | ({
+            provider: "runpod";
+          } & RunpodCredential),
         any
       >({
         path: `/credential/${id}`,
@@ -2087,7 +2189,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
           } & PlayHTCredential)
         | ({
             provider: "rime-ai";
-          } & RimeAICredential),
+          } & RimeAICredential)
+        | ({
+            provider: "runpod";
+          } & RunpodCredential),
         any
       >({
         path: `/credential/${id}`,

package/dist/api.d.ts

@@ -344,11 +344,10 @@ export interface CreateAssistantDTO {
      * @default null
      */
     fillersEnabled?: boolean;
-    /**
-     * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
-     * @default null
-     */
-    liveTranscriptsEnabled?: boolean;
+    /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
+    clientMessages?: "function-call" | "transcript" | "hang";
+    /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
+    serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
     /**
      * How many seconds of silence to wait before ending the call. Defaults to 30.
      * @min 10
@@ -356,6 +355,13 @@ export interface CreateAssistantDTO {
      * @default null
      */
     silenceTimeoutSeconds?: number;
+    /**
+     * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
+     * @min 0
+     * @max 10
+     * @default null
+     */
+    responseDelaySeconds?: number;
 }
 export interface Assistant {
     /**
@@ -428,11 +434,10 @@ export interface Assistant {
      * @default null
      */
     fillersEnabled?: boolean;
-    /**
-     * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
-     * @default null
-     */
-    liveTranscriptsEnabled?: boolean;
+    /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
+    clientMessages?: "function-call" | "transcript" | "hang";
+    /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
+    serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
     /**
      * How many seconds of silence to wait before ending the call. Defaults to 30.
      * @min 10
@@ -440,6 +445,13 @@ export interface Assistant {
      * @default null
      */
     silenceTimeoutSeconds?: number;
+    /**
+     * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
+     * @min 0
+     * @max 10
+     * @default null
+     */
+    responseDelaySeconds?: number;
     /** This is the unique identifier for the assistant. */
     id: string;
     /** This is the unique identifier for the org that this assistant belongs to. */
@@ -526,11 +538,10 @@ export interface UpdateAssistantDTO {
      * @default null
      */
     fillersEnabled?: boolean;
-    /**
-     * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
-     * @default null
-     */
-    liveTranscriptsEnabled?: boolean;
+    /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
+    clientMessages?: "function-call" | "transcript" | "hang";
+    /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
+    serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
     /**
      * How many seconds of silence to wait before ending the call. Defaults to 30.
      * @min 10
@@ -538,6 +549,13 @@ export interface UpdateAssistantDTO {
      * @default null
      */
     silenceTimeoutSeconds?: number;
+    /**
+     * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
+     * @min 0
+     * @max 10
+     * @default null
+     */
+    responseDelaySeconds?: number;
 }
 export interface CreateCustomerDTO {
     /** This is the number of the customer. */
@@ -574,6 +592,13 @@ export interface Call {
     status?: "queued" | "ringing" | "in-progress" | "forwarding" | "ended";
     /** This is the explanation for how the call ended. */
     endedReason?: "assistant-ended-call" | "assistant-error" | "assistant-forwarded-call" | "assistant-join-timed-out" | "assistant-not-found" | "customer-busy" | "customer-ended-call" | "customer-did-not-answer" | "db-error" | "exceeded-max-duration" | "manually-canceled" | "no-server-available" | "pipeline-error-custom-llm-response-was-invalid" | "pipeline-error-custom-llm-request-failed" | "pipeline-error-extra-function-failed" | "pipeline-error-first-message-failed" | "pipeline-error-function-filler-failed" | "pipeline-error-function-failed" | "pipeline-error-llm-failed" | "pipeline-error-openai-voice-failed" | "pipeline-error-deepgram-transcriber-failed" | "pipeline-error-deepgram-voice-failed" | "pipeline-error-eleven-labs-voice-failed" | "pipeline-error-eleven-labs-voice-not-found" | "pipeline-error-playht-voice-failed" | "pipeline-error-rime-ai-voice-failed" | "server-shutdown" | "silence-timed-out" | "twilio-failed-to-connect-call" | "twilio-closed-websocket" | "unknown-error" | "voicemail";
+    /**
+     * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
+     * @min 10
+     * @max 3600
+     * @default null
+     */
+    maxDurationSeconds?: number;
     /** This is the unique identifier for the call. */
     id: string;
     /** This is the unique identifier for the org that this call belongs to. */
@@ -650,6 +675,13 @@ export interface Call {
     phoneNumber?: ImportTwilioPhoneNumberDTO;
 }
 export interface CreateOutboundCallDTO {
+    /**
+     * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
+     * @min 10
+     * @max 3600
+     * @default null
+     */
+    maxDurationSeconds?: number;
     /** 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. */
@@ -915,6 +947,25 @@ export interface CustomLLMCredential {
      */
     updatedAt: string;
 }
+export interface RunpodCredential {
+    provider: "runpod";
+    /** This is not returned in the API. */
+    apiKey: string;
+    /** 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;
+}
 export interface CreateTwilioCredentialDTO {
     provider: "twilio";
     /** This is not returned in the API. */
@@ -977,6 +1028,11 @@ export interface CreateRimeAICredentialDTO {
     /** This is not returned in the API. */
     apiKey: string;
 }
+export interface CreateRunpodCredentialDTO {
+    provider: "runpod";
+    /** This is not returned in the API. */
+    apiKey: string;
+}
 export interface UpdateTwilioCredentialDTO {
     provider: "twilio";
     /** This is not returned in the API. */
@@ -1039,6 +1095,11 @@ export interface UpdateRimeAICredentialDTO {
     /** This is not returned in the API. */
     apiKey: string;
 }
+export interface UpdateRunpodCredentialDTO {
+    provider: "runpod";
+    /** This is not returned in the API. */
+    apiKey: string;
+}
 export interface BuyPhoneNumberDTO {
     /**
      * This is the area code of the phone number to purchase.
@@ -1229,6 +1290,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         assistantControllerUpdate: (id: string, data: UpdateAssistantDTO, params?: RequestParams) => Promise<HttpResponse<Assistant, any>>;
+        /**
+         * No description
+         *
+         * @tags Assistants
+         * @name AssistantControllerReplace
+         * @summary Replace Assistant
+         * @request PUT:/assistant/{id}
+         * @secure
+         */
+        assistantControllerReplace: (id: string, data: UpdateAssistantDTO, params?: RequestParams) => Promise<HttpResponse<Assistant, any>>;
         /**
          * No description
          *
@@ -1316,7 +1387,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             provider: "playht";
         } & CreatePlayHTCredentialDTO) | ({
             provider: "rime-ai";
-        } & CreateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
+        } & CreateRimeAICredentialDTO) | ({
+            provider: "runpod";
+        } & CreateRunpodCredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
             provider: "twilio";
         } & TwilioCredential) | ({
             provider: "deepgram";
@@ -1340,7 +1413,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             provider: "playht";
         } & PlayHTCredential) | ({
             provider: "rime-ai";
-        } & RimeAICredential), any>>;
+        } & RimeAICredential) | ({
+            provider: "runpod";
+        } & RunpodCredential), any>>;
         /**
          * No description
          *
@@ -1374,7 +1449,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             provider: "playht";
         } & PlayHTCredential) | ({
             provider: "rime-ai";
-        } & RimeAICredential))[], any>>;
+        } & RimeAICredential) | ({
+            provider: "runpod";
+        } & RunpodCredential))[], any>>;
         /**
          * No description
          *
@@ -1408,7 +1485,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             provider: "playht";
         } & PlayHTCredential) | ({
             provider: "rime-ai";
-        } & RimeAICredential), any>>;
+        } & RimeAICredential) | ({
+            provider: "runpod";
+        } & RunpodCredential), any>>;
         /**
          * No description
          *
@@ -1442,7 +1521,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             provider: "playht";
         } & UpdatePlayHTCredentialDTO) | ({
             provider: "rime-ai";
-        } & UpdateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
+        } & UpdateRimeAICredentialDTO) | ({
+            provider: "runpod";
+        } & UpdateRunpodCredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
             provider: "twilio";
         } & TwilioCredential) | ({
             provider: "deepgram";
@@ -1466,7 +1547,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             provider: "playht";
         } & PlayHTCredential) | ({
             provider: "rime-ai";
-        } & RimeAICredential), any>>;
+        } & RimeAICredential) | ({
+            provider: "runpod";
+        } & RunpodCredential), any>>;
         /**
          * No description
          *
@@ -1500,7 +1583,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             provider: "playht";
         } & PlayHTCredential) | ({
             provider: "rime-ai";
-        } & RimeAICredential), any>>;
+        } & RimeAICredential) | ({
+            provider: "runpod";
+        } & RunpodCredential), any>>;
     };
     phoneNumber: {
         /**

package/dist/api.js

@@ -205,6 +205,16 @@ class Api extends HttpClient {
              * @secure
              */
             assistantControllerUpdate: (id, data, params = {}) => this.request(Object.assign({ path: `/assistant/${id}`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Assistants
+             * @name AssistantControllerReplace
+             * @summary Replace Assistant
+             * @request PUT:/assistant/{id}
+             * @secure
+             */
+            assistantControllerReplace: (id, data, params = {}) => this.request(Object.assign({ path: `/assistant/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *

package/dist/vapi.d.ts

@@ -1,6 +1,12 @@
 /// <reference types="node" />
 import { Call, CreateAssistantDTO } from "./api";
+import type { ChatCompletionMessageParam } from "openai/resources";
 import EventEmitter from "events";
+export interface AddMessageMessage {
+    type: "add-message";
+    message: ChatCompletionMessageParam;
+}
+type VapiClientToServerMessage = AddMessageMessage;
 type VapiEventNames = "call-end" | "call-start" | "volume-level" | "speech-start" | "speech-end" | "message" | "error";
 type VapiEventListeners = {
     "call-end": () => void;
@@ -29,6 +35,6 @@ export default class Vapi extends VapiEventEmitter {
     private onAppMessage;
     private handleRemoteParticipantsAudioLevel;
     stop(): void;
-    send(message: any): void;
+    send(message: VapiClientToServerMessage): void;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vapi-ai/web",
-  "version": "1.0.249",
+  "version": "1.0.250",
   "description": "",
   "main": "dist/vapi.js",
   "types": "dist/vapi.d.ts",
@@ -27,6 +27,7 @@
   },
   "devDependencies": {
     "@types/node": "^20.6.0",
+    "openai": "^4.24.1",
     "swagger-typescript-api": "^13.0.3"
   }
 }

package/vapi.ts

@@ -1,12 +1,12 @@
 import { Call, CreateAssistantDTO } from "./api";
 import DailyIframe, {
   DailyCall,
-  DailyEventObjectActiveSpeakerChange,
   DailyEventObjectAppMessage,
   DailyEventObjectParticipant,
   DailyEventObjectRemoteParticipantsAudioLevel,
 } from "@daily-co/daily-js";
 
+import type { ChatCompletionMessageParam } from "openai/resources";
 import EventEmitter from "events";
 import { client } from "./client";
 
@@ -42,6 +42,13 @@ function subscribeToTracks(e: DailyEventObjectParticipant, call: DailyCall) {
   });
 }
 
+export interface AddMessageMessage {
+  type: "add-message";
+  message: ChatCompletionMessageParam;
+}
+
+type VapiClientToServerMessage = AddMessageMessage;
+
 type VapiEventNames =
   | "call-end"
   | "call-start"
@@ -237,7 +244,7 @@ export default class Vapi extends VapiEventEmitter {
     this.call = null;
   }
 
-  send(message: any): void {
+  send(message: VapiClientToServerMessage): void {
     this.call?.sendAppMessage(JSON.stringify(message));
   }
 }