Celebrity Matches Search

POST

https://api.coactive.ai/api/v1/search/celebrity/matches

POST

/api/v1/search/celebrity/matches

$ curl -X POST https://api.coactive.ai/api/v1/search/celebrity/matches \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "dataset_id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
>   "upload_ids": [
>     "a1b2c3d4e5f678901234567890abcdef",
>     "b2c3d4e5f678901234567890abcdefa1",
>     "c3d4e5f678901234567890abcdefa1b2",
>     "d4e5f678901234567890abcdefa1b2c3",
>     "e5f678901234567890abcdefa1b2c3d4",
>     "f678901234567890abcdefa1b2c3d4e5",
>     "678901234567890abcdefa1b2c3d4e5f6",
>     "78901234567890abcdefa1b2c3d4e5f67",
>     "8901234567890abcdefa1b2c3d4e5f678",
>     "901234567890abcdefa1b2c3d4e5f6789",
>     "01234567890abcdefa1b2c3d4e5f67890",
>     "1234567890abcdefa1b2c3d4e5f678901",
>     "234567890abcdefa1b2c3d4e5f6789012",
>     "34567890abcdefa1b2c3d4e5f67890123",
>     "4567890abcdefa1b2c3d4e5f678901234"
>   ]
> }'

1 {
2   "data": [
3     {
4       "keyframe_id": "d9f1e7a2-3c4b-4f5a-8e9d-123456789abc",
5       "score": 0.987,
6       "asset_type": "video_frame",
7       "dataset_id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
8       "video_id": "a1234567-b89c-40de-f123-456789abcdef",
9       "composite_slice_id": "e1f2d3c4-b5a6-7890-1234-56789abcdef0",
10       "moderation_score": 3.5
11     },
12     {
13       "keyframe_id": "a7b8c9d0-e1f2-3456-7890-abcdef123456",
14       "score": 0.876,
15       "asset_type": "video_frame",
16       "dataset_id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
17       "video_id": "b2345678-c90d-41ef-2345-6789abcdef01",
18       "composite_slice_id": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
19       "moderation_score": 2.8
20     },
21     {
22       "keyframe_id": "b1c2d3e4-f5a6-7890-1234-56789abcdef0",
23       "score": 0.765,
24       "asset_type": "video_frame",
25       "dataset_id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
26       "video_id": "c3456789-d01e-52f0-3456-789abcdef012",
27       "composite_slice_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
28       "moderation_score": 4.2
29     }
30   ]
31 }

Find video frames that match a reference set of face images.Provide 15–100 upload IDs of reference images and get back ranked keyframe matches across the dataset’s videos.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

dataset_idstringRequiredformat: "uuid"

The unique identifier for the dataset

upload_idslist of stringsRequired

List of upload IDs to search for celebrity matches (15-100 items)

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

moderation_score_typeenumOptional

Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that.

Response

Successful Response

datalist of objects

Errors

422

Unprocessable Entity Error