ARarize-ai
Experiments

Get an experiment

Changed on

Get an experiment object by its ID.

The response does not include the experiment's runs. To get the runs of a specific experiment, use the List Experiment Runs endpoint.

get/v2/experiments/{experiment_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/experiments/{experiment_id}
  • Auth
    HTTP bearer

Path parameters

experiment_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique experiment identifier (base64)

Response

An experiment object

idstring required

Unique identifier for the experiment

namestring required

Name of the experiment

space_idstring required

Unique identifier for the space this experiment belongs to

dataset_idstring nullable

Unique identifier for the dataset associated with this experiment. Null if the experiment isn't associated with a dataset.

dataset_version_idstring nullable

Unique identifier for the dataset version associated with this experiment. Null if the experiment isn't associated with a dataset.

created_atstring date-time required

Timestamp for when the experiment was created

updated_atstring date-time required

Timestamp for the last update of the experiment

experiment_traces_project_idstring

Unique identifier for the experiment traces project this experiment belongs to (if it exists)

integration_idstring nullable

Identifier (base64) of the agent integration that backs this experiment, as returned by the integrations API. Null for non-agent experiments (for example, SDK or Playground experiments).

Changes

  • 4f94eb2fd1abRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      api operation id experiments_get removed and replaced with get_experiment

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status