Search dataset

1 curl -G https://app.coactive.ai/api/v1/search \ 2 -H "Authorization: Bearer <token>" \ 3 --data-urlencode "query=White walkers" \ 4 --data-urlencode "queries=a dog" \ 5 -d coactive_image_ids=a6894d72-612d-4c20-b4d0-8f3f21c2bb10 \ 6 -d dataset_id=c40276f0-024b-4a3f-b3e6-dcf0d304843e \ 7 -d encoder=multimodal-tx-large3 \ 8 -d concept_ids=428e52cd-7ceb-490c-ae3f-0848c82d8c97 \ 9 -d offset=0 \ 10 -d limit=100 \ 11 --data-urlencode "metadata_filters=[ 12 {"key": "name", "value": "Peter", "operator": "" \ 13 -d asset_type=image \ 14 -d search_type=visual

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

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

Query parameters

querystringOptional

The search query

querieslist of stringsOptional

The list of text query strings to include in the natural_language_query

coactive_image_idslist of stringsOptional

The list of coactive image ids to include in the natural_language_query

dataset_idstringRequiredformat: "uuid4"

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.

Allowed values:

concept_idslist of stringsOptional

The ids of the concepts to include in the natural_language_query

offsetintegerOptional>=0<=9223372036854776000Defaults to 0

Starting index to return

limitintegerOptional>=1<=9223372036854776000Defaults to 100

Max number of items to return

metadata_filtersstringOptional

JSON string containing a list of metadata filters

asset_typeenumOptional

Asset type to filter by

search_typeenumOptional

Search type to use

Allowed values:

Response

Search results

metaobject

Metadata for the set of data returned

datalist of objects

The paginated results

Headers

Query parameters

Response

Errors