The Resources.EmbedTask class provides methods to create embeddings for your videos.

To create video embeddings:

1. Create a video embedding task that uploads and processes a video.
2. Monitor the status of your task.
3. Retrieve the embeddings once the task is completed.

Methods

Create a video embedding task

Description: This method creates a new video embedding task that uploads a video to the platform.

Function signature and example:

1
create(
2
  request: TwelvelabsApi.embed.TasksCreateRequest,
3
  requestOptions?: Tasks.RequestOptions
4
): core.HttpResponsePromise<TwelvelabsApi.embed.TasksCreateResponse>

Parameters:

Return value: Returns a Promise that resolves to a TasksCreateResponse object representing the new video embedding task.

The TasksCreateResponse interface contains the following properties:

API Reference: Create a video embedding task.

Related guide: Create video embeddings.

Retrieve the status of a video embedding task

Description: This method retrieves the status of a video embedding task.

Function signature and example:

1
status(
2
  taskId: string,
3
  requestOptions?: Tasks.RequestOptions
4
): core.HttpResponsePromise<TwelvelabsApi.embed.TasksStatusResponse>

Return value: Returns a Promise that resolves to a TasksStatusResponse object containing the current status of the embedding task.

The TasksStatusResponse interface contains the following properties:

The TasksStatusResponseVideoEmbedding interface contains the following properties:

The VideoEmbeddingMetadata interface extends BaseEmbeddingMetadata and contains the following properties:

API Reference: Retrieve the status of a video embedding task.

Related guide: Create video embeddings.

Wait for a video embedding task to complete

Description: This method waits until a video embedding task is completed by periodically checking its status. If you provide a callback function, it calls the function after each status update with the current task object, allowing you to monitor progress.

Function signature and example:

1
waitForDone(
2
  taskId: string,
3
  options?: {
4
    sleepInterval?: number;
5
    callback?: (task: TwelvelabsApi.embed.TasksStatusResponse) => void | Promise<void>;
6
  },
7
  requestOptions?: Tasks.RequestOptions
8
): Promise<TwelvelabsApi.embed.TasksStatusResponse>

Parameters

Return value: Returns a Promise that resolves to a TasksStatusResponse object containing the status of your completed task. See the Retrieve the status of a video embedding task section above for complete property details.

Retrieve video embeddings

Description: This method retrieves embeddings for a specific video embedding task. Ensure the task status is ready before retrieving your embeddings.

Function signature and example:

1
retrieve(
2
  taskId: string,
3
  request?: TwelvelabsApi.embed.TasksRetrieveRequest,
4
  requestOptions?: Tasks.RequestOptions
5
): core.HttpResponsePromise<TwelvelabsApi.embed.TasksRetrieveResponse>

Parameters:

Return value: Returns a Promise that resolves to a TasksRetrieveResponse object containing your embeddings.

The TasksRetrieveResponse interface contains the following properties:

The TasksRetrieveResponseVideoEmbedding interface contains the following properties:

The VideoEmbeddingMetadata interface extends BaseEmbeddingMetadata and contains the following properties:

The VideoSegment interface extends AudioSegment and contains the following properties:

API Reference: Retrieve video embeddings.

Related guide: Create video embeddings.

Error codes

This section lists the most common error messages you may encounter while creating video embeddings.

• parameter_invalid
  • The video_clip_length parameter is invalid. video_clip_length should be within 2-10 seconds long
  • The video_end_offset_sec parameter is invalid. video_end_offset_sec should be greater than video_start_offset_sec