Create New Experiment

curl --request POST \
  --url 'https://api.example.com/ai/create_new_experiment?HAIQU_API_KEY=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "",
  "context": ""
}
'

{
  "id": "<string>",
  "name": "<string>",
  "context": "<string>",
  "description": "",
  "creation_date": "2023-11-07T05:31:56Z",
  "tags": "",
  "circuits_count": 0,
  "jobs_count": 0,
  "last_action_date": "2023-11-07T05:31:56Z"
}

API Reference

Create New Experiment

Create a new experiment tool. If experiment with the same name already exists, return it.

Experiments serve as a container for circuits, jobs, and metrics, and are used to organize and group them together. They also provide the context for AI agents to understand the purpose and details of the circuits and jobs, and to store the results and artifacts of the executions.

Args: user (User): User authenticated with api key. data (ContextExperimentSubmitModel): The experiment submission data.

Returns: ContextExperimentModel: The experiment object.

POST

create_new_experiment

Create New Experiment

curl --request POST \
  --url 'https://api.example.com/ai/create_new_experiment?HAIQU_API_KEY=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "",
  "context": ""
}
'

{
  "id": "<string>",
  "name": "<string>",
  "context": "<string>",
  "description": "",
  "creation_date": "2023-11-07T05:31:56Z",
  "tags": "",
  "circuits_count": 0,
  "jobs_count": 0,
  "last_action_date": "2023-11-07T05:31:56Z"
}

Authorizations

HAIQU_API_KEY

string

query

required

Body

application/json

Experiment submit payload data model.

name

string

required

description

string | null

default:""

Experiment description stored as HTML-formatted text. Send markup such as <p>...</p> when structure or rich text is needed.

context

string | null

default:""

Response

Successful Response

Experiment model with the context for AI/MCP endpoints.

string

required

name

string

required

context

string

required

description

string | null

default:""

creation_date

string<date-time> | null