Create category

POST

Create a new category

Request

This endpoint expects an object.

namestringRequired

The category name

datasetIdslist of stringsRequired

The dataset ids to create the category

Response

This endpoint returns an object.

createdUserIdstring

The user that created the resource

createdDtdatetime

The created datetime of the resource

updatedUserIdstring

The user that last updated the resource

updatedDtdatetime

The datetime the resource was last updated

categoryIdstring

The unique identifier for the category

namestring

The name of the category

probabilityTablePathsmap from strings to any

The category probability table paths

datasetslist of objects

The datasets containing the category

dynamicTagslist of objectsOptional

The dynamic tags within the category

POST

1 curl -X POST https://app.coactive.ai/api/v1/dynamic-tag-categories \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "Dog",
6   "datasetIds": [
7     "c40276f0-024b-4a3f-b3e6-dcf0d304843e"
8   ]
9 }'

200Successful

1 {
2   "createdUserId": "user_example",
3   "createdDt": "2018-09-11T15:11:45Z",
4   "updatedUserId": "user_example",
5   "updatedDt": "2018-09-11T15:11:45Z",
6   "categoryId": "ded20be8-683f-4c64-b5e3-cff6074d290f",
7   "name": "Dog",
8   "probabilityTablePaths": {
9     "category_audio_table_path": "/path/to/the/table",
10     "category_visual_table_path": "/path/to/the/table"
11   },
12   "datasets": [
13     {
14       "id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
15       "name": "GameOfThrones"
16     }
17   ],
18   "dynamicTags": [
19     {
20       "id": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
21       "name": "Bulldog"
22     }
23   ]
24 }

Built with

1	curl -X POST https://app.coactive.ai/api/v1/dynamic-tag-categories \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Dog",
6	"datasetIds": [
7	"c40276f0-024b-4a3f-b3e6-dcf0d304843e"
8	]
9	}'

1	{
2	"createdUserId": "user_example",
3	"createdDt": "2018-09-11T15:11:45Z",
4	"updatedUserId": "user_example",
5	"updatedDt": "2018-09-11T15:11:45Z",
6	"categoryId": "ded20be8-683f-4c64-b5e3-cff6074d290f",
7	"name": "Dog",
8	"probabilityTablePaths": {
9	"category_audio_table_path": "/path/to/the/table",
10	"category_visual_table_path": "/path/to/the/table"
11	},
12	"datasets": [
13	{
14	"id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
15	"name": "GameOfThrones"
16	}
17	],
18	"dynamicTags": [
19	{
20	"id": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
21	"name": "Bulldog"
22	}
23	]
24	}