Retrieve an experiment

curl https://api.respan.ai/api/v2/experiments/experiment_id/ \
     -H "Authorization: Bearer sk_live_xxxxx" \
     -H "Content-Type: application/json"

{
  "id": "exp_9f8b7c6d",
  "name": "gpt-4o-mini quality run",
  "status": "pending",
  "created_at": "2024-01-15T09:30:00Z",
  "description": "Evaluation of GPT-4o-mini model performance on Support QA Dataset",
  "dataset": "ds_7a6b5c4d",
  "dataset_id": "ds_7a6b5c4d",
  "dataset_name": "Support QA Dataset",
  "workflow_count": 1,
  "progress": 0,
  "started_at": null,
  "completed_at": null,
  "tags": [
    {
      "priority": "high",
      "team": "nlp-eval"
    }
  ],
  "workflow": [
    {
      "type": "completion",
      "config": {
        "model": "gpt-4o-mini",
        "temperature": 0.2,
        "max_tokens": 256
      }
    }
  ],
  "evaluator_ids": [
    "eval_12345"
  ],
  "evaluator_slugs": [
    "accuracy-check"
  ],
  "evaluator_workflow_ids": [
    "wf_eval_67890"
  ],
  "batch_size": 16,
  "concurrency": 4,
  "enable_tracing": true,
  "error_message": null
}

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

Path parameters

experiment_idstringRequired

Experiment ID returned as id in experiment responses.

Response

Experiment details.

idstring

Experiment ID.

namestring

Experiment name.

statusstring

Experiment execution status.

created_atdatetime

descriptionstring or null

Experiment description.

datasetstring or null

Dataset ID associated with the experiment.

dataset_idstring or null

Dataset ID associated with the experiment.

dataset_namestring or null

Dataset name, when available.

workflow_countinteger

Number of workflow steps.

progressdouble

Execution progress percentage.

started_atdatetime or null

completed_atdatetime or null

tagslist of maps from strings to any

Tags attached to the experiment.

workflowlist of objects

Workflow tasks configured for the experiment.

evaluator_idslist of strings

Evaluator IDs used for scoring.

evaluator_slugslist of strings

Backward-compatible evaluator identifiers stored by the backend.

evaluator_workflow_idslist of strings

Eval-only workflow versions used for scoring.

batch_sizeinteger

concurrencyinteger

enable_tracingboolean

error_messagestring or null

Failure details when status is failed.

Errors

401

Unauthorized Error

404

Not Found Error

Path parameters

Headers

Response

Errors