4e064cf81dae

latestOpenAPI 3.1.02026-08-131831,331960.0 KB
experiments

Retrieve an experiment

Retrieve an experiment by ID, including workflow and scoring configuration.

get/api/v2/experiments/{experiment_id}/

Path parameters

experiment_idstring required

Experiment ID returned as id in experiment responses.

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Response

Experiment details.

idstring required

Experiment ID.

namestring required

Experiment name.

descriptionstring nullable

Experiment description.

datasetstring nullable

Dataset ID associated with the experiment.

dataset_idstring nullable

Dataset ID associated with the experiment.

dataset_namestring nullable

Dataset name, when available.

workflow_countinteger

Number of workflow steps.

statusstring required

Experiment execution status.

progressnumber double

Execution progress percentage.

created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
tagsobject[]

Tags attached to the experiment.

evaluator_idsstring[]

Evaluator IDs used for scoring.

evaluator_slugsstring[]

Backward-compatible evaluator identifiers stored by the backend.

evaluator_workflow_idsstring[]

Eval-only workflow versions used for scoring.

batch_sizeinteger
concurrencyinteger
enable_tracingboolean
error_messagestring nullable

Failure details when status is failed.