Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
experiments

Retrieve Experiment

RUD: Retrieve, Update, Delete single experiment.

GET /evaluations/experiments/<id>/ PATCH /evaluations/experiments/<id>/ — edit the definition (dataset, workflow, evaluators, config). Blocked while a run is in flight so the in-flight run can trust its dispatched definition. Trigger execution via POST /runs/, not PATCH. DELETE /evaluations/experiments/<id>/

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

Path parameters

experiment_idstring required

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

idstring required
evaluator_idsstring required
projectstring nullable
namestring
descriptionstring
unique_organization_idstring required
{"stackTrail":"components:schemas:ExperimentV2:properties:workflow","oasType":"schema","type":"unknown","description":"Any type"}
workflow_countinteger
evaluator_slugsstring[]

List of evaluators to run for producing scores for comparison

evaluator_workflow_idsstring[]

List of WorkflowVersion IDs (eval_only) defining evaluator pipelines. Mutually exclusive with evaluator_slugs.

resource_idsstring[]

All resource IDs referenced (evaluators, prompts) for reverse lookup on deletion

batch_sizeinteger
concurrencyinteger
enable_tracingboolean
status'draft' | 'pending' | 'paused' | 'running' | 'waiting_for_annotations' | 'completed' | 'failed'
  • draft - Draft
  • pending - Pending
  • paused - Paused
  • running - Running
  • waiting_for_annotations - Waiting For Annotations
  • completed - Completed
  • failed - Failed
progressnumber double
{"stackTrail":"components:schemas:ExperimentV2:properties:metadata","oasType":"schema","type":"unknown","description":"Any type"}
is_starredboolean
created_atstring date-time required
updated_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
organizationinteger required
created_byinteger nullable required
datasetstring nullable
task_trackerstring nullable