The Resources.Video class provides methods to manage the videos you’ve uploaded to the platform.

Methods

Retrieve video information

Description: This method retrieves information about the specified video.

Function signature and example:

1 async retrieve(
2   indexId: string,
3   id: string,
4   { embed }: RetrieveVideoParams = {},
5   options: RequestOptions = {},
6 ): Promise<Models.Video>

Parameters:

Name	Type	Required	Description
`indexId`	`string`	Yes	The unique identifier of the index to which the video has been uploaded.
`id`	`string`	Yes	The unique identifier of the video to retrieve.
`embed`	`RetrieveVideoParams`	No	Set this parameter to `true` to retrieve the video embedding in the response.
`options`	`RequestOptions`	No	Additional options for the request. Defaults to `{}`.

Return value: Returns a Promise that resolves to a Models.Video instance.

API Reference: For a description of each field in the request and response, see the Retrieve video information page.

Description: This method returns a paginated list of the videos in the specified index based on the provided parameters. Choose this method mainly when the total number of items is manageable, or you must fetch a single page of results. By default, the platform returns your videos sorted by their upload date, with the newest at the top of the list.

Function signature and example:

1 async list(
2   indexId: string,
3   {
4     id,
5     size,
6     width,
7     height,
8     duration,
9     fps,
10     createdAt,
11     updatedAt,
12     ...restParams
13   }: ListVideoParams = {},
14   options: RequestOptions = {},
15 ): Promise<Models.Video[]>

Parameters:

Name	Type	Required	Description
`indexId`	`string`	Yes	The unique identifier of the index to which the video has been uploaded.
`params`	`ListVideoParams`	No	Parameters for retrieving the list of videos. Defaults to `{}`. If you don’t specify the `page` parameter, the platform returns the first page of results.
`options`	`RequestOptions`	No	Additional options for the request. Defaults to `{}`.

The ListVideoParams interface extends the PageOptions interface and defines the parameters for listing videos:

Name	Type	Required	Description
`id`	`string`	No	Filter by the unique identifier of a video.
`filename`	`string`	No	Filter by filename.
`size`	`number \| Record<string, number>`	No	Filter by the size of the video file. This field can be a specific number or an object for range queries.
`width`	`number \| Record<string, number>`	No	Filter by the width of the video. This field can be a specific number or an object for range queries.
`height`	`number \| Record<string, number>`	No	Filter by the height of the video. This field can be a specific number or an object for range queries.
`duration`	`number \| Record<string, number>`	No	Filter by the duration of the video. This field can be a specific number or an object for range queries.
`fps`	`number \| Record<string, number>`	No	Filter by the frames per second of the video. This field can be a specific number or an object for range queries.
`userMetadata`	`Record<string, any>`	No	Filter by metadata associated with the video. This field can contain any key-value pairs.
`createdAt`	`string \| Record<string, string>`	No	Filter by the creation date of the video. This field can be a string or an object for range queries.
`updatedAt`	`string \| Record<string, string>`	No	Filter by the last update date of the video. This field can be a string or an object for range queries.

The following properties are inherited from the PageOptions interface:

Name	Type	Required	Description
`page`	`number`	No	The page number for pagination.
`pageLimit`	`number`	No	The number of items per page.
`sortBy`	`'created_at' \| 'updated_at'`	No	Specifies the field to sort by. This parameter must be either ‘created_at’ or ‘updated_at’.
`sortOption`	`'asc' \| 'desc'`	No	Specifies the sort order. This parameter must be either ‘asc’ (ascending) or ‘desc’ (descending).

Return value: Returns a Promise that resolves to an array of Models.Video instances.

API Reference: For a description of each field in the request and response, see the List videos page.

Related guides:

Description: This method iterates through a paginated list of the videos in the specified index based on the provided parameters. Choose this method mainly when your application must retrieve a large number of items. By default, the API returns your videos sorted by creation date, with the newest at the top of the list.

Function signature and example:

1 async listPagination(
2   indexId: string,
3   {
4     id,
5     size,
6     width,
7     height,
8     duration,
9     fps,
10     createdAt,
11     updatedAt,
12     ...restParams
13   }: ListVideoParams = {},
14   options: RequestOptions = {},
15 ): Promise<Models.VideoListWithPagination>

Parameters:

Name	Type	Required	Description
`params`	`ListVideoParams`	No	Parameters for retrieving the list of videos. Defaults to `{}`. If you don’t specify the `page` parameter, the platform returns the first page of results.
`options`	`RequestOptions`	No	Additional options for the request. Defaults to `{}`.

The ListVideoParams interface extends the PageOptions interface and defines the parameters for listing videos:

