List dynamic tags

GET

Get paginated dynamic tags, filtered by datasets

Path parameters

category_idstringRequired

The unique identifier for the category

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 categories

GET

1 curl https://app.coactive.ai/api/v1/dynamic-tag-categories/category_id/dynamic-tags \
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       "dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
30       "name": "Husky",
31       "categoryName": "Dog",
32       "datasets": [
33         {
34           "id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
35           "name": "GameOfThrones"
36         }
37       ],
38       "textPrompts": [
39         {
40           "dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
41           "text": "text prompt example"
42         }
43       ],
44       "visualPrompts": [
45         {
46           "assetType": "image",
47           "coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
48           "previewImages": {
49             "thumb": {
50               "url": "/path/to/kingslanding_041711.jpeg?size=thumb"
51             },
52             "small": {
53               "url": "/path/to/kingslanding_041711.jpeg?size=small"
54             },
55             "regular": {
56               "url": "/path/to/kingslanding_041711.jpeg?size=regular"
57             },
58             "full": {
59               "url": "/path/to/kingslanding_041711.jpeg?size=full"
60             }
61           },
62           "createdDt": "2018-09-11T15:11:45Z",
63           "updatedDt": "2018-09-11T15:11:45Z",
64           "dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
65           "path": "s3://coactive-public/logo.png",
66           "video": {
67             "url": "/path/to/kingslanding_041711.jpeg",
68             "id": "5cf18348-8336-4db7-bb35-db7fbfe8951d",
69             "startTimeMs": 0,
70             "endTimeMs": 1000
71           },
72           "shot": {
73             "id": "5007b9b7-0d74-4054-bbc7-cd9d2333ca8f",
74             "startTimeMs": 0,
75             "endTimeMs": 1000
76           },
77           "sensitive": true,
78           "audioSegment": {
79             "startTimeMs": 0,
80             "endTimeMs": 1000,
81             "speechToTextTranscription": "Winter is coming."
82           },
83           "imageId": "some-id",
84           "format": ".jpg",
85           "metadata": {
86             "artist": "Marc Simonetti"
87           }
88         }
89       ]
90     }
91   ]
92 }

Built with

1	curl https://app.coactive.ai/api/v1/dynamic-tag-categories/category_id/dynamic-tags \
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	"dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
30	"name": "Husky",
31	"categoryName": "Dog",
32	"datasets": [
33	{
34	"id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
35	"name": "GameOfThrones"
36	}
37	],
38	"textPrompts": [
39	{
40	"dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
41	"text": "text prompt example"
42	}
43	],
44	"visualPrompts": [
45	{
46	"assetType": "image",
47	"coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
48	"previewImages": {
49	"thumb": {
50	"url": "/path/to/kingslanding_041711.jpeg?size=thumb"
51	},
52	"small": {
53	"url": "/path/to/kingslanding_041711.jpeg?size=small"
54	},
55	"regular": {
56	"url": "/path/to/kingslanding_041711.jpeg?size=regular"
57	},
58	"full": {
59	"url": "/path/to/kingslanding_041711.jpeg?size=full"
60	}
61	},
62	"createdDt": "2018-09-11T15:11:45Z",
63	"updatedDt": "2018-09-11T15:11:45Z",
64	"dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
65	"path": "s3://coactive-public/logo.png",
66	"video": {
67	"url": "/path/to/kingslanding_041711.jpeg",
68	"id": "5cf18348-8336-4db7-bb35-db7fbfe8951d",
69	"startTimeMs": 0,
70	"endTimeMs": 1000
71	},
72	"shot": {
73	"id": "5007b9b7-0d74-4054-bbc7-cd9d2333ca8f",
74	"startTimeMs": 0,
75	"endTimeMs": 1000
76	},
77	"sensitive": true,
78	"audioSegment": {
79	"startTimeMs": 0,
80	"endTimeMs": 1000,
81	"speechToTextTranscription": "Winter is coming."
82	},
83	"imageId": "some-id",
84	"format": ".jpg",
85	"metadata": {
86	"artist": "Marc Simonetti"
87	}
88	}
89	]
90	}
91	]
92	}