Sign in

v5

latestOpenAPI 3.1.0MITraw.githubusercontent.com2025-07-24172759.4 KB
Experiments

Update a experiment

Update the details of a experiment by ID

post/v4/experiments/{id}

Path parameters

idstring uuid required

Experiment UUID

Example:123e4567-e89b-12d3-a456-426614174000

Experiment UUID

Request body

namestring nullable

Friendly experiment name

metadataobject nullable

Metadata

status'GENERATING' | 'EVALUATING'

Status

Example request

{
  "name": "OpenAI o3-mini prompt",
  "metadata": {
    "key": "value"
  },
  "status": "GENERATING"
}

Response

Successful response

idstring uuid required

Experiment UUID

createdAtstring required

Creation timestamp (ISO 8601)

updatedAtstring required

Last update timestamp (ISO 8601)

namestring nullable required

Friendly experiment name

pipelineIdstring required

Pipeline UUID

metadataobject nullable required

Metadata

resourcePathstring nullable required

Resource path to navigate to the experiment

Example response

{
  "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"
  },
  "resourcePath": "/t/gentrace/pipeline/b6b6f257-4b81-5925-9587-fa3b6a427cd9/experiments/123e4567-e89b-12d3-a456-426614174000"
}