Text to Keyframes | Coactive AI

Performs a search over all video frames in a dataset

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

dataset_idstringRequiredformat: "uuid"

The unique identifier for the dataset

text_querystringRequired

The text query to search for

offsetintegerOptional0-9223372036854776000Defaults to 0

Starting index to return

limitintegerOptional1-1000Defaults to 100

Max number of items to return

metadata_filtersobject or nullOptional

List of metadata filters to apply to the search

asset_typeenum or nullOptional

The asset type to filter results by. If no asset type is selected the endpoint will search over images and videos

Allowed values:

Successful Response

datalist of objects

422

Unprocessable Entity Error

1	curl -X POST https://api.coactive.ai/api/v1/search/text-to-keyframes \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"dataset_id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
6	"text_query": "Golden Retriever"
7	}'

1	{
2	"data": [
3	{
4	"keyframe_id": "a3f1c9e2-7b4d-4f8a-9c3e-2d5f6b7a8c9d",
5	"score": 0.95,
6	"asset_type": "video",
7	"dataset_id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
8	"video_id": "d1e2f3a4-b5c6-7d8e-9f01-23456789abcd",
9	"composite_slice_id": "e4f5a6b7-c8d9-0e1f-2345-6789abcdef01",
10	"moderation_score": 0.2
11	}
12	]
13	}