v3
latestOpenAPI 3.1.02026-07-3197486526.1 KBsearch
Make any-to-video search requests
Use this endpoint to search for relevant matches in an index using text, media, or a combination of both as your query.
Text queries:
- Use the query_text parameter to specify your query.
Media queries:
- Set the query_media_type parameter to the corresponding media type (example: image).
- Provide up to 10 images by specifying the following parameters multiple times:
- query_media_url: Publicly accessible URL of your media file.
- query_media_file: Local media file. Composed text and media queries:
- Use the query_text parameter for your text query.
- Set query_media_type to image.
- Provide up to 10 images by specifying the query_media_url and query_media_file parameters multiple times.
Entity search (beta):
- To find a specific person in your videos, enclose the unique identifier of the entity you want to find in the query_text parameter.
post/search
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 performed a search request.