Concept

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_includeenumOptional
List of labels types to include, leave blank to return all

Response

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