API ReferenceAny-to-video search

Retrieve a specific page of search results

Use this endpoint to retrieve a specific page of search results. <Note title="Note"> When you use pagination, you will not be charged for retrieving subsequent pages of results. </Note>

Authentication

x-api-keystring
Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Path parameters

page-tokenstringRequired
A token that identifies the page to retrieve.

Query parameters

include_user_metadatabooleanOptional

Specifies whether to include user-defined metadata in the search results.

Response

Successfully retrieved the specified page of search results.
datalist of objects or null

An array that contains your search results. For each match found, the model returns the following fields:

page_infoobject or null
An object that provides information about pagination.
search_poolobject or null
An object that contains details about the index you queried.

Errors