Dataset

Create dataset

POST
Create a new dataset

Request

This endpoint expects an object.
name
stringRequired
The name of the dataset
description
stringOptional
The description of the dataset
credentialsId
stringOptional
The id of the default credentials to use to access protected data for this dataset
encoder
stringOptional
The default encoder to use to encode assets in this dataset

Response

This endpoint returns an object
createdUserId
string
The user that created the resource
createdDt
datetime
The created datetime of the resource
updatedUserId
string
The user that last updated the resource
updatedDt
datetime
The datetime the resource was last updated
name
string
The name of the dataset
datasetId
string
The unique identifier for the dataset
status
enum
The status of the dataset
imageCount
integer
The number of fully processed images in the dataset
videoCount
integer
The number of fully processed videos in the dataset
description
stringOptional
The description of the dataset
isDeletable
booleanOptional
True if the dataset is in a state in which it can be deleted
POST
1curl -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 "credentialsId": "382cc760-8e8e-4b97-abab-84438282cb9a",
8 "encoder": "multimodal"
9}'
200
Successful
1{
2 "createdUserId": "user_example",
3 "createdDt": "2018-09-11T15:11:45.456777",
4 "updatedUserId": "user_example",
5 "updatedDt": "2018-09-11T15:11:45.456777",
6 "name": "GameOfThrones",
7 "datasetId": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
8 "status": "Ready",
9 "imageCount": 1,
10 "videoCount": 1,
11 "description": "A dataset containing screenshots and clips from the tv show Game of Thrones",
12 "isDeletable": true
13}