Get Detailed Video Search By Id | Coactive AI

import requests
url = "https://api.coactive.ai/api/v1/search/video"
querystring = {"dataset_id":"12345678-abcd-90ef-1234-56789abcdef0","text_query":"President speaking at a podium","video_id":"b8b2b7a6-7d2a-4a0c-8c7a-93b0b2a3e111","composite_type":"shot"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "dataset_id": "12345678-abcd-90ef-1234-56789abcdef0",
  "text_query": "President speaking at a podium",
  "video_id": "b8b2b7a6-7d2a-4a0c-8c7a-93b0b2a3e111",
  "composite_type": "shot",
  "slices": [
    {
      "id": "5f7f9c4a-2a4f-4f4e-bf3b-5b6e8f6de001",
      "index": 3,
      "start_frame_num": 1530,
      "end_frame_num": 2100,
      "start_time_ms": 51000,
      "end_time_ms": 70000,
      "composite_id": "4b0a3c9f-5f2d-4b1e-8b0a-0a9f4b1e2c33",
      "composite_type": "shot",
      "composite_slice_score": 0.24
    }
  ],
  "source_path": "s3://demo-bucket/videos/2024/clip_001.mp4"
}

Given a video_id and text_query, this returns the relevant composites in that video with start and end timestamps plus relevance scores. Call it after the POST v1/search/video endpoint to list all matching moments for the selected video.

Note: This works only for videos ingested with Coactive’s new video data model. If you’re unsure or want to try it, contact Coactive Support.

Authentication

AuthorizationBearer

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

Query parameters

dataset_idstringRequired

text_querystringRequired

video_idstringRequired

composite_typestringRequired

limitintegerOptionalDefaults to 10

Response

Successful Response

dataset_idstringformat: "uuid"

text_querystring

video_idstring

composite_typestring

sliceslist of objects

source_pathstring or null

Authentication

Query parameters

Response

Errors