Experiments

Get experiment by id

Changed on

Get experiment by id

get/v1/private/experiments/{id}

Request

  • Base URL
    http://localhost:5173/api
  • URL
    http://localhost:5173/api/v1/private/experiments/{id}
  • Auth
    none declared

Path parameters

idstring uuid required

Response

Experiment resource

idstring uuid
dataset_namestring nullable required
dataset_idstring uuid
project_idstring uuid

Project ID. Takes precedence over project_name when both are provided.

project_namestring

Project name. Creates project if it doesn't exist. Ignored when project_id is provided.

namestring
metadataJsonListStringPublic
tagsstring[]
type'regular' | 'trial' | 'mini-batch' | 'mutation'
evaluation_method'dataset' | 'evaluation_suite'
optimization_idstring uuid
trace_countinteger
dataset_item_countinteger
created_atstring date-time
total_estimated_costnumber
total_estimated_cost_avgnumber
usageobject
last_updated_atstring date-time
created_bystring
last_updated_bystring
status'running' | 'completed' | 'cancelled' | 'failed'
finished_atstring date-time

When the run stopped producing items. Unset while it may still produce more, whatever its status

dataset_version_idstring uuid

ID of the dataset version this experiment is linked to. If not provided at creation, experiment will be automatically linked to the latest version.

pass_ratenumber

Pass rate for test suite experiments (0.0-1.0). Null for regular experiments.

passed_countinteger

Number of items that passed for test suite experiments. Null for regular experiments.

total_countinteger

Total number of items for test suite experiments. Null for regular experiments.

Changes

    • warning

      added the new failed enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status