The Classify API has been deprecated on Feb 28, 2025.
Recommended alternative: Update to the 1.3 version of the API and use the Pegasus video understanding model to classify videos.
Resources: Migration guide > Use Pegasus to classify videos.
Use this method to classify all the videos in the specified index based on the entities or actions shown in those videos. Note that this endpoint returns the first page or results. To retrieve the rest of the pages, you must call the GET
method of the /classify/{page_token}
endpoint passing it the token that identifies the page you want to retrieve.
The unique identifier of the index that you want to classify.
An array that specifies the sources of information the platform uses when it categorizes a video. For details, see the Search options page.
Specifies the type of match the platform will perform. The following values are supported: semantic
and exact_match
. For details, see the Conversation option page.
Default: semantic
An array of objects containing the names and the definitions of entities or actions that the platform must identify.
The number of items to return on each page.
Default: 10 Min: 1 Max: 50
When this parameter is set to true
, the platform will return detailed information about each matching video clip.
Default: false
Use this parameter to filter on the level of confidence that the results match your prompts.
Min: 0 Max: 100 Default: 75
Set this parameter to true
to specify that the platform should return a detailed score for each matching video clip. A detailed score contains the following information:
The videos in the specified index have successfully been classified.
An array that contains the response.