Skip to main content
POST
/
v4
/
experiments
Create a experiment
curl --request POST \
  --url https://gentrace.ai/api/v4/experiments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pipelineId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "OpenAI o3-mini prompt",
  "metadata": {
    "promptTemplate": {
      "type": "string",
      "value": "Hello, {{ name }}!"
    }
  }
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-04-01T00:00:00.000Z",
  "updatedAt": "2025-04-01T00:00:00.000Z",
  "name": "OpenAI o3-mini prompt",
  "pipelineId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "key": "value"
  }
}

Authorizations

​
Authorization
string
header
required

Enter Gentrace API key (Format: Authorization: Bearer )

Body

application/json

Creates a new experiment with the given pipeline ID

​
pipelineId
string<uuid>
required

The ID of the pipeline to create the experiment for

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string

Friendly experiment name

Example:

"OpenAI o3-mini prompt"

​
metadata
object

Optional metadata for the experiment

Example:
{
  "promptTemplate": {
    "type": "string",
    "value": "Hello, {{ name }}!"
  }
}

Response

Successful response

​
id
string<uuid>
required

Experiment UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
createdAt
string
required

Creation timestamp (ISO 8601)

Example:

"2025-04-01T00:00:00.000Z"

​
updatedAt
string
required

Last update timestamp (ISO 8601)

Example:

"2025-04-01T00:00:00.000Z"

​
name
string | null
required

Friendly experiment name

Example:

"OpenAI o3-mini prompt"

​
pipelineId
string
required

Pipeline UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
metadata
object
required

Metadata

Example:
{ "key": "value" }