Use this endpoint to search for relevant matches in an index using text or various media formats

This parameter specifies the strictness of the thresholds for assigning the high, medium, or low confidence levels to search results

Specifies the type of match the platform performs

A stringified version of an object that specifies the criteria for filtering the search results

Use this parameter to group or ungroup items in a response

The unique identifier of the index to search

When you perform a search specifying multiple sources of information, you can use the this parameter to broaden or narrow your search

The number of items to return on each page

The media you wish to use as a local file

The publicly accessible URL of the media file you wish to use

An array that specifies the sources of information the platform uses when performing a search

Use this parameter to specify the sort order for the response

Use this parameter to filter on the level of confidence that the results match your query

Use this endpoint to retrieve a specific page of search results

A token that identifies the page to retrieve

page-token

Retrieve a specific page of search results

Use this method to classify a set of videos based on the entities or actions shown in those videos

An array of objects containing the names and the definitions of entities or actions that the platform must identify

Specifies the type of match the platform will perform

When this parameter is set to true, the platform will return detailed information about each matching video clip

An array that specifies the sources of information the platform uses when it categorizes a video

Set this parameter to true to specify that the platform should return a detailed score for each matching video clip

An object that allows you to filter the results

An array containing the unique identifiers of the videos that you want to classify

Use this method to classify all the videos in the specified index based on the entities or actions shown in those videos

The unique identifier of the index that you want to classify

You can use this endpoint to retrieve the rest of the pages

This method lists all the engines that are available in your account

engine-id

This endpoint generates concise overviews in the form of titles, topics, and hashtags representing the key elements or themes of a video

An array specifying the type of text the platform must generate

The unique identifier of the video for which you want to generate a gist

This endpoint generates summaries, chapters, or highlights for your videos

Use this field to provide context for the summarization task, such as the target audience, style, tone of voice, and purpose

Controls the randomness of the text output generated by the model

The unique identifier of the video that you want to summarize

This endpoint generates open-ended texts based on your videos, including but not limited to tables of content, action items, memos, and detailed analyses

A prompt that guides the model on the desired format or content

The unique identifier of the video for which you wish to generate a text

An array that specifies the video understanding engines

This method returns a list of the indexes in your account

A number that identifies the page to retrieve

page

page_limit

sort_by

sort_option

Filter by the unique identifier of an index

index_name

engine_options

index_options

This method retrieves details about the specified index

Unique identifier of the index to retrieve

index-id

This method updates the name of the specified index

This method deletes the specified index and all the videos within it

This method returns a list of the videos in the specified index

The unique identifier of the index for which the API will retrieve the videos

Filter by the unique identifier of a video index

filename

duration

width

height

size

Filter by the date and time, in the RFC 3339 format, that the video indexing task was created

created_at

Filter by the date and time, in the RFC 3339 format, that the video indexing task was updated

updated_at

Filter by the date and time, in the RFC 3339 format, that the video has finished indexing

indexed_at

To enable filtering by custom fields, first add metadata to your video by calling the `PUT method of the /indexes/:index-id/videos/:video-id endpoint

metadata

This method retrieves information about the specified video

The unique identifier of the index to which the video has been uploaded

The unique identifier of the video to update

video-id

Use this method to update the title and the metadata of a video

This method deletes all the information about the specified video

x-api-key

Content-Type

This method retrieves a transcription of the spoken words

The start of the time range (in seconds) to retrieve transcription for

start

The end of the time range (in seconds) to retrieve transcription for

This method retrieves text recognized in video (OCR)

Use this method to identify the presence of brand logos within your videos

To use this feature, you must enable thumbnail generation for the index to which the video has been uploaded

Specifies the time, in seconds, at which the platform must retrieve the thumbnai

time

Use this method to create a new video indexing task that uploads a video to the platform and makes it searchable

This parameter indicates if the platform stores the video for streaming. When set to false, the platform stores the video, and you can retrieve its URL by calling the GET

The unique identifier of the index to which the video is being uploaded

A boolean value specifying whether or not you provide a transcription for this video

When the provide_transcription parameter is set to true, and you want to provide a transcription from the local file system, use the transcription_file parameter to pass your transcription file to the platform

When the provide_transcription parameter is set to true, and you want to provide a transcription from a publicly accessible URL

Specify this parameter to upload a video from your local file system

Specify this parameter to upload a video from a publicly accessible URL

This method returns a list of the video indexing tasks in your account

Filter by the unique identifier of a video indexing task

index_id

Filter by the date and time, in the RFC 3339 format, that the video indexing task is ready to be searched

estimated_time

This method retrieves a video indexing task

The unique identifier of the video indexing task to retrieve

task_id

This method retrieves the number video indexing tasks in each status for the specified index

The unique identifier of the index for which you want to retrieve the number video indexing tasks in each status

Use this endpoint to upload videos from external providers

The URL of the video that you wish to upload

This method makes a cloud-to-cloud transfer

A JSON file that contains a list. Each element of the list is an object representing a file to be uploaded and indexed

The text for which you want to create an embedding

Specifies how the platform truncates text that exceeds 77 tokens to fit the maximum length allowed for an embedding

For string fields, the filter parameter returns only the results that equal the value you specify

An array that specifies the sources of information the platform uses when performing a search. For details

Use this method to search for relevant matches in an index using combined queries

Use this parameter to filter your search results by metadata

Use the query parameter to build combined queries

Retrieve a specific page of combined search results

This method creates a new video embedding task

The desired duration in seconds for each clip for which the platform generates an embedding

Defines the scope of the video embedding generation

The end offset in seconds from the beginning of the video where processing should stop

The start offset in seconds from the beginning of the video where processing should begin

This method retrieves the status of a video embedding task

The unique identifier of your video embedding task

Retrieve the status of a video embedding task

This method retrieves embeddings for a specific video embedding task

Twelve Labs

Pre-configured, Predictable, Single Interface, Ready-to-use, Opinionated & Managed API Explorer & Server. Bring your API credentials, configure and access your 3rd party APIs. Using LowCodeAPI securely manage all integrations in one place.