@vapi-ai/web 1.0.222 → 1.0.224

package/api.ts

@@ -9,9 +9,15 @@
  * ---------------------------------------------------------------
  */
 
-export interface OpenAIFunctionParamaters {
-  type: string;
-  properties: object;
+export interface OpenAIFunctionParameterProperty {
+  type: "string" | "number" | "boolean";
+  enum?: string[];
+  description?: string;
+}
+
+export interface OpenAIFunctionParameters {
+  type: "object";
+  properties: Record<string, OpenAIFunctionParameterProperty>;
   required?: string[];
 }
 
@@ -23,6 +29,8 @@ export interface OpenAIFunction {
    * @maxLength 64
    */
   name: string;
+  /** Setting async: true will cause the function to be called asynchronously, meaning that the Assistant will not wait for the function to return before continuing. */
+  async?: boolean;
   /** This is the description of what the function does, used by the AI to choose when and how to call the function. */
   description?: string;
   /**
@@ -32,12 +40,12 @@ export interface OpenAIFunction {
    *
    * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.
    */
-  parameters: OpenAIFunctionParamaters;
+  parameters: OpenAIFunctionParameters;
 }
 
 export interface CreateAssistantDTO {
   /** This is the OpenAI model that will be used. */
-  model?: "gpt-4-32k" | "gpt-4" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo";
+  model?: "gpt-4" | "gpt-3.5-turbo";
   /**
    * This is the voice that will be used.
    *
@@ -90,19 +98,36 @@ export interface CreateAssistantDTO {
    * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
    */
   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..." }
+   * ```
+   */
+  customLlmUrl?: string;
   /** 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 280
+   * @maxLength 400
    */
   firstMessage?: string;
-  /** This sets whether calls are recorded for the assistant. */
+  /**
+   * This is the message that the assistant will say if the call is forwarded to voicemail.
+   *
+   * If unspecified, it will hang up.
+   * @maxLength 400
+   */
+  voicemailMessage?: string;
+  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
+  interruptionsEnabled?: boolean;
+  /** This sets whether calls are recorded for the assistant. Defaults to true. */
   recordingEnabled?: boolean;
-  /** This sets whether assistant leaves voicemails when call is not picked up. */
-  voicemailEnabled?: boolean;
 }
 
 export interface CreateCustomerDTO {
@@ -264,7 +289,7 @@ export interface CreateWebCallDTO {
 
 export interface Assistant {
   /** This is the OpenAI model that will be used. */
-  model?: "gpt-4-32k" | "gpt-4" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo";
+  model?: "gpt-4" | "gpt-3.5-turbo";
   /**
    * This is the voice that will be used.
    *
@@ -317,19 +342,36 @@ export interface Assistant {
    * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
    */
   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..." }
+   * ```
+   */
+  customLlmUrl?: string;
   /** 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 280
+   * @maxLength 400
    */
   firstMessage?: string;
-  /** This sets whether calls are recorded for the assistant. */
+  /**
+   * This is the message that the assistant will say if the call is forwarded to voicemail.
+   *
+   * If unspecified, it will hang up.
+   * @maxLength 400
+   */
+  voicemailMessage?: string;
+  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
+  interruptionsEnabled?: boolean;
+  /** This sets whether calls are recorded for the assistant. Defaults to true. */
   recordingEnabled?: boolean;
-  /** This sets whether assistant leaves voicemails when call is not picked up. */
-  voicemailEnabled?: boolean;
   /** This is the unique identifier for the assistant. */
   id: string;
   /** This is the unique identifier for the org that this assistant belongs to. */
@@ -348,7 +390,7 @@ export interface Assistant {
 
 export interface UpdateAssistantDTO {
   /** This is the OpenAI model that will be used. */
-  model?: "gpt-4-32k" | "gpt-4" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo";
+  model?: "gpt-4" | "gpt-3.5-turbo";
   /**
    * This is the voice that will be used.
    *
@@ -401,19 +443,36 @@ export interface UpdateAssistantDTO {
    * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
    */
   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..." }
+   * ```
+   */
+  customLlmUrl?: string;
   /** 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 280
+   * @maxLength 400
    */
   firstMessage?: string;
-  /** This sets whether calls are recorded for the assistant. */
+  /**
+   * This is the message that the assistant will say if the call is forwarded to voicemail.
+   *
+   * If unspecified, it will hang up.
+   * @maxLength 400
+   */
+  voicemailMessage?: string;
+  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
+  interruptionsEnabled?: boolean;
+  /** This sets whether calls are recorded for the assistant. Defaults to true. */
   recordingEnabled?: boolean;
-  /** This sets whether assistant leaves voicemails when call is not picked up. */
-  voicemailEnabled?: boolean;
 }
 
 export interface BuyPhoneNumberDTO {
@@ -544,7 +603,7 @@ export enum ContentType {
 }
 
 export class HttpClient<SecurityDataType = unknown> {
-  public baseUrl: string = "";
+  public baseUrl: string = "https://api.vapi.ai";
   private securityData: SecurityDataType | null = null;
   private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
   private abortControllers = new Map<CancelToken, AbortController>();
@@ -711,9 +770,10 @@ export class HttpClient<SecurityDataType = unknown> {
 /**
  * @title Vapi API
  * @version 1.0
+ * @baseUrl https://api.vapi.ai
  * @contact
  *
- * API for making voice assistants
+ * API for building voice assistants
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
   call = {

package/dist/api.d.ts

@@ -1,6 +1,11 @@
-export interface OpenAIFunctionParamaters {
-    type: string;
-    properties: object;
+export interface OpenAIFunctionParameterProperty {
+    type: "string" | "number" | "boolean";
+    enum?: string[];
+    description?: string;
+}
+export interface OpenAIFunctionParameters {
+    type: "object";
+    properties: Record<string, OpenAIFunctionParameterProperty>;
     required?: string[];
 }
 export interface OpenAIFunction {
@@ -11,6 +16,8 @@ export interface OpenAIFunction {
      * @maxLength 64
      */
     name: string;
+    /** Setting async: true will cause the function to be called asynchronously, meaning that the Assistant will not wait for the function to return before continuing. */
+    async?: boolean;
     /** This is the description of what the function does, used by the AI to choose when and how to call the function. */
     description?: string;
     /**
@@ -20,11 +27,11 @@ export interface OpenAIFunction {
      *
      * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.
      */
-    parameters: OpenAIFunctionParamaters;
+    parameters: OpenAIFunctionParameters;
 }
 export interface CreateAssistantDTO {
     /** This is the OpenAI model that will be used. */
-    model?: "gpt-4-32k" | "gpt-4" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo";
+    model?: "gpt-4" | "gpt-3.5-turbo";
     /**
      * This is the voice that will be used.
      *
@@ -48,19 +55,36 @@ export interface CreateAssistantDTO {
      * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
      */
     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..." }
+     * ```
+     */
+    customLlmUrl?: string;
     /** 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 280
+     * @maxLength 400
      */
     firstMessage?: string;
-    /** This sets whether calls are recorded for the assistant. */
+    /**
+     * This is the message that the assistant will say if the call is forwarded to voicemail.
+     *
+     * If unspecified, it will hang up.
+     * @maxLength 400
+     */
+    voicemailMessage?: string;
+    /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
+    interruptionsEnabled?: boolean;
+    /** This sets whether calls are recorded for the assistant. Defaults to true. */
     recordingEnabled?: boolean;
-    /** This sets whether assistant leaves voicemails when call is not picked up. */
-    voicemailEnabled?: boolean;
 }
 export interface CreateCustomerDTO {
     /** This is the number of the customer. */
@@ -216,7 +240,7 @@ export interface CreateWebCallDTO {
 }
 export interface Assistant {
     /** This is the OpenAI model that will be used. */
-    model?: "gpt-4-32k" | "gpt-4" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo";
+    model?: "gpt-4" | "gpt-3.5-turbo";
     /**
      * This is the voice that will be used.
      *
@@ -240,19 +264,36 @@ export interface Assistant {
      * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
      */
     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..." }
+     * ```
+     */
+    customLlmUrl?: string;
     /** 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 280
+     * @maxLength 400
      */
     firstMessage?: string;
-    /** This sets whether calls are recorded for the assistant. */
+    /**
+     * This is the message that the assistant will say if the call is forwarded to voicemail.
+     *
+     * If unspecified, it will hang up.
+     * @maxLength 400
+     */
+    voicemailMessage?: string;
+    /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
+    interruptionsEnabled?: boolean;
+    /** This sets whether calls are recorded for the assistant. Defaults to true. */
     recordingEnabled?: boolean;
-    /** This sets whether assistant leaves voicemails when call is not picked up. */
-    voicemailEnabled?: boolean;
     /** This is the unique identifier for the assistant. */
     id: string;
     /** This is the unique identifier for the org that this assistant belongs to. */
@@ -270,7 +311,7 @@ export interface Assistant {
 }
 export interface UpdateAssistantDTO {
     /** This is the OpenAI model that will be used. */
-    model?: "gpt-4-32k" | "gpt-4" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo";
+    model?: "gpt-4" | "gpt-3.5-turbo";
     /**
      * This is the voice that will be used.
      *
@@ -294,19 +335,36 @@ export interface UpdateAssistantDTO {
      * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
      */
     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..." }
+     * ```
+     */
+    customLlmUrl?: string;
     /** 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 280
+     * @maxLength 400
      */
     firstMessage?: string;
-    /** This sets whether calls are recorded for the assistant. */
+    /**
+     * This is the message that the assistant will say if the call is forwarded to voicemail.
+     *
+     * If unspecified, it will hang up.
+     * @maxLength 400
+     */
+    voicemailMessage?: string;
+    /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
+    interruptionsEnabled?: boolean;
+    /** This sets whether calls are recorded for the assistant. Defaults to true. */
     recordingEnabled?: boolean;
-    /** This sets whether assistant leaves voicemails when call is not picked up. */
-    voicemailEnabled?: boolean;
 }
 export interface BuyPhoneNumberDTO {
     /**
@@ -448,9 +506,10 @@ export declare class HttpClient<SecurityDataType = unknown> {
 /**
  * @title Vapi API
  * @version 1.0
+ * @baseUrl https://api.vapi.ai
  * @contact
  *
- * API for making voice assistants
+ * API for building voice assistants
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
     call: {

package/dist/api.js

@@ -40,7 +40,7 @@ var ContentType;
 })(ContentType || (exports.ContentType = ContentType = {}));
 class HttpClient {
     constructor(apiConfig = {}) {
-        this.baseUrl = "";
+        this.baseUrl = "https://api.vapi.ai";
         this.securityData = null;
         this.abortControllers = new Map();
         this.customFetch = (...fetchParams) => fetch(...fetchParams);
@@ -156,9 +156,10 @@ exports.HttpClient = HttpClient;
 /**
  * @title Vapi API
  * @version 1.0
+ * @baseUrl https://api.vapi.ai
  * @contact
  *
- * API for making voice assistants
+ * API for building voice assistants
  */
 class Api extends HttpClient {
     constructor() {

package/package.json

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