@vapi-ai/web 1.2.0 → 1.3.0

package/api.ts

@@ -1811,6 +1811,14 @@ export interface AnalysisPlan {
   structuredDataSchema?: JsonSchema;
 }
 
+export interface ArtifactPlan {
+    /**
+   * This sets whether the video is recorded with Daily. Defaults to false.
+   * @example true
+   */
+    videoRecordingEnabled?: boolean;
+}
+
 export interface CreateAssistantDTO {
   /** These are the options for the assistant's transcriber. */
   transcriber?: DeepgramTranscriber | TalkscriberTranscriber;
@@ -1981,6 +1989,7 @@ export interface CreateAssistantDTO {
    */
   serverUrlSecret?: string;
   analysisPlan?: AnalysisPlan;
+  artifactPlan?: ArtifactPlan;
 }
 
 export interface Assistant {
@@ -2153,6 +2162,7 @@ export interface Assistant {
    */
   serverUrlSecret?: string;
   analysisPlan?: AnalysisPlan;
+  artifactPlan?: ArtifactPlan;
   /** This is the unique identifier for the assistant. */
   id: string;
   /** This is the unique identifier for the org that this assistant belongs to. */
@@ -2339,6 +2349,7 @@ export interface UpdateAssistantDTO {
    */
   serverUrlSecret?: string;
   analysisPlan?: AnalysisPlan;
+  artifactPlan?: ArtifactPlan;
 }
 
 export interface AnalysisCostBreakdown {
@@ -2394,6 +2405,11 @@ export interface Analysis {
   successEvaluation?: string;
 }
 
+export interface Artifact {
+  /** Video recording url if assistant.artifactPlan.videoRecordingEnabled was set to true */
+  videoRecordingUrl?: string;
+}
+
 export interface PhoneCallTwilioDetails {
   statusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
   machineDetection?: 'Enable' | 'DetectMessageEnd';
@@ -2598,6 +2614,7 @@ export interface OverrideAssistantDTO {
    */
   serverUrlSecret?: string;
   analysisPlan?: AnalysisPlan;
+  artifactPlan?: ArtifactPlan;
 }
 
 export interface SquadMemberDTO {
@@ -2803,6 +2820,10 @@ export interface Call {
   stereoRecordingUrl?: string;
   /** This is the analysis of the call. Customize the analysis by setting `assistant.analysisPlan`. */
   analysis?: Analysis;
+  /** This is the artifacts related to the call. Customize the analysis by setting `assistant.artifactPlan`. */
+  artifact?: Artifact;
+  /** This stores a copy of assistant.artifactPlan. */
+  artifactPlan?: ArtifactPlan;
   /** These are the messages that were spoken during the call. */
   messages?: object[];
   /**

package/dist/api.d.ts

@@ -1205,6 +1205,13 @@ export interface AnalysisPlan {
      */
     structuredDataSchema?: JsonSchema;
 }
+export interface ArtifactPlan {
+    /**
+   * This sets whether the video is recorded with Daily. Defaults to false.
+   * @example true
+   */
+    videoRecordingEnabled?: boolean;
+}
 export interface CreateAssistantDTO {
     /** These are the options for the assistant's transcriber. */
     transcriber?: DeepgramTranscriber | TalkscriberTranscriber;
@@ -1337,6 +1344,7 @@ export interface CreateAssistantDTO {
      */
     serverUrlSecret?: string;
     analysisPlan?: AnalysisPlan;
+    artifactPlan?: ArtifactPlan;
 }
 export interface Assistant {
     /** These are the options for the assistant's transcriber. */
@@ -1470,6 +1478,7 @@ export interface Assistant {
      */
     serverUrlSecret?: string;
     analysisPlan?: AnalysisPlan;
+    artifactPlan?: ArtifactPlan;
     /** This is the unique identifier for the assistant. */
     id: string;
     /** This is the unique identifier for the org that this assistant belongs to. */
@@ -1617,6 +1626,7 @@ export interface UpdateAssistantDTO {
      */
     serverUrlSecret?: string;
     analysisPlan?: AnalysisPlan;
+    artifactPlan?: ArtifactPlan;
 }
 export interface AnalysisCostBreakdown {
     /** This is the cost to summarize the call. */
@@ -1668,6 +1678,10 @@ export interface Analysis {
     /** This is the evaluation of the call. Customize by setting `assistant.analysisPlan.successEvaluationPrompt` and/or `assistant.analysisPlan.successEvaluationRubric`. */
     successEvaluation?: string;
 }
+export interface Artifact {
+    /** Video recording url if assistant.artifactPlan.videoRecordingEnabled was set to true */
+    videoRecordingUrl?: string;
+}
 export interface PhoneCallTwilioDetails {
     statusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
     machineDetection?: 'Enable' | 'DetectMessageEnd';
@@ -1833,6 +1847,7 @@ export interface OverrideAssistantDTO {
      */
     serverUrlSecret?: string;
     analysisPlan?: AnalysisPlan;
+    artifactPlan?: ArtifactPlan;
 }
 export interface SquadMemberDTO {
     /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
@@ -1956,6 +1971,10 @@ export interface Call {
     stereoRecordingUrl?: string;
     /** This is the analysis of the call. Customize the analysis by setting `assistant.analysisPlan`. */
     analysis?: Analysis;
+    /** This is the artifacts related to the call. Customize the analysis by setting `assistant.artifactPlan`. */
+    artifact?: Artifact;
+    /** This stores a copy of assistant.artifactPlan. */
+    artifactPlan?: ArtifactPlan;
     /** These are the messages that were spoken during the call. */
     messages?: object[];
     /**

package/dist/vapi.js

@@ -25,13 +25,13 @@ async function buildAudioPlayer(track, participantId) {
     await startPlayer(player, track);
     return player;
 }
-function subscribeToTracks(e, call) {
+function subscribeToTracks(e, call, isVideoRecordingEnabled) {
     if (e.participant.local)
         return;
     call.updateParticipant(e.participant.session_id, {
         setSubscribedTracks: {
             audio: true,
-            video: false,
+            video: isVideoRecordingEnabled,
         },
     });
 }
@@ -90,13 +90,18 @@ class Vapi extends VapiEventEmitter {
             if (this.call) {
                 this.cleanup();
             }
+            const isVideoRecordingEnabled = webCall?.artifactPlan?.videoRecordingEnabled ??
+                false;
             this.call = daily_js_1.default.createCallObject({
                 audioSource: true,
-                videoSource: false,
+                videoSource: isVideoRecordingEnabled,
             });
             this.call.iframe()?.style.setProperty('display', 'none');
             this.call.on('left-meeting', () => {
                 this.emit('call-end');
+                if (isVideoRecordingEnabled) {
+                    this.call?.stopRecording();
+                }
                 this.cleanup();
             });
             this.call.on('participant-left', (e) => {
@@ -106,6 +111,9 @@ class Vapi extends VapiEventEmitter {
             });
             this.call.on('error', (error) => {
                 this.emit('error', error);
+                if (isVideoRecordingEnabled) {
+                    this.call?.stopRecording();
+                }
             });
             this.call.on('camera-error', (error) => {
                 this.emit('error', error);
@@ -125,12 +133,22 @@ class Vapi extends VapiEventEmitter {
             this.call.on('participant-joined', (e) => {
                 if (!e || !this.call)
                     return;
-                subscribeToTracks(e, this.call);
+                subscribeToTracks(e, this.call, isVideoRecordingEnabled);
             });
             await this.call.join({
                 url: webCall.webCallUrl,
                 subscribeToTracksAutomatically: false,
             });
+            if (isVideoRecordingEnabled) {
+                await this.call.startRecording({
+                    width: 1280,
+                    height: 720,
+                    backgroundColor: '#FF1F2D3D',
+                    layout: {
+                        preset: 'default',
+                    },
+                });
+            }
             this.call.startRemoteParticipantsAudioLevelObserver(100);
             this.call.on('remote-participants-audio-level', (e) => {
                 if (e)

package/package.json

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

package/vapi.ts

@@ -29,13 +29,13 @@ async function buildAudioPlayer(track: any, participantId: string) {
   await startPlayer(player, track);
   return player;
 }
-function subscribeToTracks(e: DailyEventObjectParticipant, call: DailyCall) {
+function subscribeToTracks(e: DailyEventObjectParticipant, call: DailyCall, isVideoRecordingEnabled?: boolean) {
   if (e.participant.local) return;
 
   call.updateParticipant(e.participant.session_id, {
     setSubscribedTracks: {
       audio: true,
-      video: false,
+      video: isVideoRecordingEnabled,
     },
   });
 }
@@ -145,14 +145,21 @@ export default class Vapi extends VapiEventEmitter {
       if (this.call) {
         this.cleanup();
       }
+      const isVideoRecordingEnabled =
+        webCall?.artifactPlan?.videoRecordingEnabled ??
+        false;
+
       this.call = DailyIframe.createCallObject({
         audioSource: true,
-        videoSource: false,
+        videoSource: isVideoRecordingEnabled,
       });
       this.call.iframe()?.style.setProperty('display', 'none');
 
       this.call.on('left-meeting', () => {
         this.emit('call-end');
+        if (isVideoRecordingEnabled) {
+          this.call?.stopRecording();
+        }
         this.cleanup();
       });
 
@@ -163,6 +170,9 @@ export default class Vapi extends VapiEventEmitter {
 
       this.call.on('error', (error: any) => {
         this.emit('error', error);
+        if (isVideoRecordingEnabled) {
+          this.call?.stopRecording();
+        }
       });
 
       this.call.on('camera-error', (error: any) => {
@@ -182,7 +192,7 @@ export default class Vapi extends VapiEventEmitter {
 
       this.call.on('participant-joined', (e) => {
         if (!e || !this.call) return;
-        subscribeToTracks(e, this.call);
+        subscribeToTracks(e, this.call, isVideoRecordingEnabled);
       });
 
       await this.call.join({
@@ -190,6 +200,17 @@ export default class Vapi extends VapiEventEmitter {
         subscribeToTracksAutomatically: false,
       });
 
+      if (isVideoRecordingEnabled) {
+        await this.call.startRecording({
+          width: 1280,
+          height: 720,
+          backgroundColor: '#FF1F2D3D',
+          layout: {
+            preset: 'default',
+          },
+        });
+      }
+
       this.call.startRemoteParticipantsAudioLevelObserver(100);
 
       this.call.on('remote-participants-audio-level', (e) => {