Search dataset

GET

Perform a visual and audio search of a dataset using a natural language (text) query

Query parameters

querystringOptional

The search query

queriesstringOptional

The list of text query strings to include in the natural_language_query

coactive_image_idsstringOptional

The list of coactive image ids to include in the natural_language_query

dataset_idstringRequired

The id of the dataset to search

encoderenumOptional

The encoder to use to search within this dataset.Only applicable if dataset has multiple embeddings.Will use default dataset embedding if None.

concept_idsstringOptional

The ids of the concepts to include in the natural_language_query

offsetintegerOptional

Starting index to return

limitintegerOptional

Max number of items to return

metadata_filtersstringOptional

JSON string containing a list of metadata filters

asset_typeenumOptional

Asset type to filter by

Allowed values: imagevideokeyframe

search_typeenumOptional

Search type to use

Allowed values: visualimagevideoaudio

Response

This endpoint returns an object.

metaobject

Metadata for the set of data returned

datalist of objects

The paginated results

GET

1 curl -G https://app.coactive.ai/api/v1/search \
2      -H "Authorization: Bearer <token>" \
3      -d dataset_id=dataset_id

200Retrieved

1 {
2   "meta": {
3     "page": {
4       "currentPage": 1,
5       "limit": 10,
6       "offset": 0,
7       "lastPage": 10,
8       "total": 100
9     },
10     "links": {
11       "prev": "prev",
12       "next": "/api/list?limit=10&offset=10",
13       "first": "/api/list?limit=10&offset=0",
14       "last": "/api/list?limit=10&offset=90"
15     },
16     "sort": [
17       {
18         "direction": "asc",
19         "field": "name"
20       }
21     ]
22   },
23   "data": [
24     {
25       "createdUserId": "user_example",
26       "createdDt": "2018-09-11T15:11:45Z",
27       "updatedUserId": "user_example",
28       "updatedDt": "2018-09-11T15:11:45Z",
29       "coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
30       "path": "s3://your-s3-bucket/path/to/video.mp4",
31       "id": "some-id",
32       "metadata": {
33         "artist": "Marc Simonetti"
34       }
35     }
36   ]
37 }

Built with

1	curl -G https://app.coactive.ai/api/v1/search \
2	-H "Authorization: Bearer <token>" \
3	-d dataset_id=dataset_id

1	{
2	"meta": {
3	"page": {
4	"currentPage": 1,
5	"limit": 10,
6	"offset": 0,
7	"lastPage": 10,
8	"total": 100
9	},
10	"links": {
11	"prev": "prev",
12	"next": "/api/list?limit=10&offset=10",
13	"first": "/api/list?limit=10&offset=0",
14	"last": "/api/list?limit=10&offset=90"
15	},
16	"sort": [
17	{
18	"direction": "asc",
19	"field": "name"
20	}
21	]
22	},
23	"data": [
24	{
25	"createdUserId": "user_example",
26	"createdDt": "2018-09-11T15:11:45Z",
27	"updatedUserId": "user_example",
28	"updatedDt": "2018-09-11T15:11:45Z",
29	"coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
30	"path": "s3://your-s3-bucket/path/to/video.mp4",
31	"id": "some-id",
32	"metadata": {
33	"artist": "Marc Simonetti"
34	}
35	}
36	]
37	}