Search

Search dataset

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

Query parameters

querystringOptional
The search query
dataset_idstringRequired
The id of the dataset to search
encoderstringOptional
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

Response

This endpoint returns an object
meta
object
Metadata for the set of data returned
data
list of unions
The paginated results
GET
1curl -G https://app.coactive.ai/api/v1/search \
2     -H "Authorization: Bearer <token>" \
3     -d dataset_id=string
200
Retrieved
1{
2  "meta": {
3    "page": {
4      "currentPage": 1,
5      "limit": 10,
6      "offset": 0,
7      "lastPage": 1,
8      "total": 100
9    },
10    "links": {
11      "next": "/api/list?limit=10&offset=10",
12      "first": "/api/list?limit=10&offset=0",
13      "last": "/api/list?limit=10&offset=90"
14    },
15    "sort": [
16      {
17        "direction": "asc",
18        "field": "name"
19      }
20    ]
21  },
22  "data": [
23    {
24      "createdUserId": "user_example",
25      "createdDt": "2018-09-11T15:11:45.456777",
26      "updatedUserId": "user_example",
27      "updatedDt": "2018-09-11T15:11:45.456777",
28      "coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
29      "path": "s3://your-s3-bucket/path/to/video.mp4",
30      "id": "some-id",
31      "metadata": {
32        "artist": "Marc Simonetti"
33      }
34    }
35  ]
36}
Built with