Get labels

GET

Get all labels for a concept

Path parameters

concept_idstringRequired

The unique identifier for the concept

Query parameters

offsetintegerOptional

Starting index to return

limitintegerOptional

Max number of items to return

labels_to_include"positive" or "negative"Optional

List of labels types to include, leave blank to return all

Allowed values: positivenegative

Response

This endpoint returns an object.

metaobject

Metadata for the set of data returned

datalist of objects

The paginated data

GET

1 curl https://app.coactive.ai/api/v1/concepts/concept_id/labels \
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       "labelId": "16d8c6bf-282d-431a-be42-c84ad2e05744",
30       "label": "positive",
31       "image": {
32         "createdUserId": "user_example",
33         "createdDt": "2018-09-11T15:11:45Z",
34         "updatedUserId": "user_example",
35         "updatedDt": "2018-09-11T15:11:45Z",
36         "coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
37         "path": "s3://your-s3-bucket/path/to/video.mp4",
38         "id": "some-id",
39         "metadata": {
40           "artist": "Marc Simonetti"
41         }
42       },
43       "keyframe": {
44         "coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
45         "video": {
46           "createdUserId": "user_example",
47           "createdDt": "2018-09-11T15:11:45Z",
48           "updatedUserId": "user_example",
49           "updatedDt": "2018-09-11T15:11:45Z",
50           "coactiveVideoId": "5cf18348-8336-4db7-bb35-db7fbfe8951d",
51           "path": "s3://your-s3-bucket/path/to/video.mp4",
52           "metadata": {
53             "show": "The Boys",
54             "season": 1,
55             "episode": 1,
56             "title": "The Name of the Game"
57           }
58         },
59         "shot": {
60           "shotId": "5007b9b7-0d74-4054-bbc7-cd9d2333ca8f",
61           "startTimeMs": 0,
62           "endTimeMs": 1000
63         },
64         "audioSegment": {
65           "startTimeMs": 0,
66           "endTimeMs": 1000,
67           "speechToTextTranscription": "Winter is coming."
68         },
69         "timestamp": 1029849493
70       }
71     }
72   ]
73 }

Built with

1	curl https://app.coactive.ai/api/v1/concepts/concept_id/labels \
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	"labelId": "16d8c6bf-282d-431a-be42-c84ad2e05744",
30	"label": "positive",
31	"image": {
32	"createdUserId": "user_example",
33	"createdDt": "2018-09-11T15:11:45Z",
34	"updatedUserId": "user_example",
35	"updatedDt": "2018-09-11T15:11:45Z",
36	"coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
37	"path": "s3://your-s3-bucket/path/to/video.mp4",
38	"id": "some-id",
39	"metadata": {
40	"artist": "Marc Simonetti"
41	}
42	},
43	"keyframe": {
44	"coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
45	"video": {
46	"createdUserId": "user_example",
47	"createdDt": "2018-09-11T15:11:45Z",
48	"updatedUserId": "user_example",
49	"updatedDt": "2018-09-11T15:11:45Z",
50	"coactiveVideoId": "5cf18348-8336-4db7-bb35-db7fbfe8951d",
51	"path": "s3://your-s3-bucket/path/to/video.mp4",
52	"metadata": {
53	"show": "The Boys",
54	"season": 1,
55	"episode": 1,
56	"title": "The Name of the Game"
57	}
58	},
59	"shot": {
60	"shotId": "5007b9b7-0d74-4054-bbc7-cd9d2333ca8f",
61	"startTimeMs": 0,
62	"endTimeMs": 1000
63	},
64	"audioSegment": {
65	"startTimeMs": 0,
66	"endTimeMs": 1000,
67	"speechToTextTranscription": "Winter is coming."
68	},
69	"timestamp": 1029849493
70	}
71	}
72	]
73	}