Create dataset

POST

Create a new dataset

Request

This endpoint expects an object.

namestringRequired

The name of the dataset

descriptionstringOptional

The description of the dataset

credentialsIdstringOptional

The id of the default credentials to use to access protected data for this dataset

encoderenumOptional

The default encoder to use to encode assets in this dataset

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

namestring

The name of the dataset

datasetIdstring

The unique identifier for the dataset

statusenum

The status of the dataset

imageCountinteger

The number of fully processed images in the dataset

videoCountinteger

The number of fully processed videos in the dataset

descriptionstringOptional

The description of the dataset

isDeletablebooleanOptional

True if the dataset is in a state in which it can be deleted

encoderenumOptional

The name of the encoder to transform your image and video data

POST

1 curl -X POST https://app.coactive.ai/api/v1/datasets \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "GameOfThrones",
6   "description": "A dataset containing screenshots and clips from the tv show Game of Thrones",
7   "encoder": "multimodal-tx-large3"
8 }'

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   "name": "GameOfThrones",
7   "datasetId": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
8   "status": "Ready",
9   "imageCount": 100,
10   "videoCount": 100,
11   "description": "A dataset containing screenshots and clips from the tv show Game of Thrones",
12   "isDeletable": true,
13   "encoder": "multimodal-tx-large3"
14 }

Built with

1	curl -X POST https://app.coactive.ai/api/v1/datasets \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "GameOfThrones",
6	"description": "A dataset containing screenshots and clips from the tv show Game of Thrones",
7	"encoder": "multimodal-tx-large3"
8	}'

1	{
2	"createdUserId": "user_example",
3	"createdDt": "2018-09-11T15:11:45Z",
4	"updatedUserId": "user_example",
5	"updatedDt": "2018-09-11T15:11:45Z",
6	"name": "GameOfThrones",
7	"datasetId": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
8	"status": "Ready",
9	"imageCount": 100,
10	"videoCount": 100,
11	"description": "A dataset containing screenshots and clips from the tv show Game of Thrones",
12	"isDeletable": true,
13	"encoder": "multimodal-tx-large3"
14	}