Audio Sounds Search

POST

https://api.coactive.ai/api/v1/search/audio-sound

POST

/api/v1/search/audio-sound

$ curl -X POST https://api.coactive.ai/api/v1/search/audio-sound \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "dataset_id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
>   "audio_class": "Music"
> }'

1 {
2   "data": [
3     {
4       "coactive_image_id": "a3f9b1d2-7c4e-4f8a-9b2d-5e6f7a8c9d0e",
5       "video": {
6         "created_user_id": "admin_user_01",
7         "created_dt": "2023-11-05T10:22:33.123456",
8         "updated_user_id": "editor_user_02",
9         "updated_dt": "2024-04-12T08:15:47.654321",
10         "coactive_video_id": "5cf18348-8336-4db7-bb35-db7fbfe8951d",
11         "path": "s3://media-videos/season1/episode3/the_boys_episode3.mp4",
12         "metadata": {
13           "episode": 3,
14           "season": 1,
15           "show": "The Boys",
16           "title": "The Name of the Game"
17         }
18       },
19       "start_time_ms": 45000,
20       "end_time_ms": 60000,
21       "score": 0.95,
22       "timestamp": 45000,
23       "moderation_score": 2.3
24     },
25     {
26       "coactive_image_id": "b7d2c3e4-1f5a-4b6c-8d9e-0f1a2b3c4d5e",
27       "video": {
28         "created_user_id": "admin_user_01",
29         "created_dt": "2023-11-05T10:22:33.123456",
30         "updated_user_id": "editor_user_02",
31         "updated_dt": "2024-04-12T08:15:47.654321",
32         "coactive_video_id": "5cf18348-8336-4db7-bb35-db7fbfe8951d",
33         "path": "s3://media-videos/season1/episode3/the_boys_episode3.mp4",
34         "metadata": {
35           "episode": 3,
36           "season": 1,
37           "show": "The Boys",
38           "title": "The Name of the Game"
39         }
40       },
41       "start_time_ms": 120000,
42       "end_time_ms": 135000,
43       "score": 0.89,
44       "timestamp": 120000,
45       "moderation_score": 1.8
46     }
47   ]
48 }

Find video segments containing a specific audio sound class, for example, Music, Dog, gunfire, or clapping.Returns ranked segments with timestamps and a confidence score.

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

audio_classenumRequired

The audio class 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

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.

skip_moderationbooleanOptionalDefaults to false

Skip content moderation if enabled

Response

Successful Response

datalist of objects

List of audio chunks

Errors

422

Unprocessable Entity Error