v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
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>
get/search/{page-token}

Path parameters

page-tokenstring required

A token that identifies the page to retrieve.

Query parameters

include_user_metadataboolean

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

Headers

x-api-keystring required

Your API key.

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

Response

Successfully retrieved the specified page of search results.