# Mabyduck API

API for managing subjective studies on Mabyduck.

Version: 0.7.5

## Servers

```
https://api.mabyduck.com
```

## Security

### ApiKeyAuth

Type: http
Scheme: Api-Key

### basicAuth

Type: http
Scheme: basic

### cookieAuth

Type: apiKey
In: cookie
Name: sessionid

## Download OpenAPI description

[Mabyduck API](https://docs.mabyduck.com/_bundle/api/openapi.yaml)

## Datasets

Operations related to datasets.

### List all datasets

 - [GET /projects/{project_id}/datasets/](https://docs.mabyduck.com/api/openapi/datasets/datasets_list.md): Returns a list of datasets belonging to the given project.

### Create a dataset

 - [POST /projects/{project_id}/datasets/](https://docs.mabyduck.com/api/openapi/datasets/datasets_create.md): Creates a new dataset and returns a signed URL for uploading the dataset file.

### Retrieve a dataset

 - [GET /projects/{project_id}/datasets/{dataset_id}/](https://docs.mabyduck.com/api/openapi/datasets/datasets_retrieve.md): Returns detailed information for a single dataset identified by dataset_id.

### Get dataset status

 - [GET /projects/{project_id}/datasets/{dataset_id}/status/](https://docs.mabyduck.com/api/openapi/datasets/datasets_status_retrieve.md): Returns the current status of a dataset, including any error messages if processing failed.

## Experiments

Operations related to experiments.

### List all experiments

 - [GET /projects/{project_id}/experiments/](https://docs.mabyduck.com/api/openapi/experiments/experiments_list.md): Returns a list of experiments belonging to the given project.

### Create an experiment

 - [POST /projects/{project_id}/experiments/](https://docs.mabyduck.com/api/openapi/experiments/experiments_create.md): Creates a new draft experiment with the specified configuration.

### Retrieve an experiment

 - [GET /projects/{project_id}/experiments/{experiment_id}/](https://docs.mabyduck.com/api/openapi/experiments/experiments_retrieve.md): Returns detailed information for a single experiment identified by experiment_id.

### List all jobs

 - [GET /projects/{project_id}/experiments/{experiment_id}/jobs/](https://docs.mabyduck.com/api/openapi/experiments/experiments_jobs_list.md): Returns a list of jobs belonging to the given experiment.

### Create a job

 - [POST /projects/{project_id}/experiments/{experiment_id}/jobs/](https://docs.mabyduck.com/api/openapi/experiments/experiments_jobs_create.md): Creates a new draft job with the specified configuration.

### List all raters

 - [GET /projects/{project_id}/experiments/{experiment_id}/raters/](https://docs.mabyduck.com/api/openapi/experiments/experiments_raters_list.md): Returns a list of raters of a given experiment.

### List all ratings

 - [GET /projects/{project_id}/experiments/{experiment_id}/ratings/](https://docs.mabyduck.com/api/openapi/experiments/experiments_ratings_list.md): Returns a list of ratings belonging to the given experiment.

### List all results

 - [GET /projects/{project_id}/experiments/{experiment_id}/results/](https://docs.mabyduck.com/api/openapi/experiments/experiments_results_list.md): Returns a list of metrics derived from the results of an experiment.

### List all sessions

 - [GET /projects/{project_id}/experiments/{experiment_id}/sessions/](https://docs.mabyduck.com/api/openapi/experiments/experiments_sessions_list.md): Returns a list of sessions belonging to the given experiment.

### List all slates

 - [GET /projects/{project_id}/experiments/{experiment_id}/slates/](https://docs.mabyduck.com/api/openapi/experiments/experiments_slates_list.md): Returns a list of slates and ratings belonging to the given experiment.

## Rubrics

Operations related to rubrics and leaderboards.

### List all rubrics

 - [GET /projects/{project_id}/rubrics/](https://docs.mabyduck.com/api/openapi/rubrics/rubrics_list.md): Returns a list of rubrics belonging to the given project.

### Retrieve a rubric

 - [GET /projects/{project_id}/rubrics/{rubric_id}/](https://docs.mabyduck.com/api/openapi/rubrics/rubrics_retrieve.md): Returns data of all leaderboards belonging to a rubric.

### List all leaderboards

 - [GET /projects/{project_id}/rubrics/{rubric_id}/leaderboards/](https://docs.mabyduck.com/api/openapi/rubrics/rubrics_leaderboards_list.md): Lists all leaderboards belonging to the given rubric.

### Retrieve a leaderboard

 - [GET /projects/{project_id}/rubrics/{rubric_id}/leaderboards/{leaderboard_id}/](https://docs.mabyduck.com/api/openapi/rubrics/rubrics_leaderboards_retrieve.md): Returns only the data of a specific leaderboard.

## Metrics

### List metrics

 - [GET /projects/{project_id}/metrics/](https://docs.mabyduck.com/api/openapi/metrics/metrics_list.md): Returns a list of metrics corresponding to various sources.