Experiments API

The Experiments API allows you to manage experiments within the system. This API provides endpoints to create, list, retrieve, and delete experiments.

An experiment, in this context, is defined as the execution of different models—each running as an individual job—using the same dataset prepared for a specific use case.

This approach helps group related evaluations together, enabling consistent and reproducible testing. Additionally, experiments may include any extra information or links to internal structures that further detail the experiment setup, without overcomplicating the documentation. Endpoints ———

POST /api/v1/experiments/

Create Experiment Id

Create an experiment ID.

Status Codes:

• 201 Created – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /api/v1/experiments/

List Experiments

List all experiments.

Query Parameters:

• skip (integer)

• limit (integer)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /api/v1/experiments/{experiment_id}

Get Experiment

Get an experiment by ID.

Parameters:

• experiment_id (string)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

DELETE /api/v1/experiments/{experiment_id}

Delete Experiment

Delete an experiment by ID.

Parameters:

• experiment_id (string)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error