Skip to content
/Datasets

Mabyduck API (0.7.5)

API for managing subjective studies on Mabyduck.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://api.mabyduck.com

Datasets

Operations related to datasets.

Operations

List all datasets

Request

Returns a list of datasets belonging to the given project.

Security
ApiKeyAuth
Path
project_idstring^[a-zA-Z0-9]+$required
curl -i -X GET \
  'https://api.mabyduck.com/projects/{project_id}/datasets/' \
  -H 'Authorization: Api-Key <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
idstringrequired
namestring<= 64 charactersrequired

A short name identifying the dataset.

date_createdstring(date-time)read-onlyrequired
date_last_usedstring(date-time)(Last used)read-onlyrequired
is_deletedboolean

The files in this dataset have been deleted.

statusstring
  • draft - Draft
  • processing - Processing
  • ready - Ready
  • error - Error
Enum"draft""processing""ready""error"
]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "date_created": "2019-08-24T14:15:22Z",
    "date_last_used": "2019-08-24T14:15:22Z",
    "is_deleted": true,
    "status": "draft"
  }
]

Create a dataset

Request

Creates a new dataset and returns a signed URL for uploading the dataset file.

Security
ApiKeyAuth
Path
project_idstring^[a-zA-Z0-9]+$required
Body
required
namestring<= 64 charactersrequired

A short name identifying the dataset.

filenamestringwrite-onlyrequired

The name of the zip file that will be uploaded.

retention_daysinteger or null[ -1 .. 2147483647 ]

Number of days to retain this dataset. Use -1 for unlimited retention. Empty means use project default.

# Create an empty dataset
curl -X POST \
    'https://api.mabyduck.com/projects/{project_id}/datasets/' \
    -H 'Authorization: Api-Key <YOUR_TOKEN_HERE>' \
    -H 'Content-Type: application/json' \
    -d '{"name": "Dataset", "filename": "dataset.zip"}'

# Upload dataset file to the returned URL
curl --upload-file 'dataset.zip' {upload_url}

Responses

Bodyapplication/json
idstringread-onlyrequired
namestring<= 64 charactersrequired

A short name identifying the dataset.

upload_urlstring(uri)read-onlyrequired
retention_daysinteger or null[ -1 .. 2147483647 ]

Number of days to retain this dataset. Use -1 for unlimited retention. Empty means use project default.

Response
application/json
{
  "upload_url": "https://mabyduck-temp.s3.nl-ams.scw.cloud/{signed-upload-url}",
  "status_url": "https://api.mabyduck.com/projects/{project_id}/datasets/{dataset_id}/status/"
}

Retrieve a dataset

Request

Returns detailed information for a single dataset identified by dataset_id.

Security
ApiKeyAuth
Path
dataset_idstring^[a-zA-Z0-9]+$required
project_idstring^[a-zA-Z0-9]+$required
curl -i -X GET \
  'https://api.mabyduck.com/projects/{project_id}/datasets/{dataset_id}/' \
  -H 'Authorization: Api-Key <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
idstringrequired
namestring<= 64 charactersrequired

A short name identifying the dataset.

date_createdstring(date-time)read-onlyrequired
date_last_usedstring(date-time)(Last used)read-onlyrequired
is_deletedboolean

The files in this dataset have been deleted.

statusstring
  • draft - Draft
  • processing - Processing
  • ready - Ready
  • error - Error
Enum"draft""processing""ready""error"
stimuliArray of objects(Stimulus)read-onlyrequired
stimuli[].​idintegerread-onlyrequired
stimuli[].​filepathstringrequired
stimuli[].​modifiersany

Parameters of signal processors modifying the stimulus.

stimuli[].​group_idinteger or nullread-onlyrequired
Response
application/json
{
  "id": "string",
  "name": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "date_last_used": "2019-08-24T14:15:22Z",
  "is_deleted": true,
  "status": "draft",
  "stimuli": [
    { … }
  ]
}

Get dataset status

Request

Returns the current status of a dataset, including any error messages if processing failed.

Security
ApiKeyAuth
Path
dataset_idstring^[a-zA-Z0-9]+$required
project_idstring^[a-zA-Z0-9]+$required
curl -i -X GET \
  'https://api.mabyduck.com/projects/{project_id}/datasets/{dataset_id}/status/' \
  -H 'Authorization: Api-Key <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
statusstringread-onlyrequired
  • draft - Draft
  • processing - Processing
  • ready - Ready
  • error - Error
Enum"draft""processing""ready""error"
errorstring or nullread-onlyrequired

Error message if processing failed.

Response
application/json
{
  "status": "draft",
  "error": "string"
}

Experiments

Operations related to experiments.

Operations

Rubrics

Operations related to rubrics and leaderboards.

Operations

Metrics

Operations