Get images

GET

Get images in a dataset

Path parameters

dataset_idstringRequired

The unique identifier for the dataset

Query parameters

offsetintegerOptional

Starting index to return

limitintegerOptional

Max number of items to return

Response

This endpoint returns an object.

metaobject

Metadata for the set of data returned

datalist of objects

The paginated images

GET

1 curl https://app.coactive.ai/api/v1/datasets/dataset_id/images \
2      -H "Authorization: Bearer <token>"

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 https://app.coactive.ai/api/v1/datasets/dataset_id/images \
2	-H "Authorization: Bearer <token>"

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	}