List categories

GET

Get paginated categories, optionally filtered by datasets

Query parameters

datasetsstringOptional

Datasets to use to filter categories

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 \
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       "categoryId": "ded20be8-683f-4c64-b5e3-cff6074d290f",
30       "name": "Dog",
31       "probabilityTablePaths": {
32         "category_audio_table_path": "/path/to/the/table",
33         "category_visual_table_path": "/path/to/the/table"
34       },
35       "datasets": [
36         {
37           "id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
38           "name": "GameOfThrones"
39         }
40       ],
41       "dynamicTags": [
42         {
43           "id": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
44           "name": "Bulldog"
45         }
46       ]
47     }
48   ]
49 }

Built with

1	curl https://app.coactive.ai/api/v1/dynamic-tag-categories \
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	"categoryId": "ded20be8-683f-4c64-b5e3-cff6074d290f",
30	"name": "Dog",
31	"probabilityTablePaths": {
32	"category_audio_table_path": "/path/to/the/table",
33	"category_visual_table_path": "/path/to/the/table"
34	},
35	"datasets": [
36	{
37	"id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
38	"name": "GameOfThrones"
39	}
40	],
41	"dynamicTags": [
42	{
43	"id": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
44	"name": "Bulldog"
45	}
46	]
47	}
48	]
49	}