Skip to main content
POST
/
v0
/
experiments
Create an experiment
curl --request POST \
  --url https://api.avidoai.com/v0/experiments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "Credit Card Block",
  "description": "Wants to block their credit card",
  "assignee": "user_123456789",
  "inferenceStepIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "taskIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "title": "Credit Card Block",
    "description": "Wants to block their credit card",
    "status": "DRAFT",
    "inferenceStepIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "taskIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "assignee": "user_123456789"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for creating a new experiment

​
title
string
required

The title of the experiment

Required string length: 1 - 255
Example:

"Credit Card Block"

​
description
string
required

The experiment description

Example:

"Wants to block their credit card"

​
assignee
string

User ID of the person assigned to this experiment

Example:

"user_123456789"

​
inferenceStepIds
string[]

List of inference step ids used in the experiment

Example:
["123e4567-e89b-12d3-a456-426614174000"]
​
taskIds
string[]

List of task ids used in the experiment

Example:
["123e4567-e89b-12d3-a456-426614174000"]

Response

Successfully created experiment

Response containing a single experiment

​
data
object
required