Skip to main content
POST
Create New Experiment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating an experiment

name
string
required

Name of the experiment

Maximum string length: 256
dataset_id
string<uuid>
required

ID of the dataset used in this experiment

application_id
string<uuid>
required

ID of the application this experiment belongs to

description
string | null

Description of the experiment

Maximum string length: 512
metadata
object | null

JSONB field for unstructured metadata

Example:

Response

Details of the created experiment

Response object for standard API responses.

api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
data
object

Details of an experiment