Search

Get similar images in dataset

GET
Get the images most similar to the image provided within the same dataset

Query parameters

image_public_urlstringOptional
A public url to an image not in this dataset to use for similarity search
coactive_image_idstringOptional
A coactive image id in this dataset to use for similarity search
image_pathstringOptional
An image path in this dataset to use for similarity search
dataset_idstringRequired
The unique identifier for the dataset
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
$curl -G https://app.coactive.ai/api/v1/search/similar-images \
> -H "Authorization: Bearer <token>" \
> -d dataset_id=string
Response
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}