Name	Type	Required	Description
`id`	`string`	No	Filter by the unique identifier of a video.
`filename`	`string`	No	Filter by filename.
`size`	`number \| Record<string, number>`	No	Filter by the size of the video file. This field can be a specific number or an object for range queries.
`width`	`number \| Record<string, number>`	No	Filter by the width of the video. This field can be a specific number or an object for range queries.
`height`	`number \| Record<string, number>`	No	Filter by the height of the video. This field can be a specific number or an object for range queries.
`duration`	`number \| Record<string, number>`	No	Filter by the duration of the video. This field can be a specific number or an object for range queries.
`fps`	`number \| Record<string, number>`	No	Filter by the frames per second of the video. This field can be a specific number or an object for range queries.
`userMetadata`	`Record<string, any>`	No	Filter by metadata associated with the video. This field can contain any key-value pairs.
`createdAt`	`string \| Record<string, string>`	No	Filter by the creation date of the video. This field can be a string or an object for range queries.
`updatedAt`	`string \| Record<string, string>`	No	Filter by the last update date of the video. This field can be a string or an object for range queries.

The following properties are inherited from the PageOptions interface:

Name	Type	Required	Description
`page`	`number`	No	The page number for pagination.
`pageLimit`	`number`	No	The number of items per page.
`sortBy`	`'created_at' \| 'updated_at'`	No	Specifies the field to sort by. This parameter must be either ‘created_at’ or ‘updated_at’.
`sortOption`	`'asc' \| 'desc'`	No	Specifies the sort order. This parameter must be either ‘asc’ (ascending) or ‘desc’ (descending).

Return value: Returns a Promise that resolves to an array of VideoListWithPagination instances.

Note

To retrieve subsequent pages of results, use the async iterator protocol:

Invoke the next method of the VideoListWithPagination object.
Repeat this call until the method returns a promise that resolves tonull, indicating no more pages exist.

API Reference: For a description of each field in the request and response, see the List videos page.

Related guides:

Update video information

Description: This method updates the title and the metadata of a video.

Function signature and example:

1 async update(
2   indexId: string,
3   id: string,
4   { userMetadata }: UpdateVideoParams,
5   options: RequestOptions = {},
6 ): Promise<void>

Parameters:

Name	Type	Required	Description
`indexId`	`string`	Yes	The unique identifier of the index to which the video has been uploaded.
`id`	`string`	Yes	The unique identifier of the video.
`params`	`UpdateVideoParams`	Yes	Parameters for updating the video information.
`options`	`RequestOptions`	No	Additional options for the request. Defaults to `{}`.

The UpdateVideoParams interface defines the parameters for updating a video’s information:

Name	Type	Required	Description
`userMetadata`	`Record<string, any>`	No	The metadata you want to update or add.. This parameter can contain any key-value pairs. Note that only the provided properties are modified; the omitted properties remain unchanged.

Return value: Returns a Promise that resolves to void.

API Reference: For a description of each field in the request, see the Update video information page.

Delete video information

Description: This method deletes all the information about the specified video. This action cannot be undone.

Function signature and example:

1 async delete(indexId: string, id: string, options: RequestOptions = {}): Promise<void>

Parameters:

Name	Type	Required	Description
`indexId`	`string`	Yes	The unique identifier of the index to which the video has been uploaded.
`id`	`string`	Yes	The unique identifier of the video to delete.
`options`	`RequestOptions`	No	Additional options for the request. Defaults to `{}`.

Return value: Returns a Promise that resolves to void.

API Reference: Delete video information.

1	async retrieve(
2	indexId: string,
3	id: string,
4	{ embed }: RetrieveVideoParams = {},
5	options: RequestOptions = {},
6	): Promise<Models.Video>

1	async list(
2	indexId: string,
3	{
4	id,
5	size,
6	width,
7	height,
8	duration,
9	fps,
10	createdAt,
11	updatedAt,
12	...restParams
13	}: ListVideoParams = {},
14	options: RequestOptions = {},
15	): Promise<Models.Video[]>

1	async listPagination(
2	indexId: string,
3	{
4	id,
5	size,
6	width,
7	height,
8	duration,
9	fps,
10	createdAt,
11	updatedAt,
12	...restParams
13	}: ListVideoParams = {},
14	options: RequestOptions = {},
15	): Promise<Models.VideoListWithPagination>

1	async update(
2	indexId: string,
3	id: string,
4	{ userMetadata }: UpdateVideoParams,
5	options: RequestOptions = {},
6	): Promise<void>

Methods

Retrieve video information

List videos with direct pagination

List videos with iterative pagination

Note

Update video information

Delete video information