For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DiscordPlatform
DocumentationIntegrationsAPI referenceSDKsChangelog
DocumentationIntegrationsAPI referenceSDKsChangelog
  • API Reference
      • POSTCreate an experiment
      • POSTFilter experiments
      • GETRetrieve an experiment
      • DELDelete an experiment
      • GETList or export experiment traces
      • POSTFilter experiment traces
      • GETRetrieve an experiment trace
      • PATCHResume a wait workflow trace
      • GETGet experiment trace summary
      • GETList experiments
      • GETList experiments with filters
      • GETGet experiments summary
      • POSTFilter experiments summary
      • PUTReplace an experiment
      • PATCHUpdate an experiment
      • POSTFilter experiment trace summary
      • GETGet experiment score histogram
      • POSTGet experiment score histogram with filters
  • Reference
    • Filters API Reference
LogoLogo
DiscordPlatform
API ReferenceExperiments

Retrieve an experiment

GET
https://api.respan.ai/api/v2/experiments/:experiment_id/
GET
/api/v2/experiments/:experiment_id/
$curl https://api.respan.ai/api/v2/experiments/experiment_id/ \
>     -H "Authorization: Bearer sk_live_xxxxx" \
>     -H "Content-Type: application/json"
1{
2  "id": "exp_9f8b7c6d",
3  "name": "gpt-4o-mini quality run",
4  "status": "pending",
5  "created_at": "2024-01-15T09:30:00Z",
6  "description": "Evaluation of GPT-4o-mini model performance on Support QA Dataset",
7  "dataset": "ds_7a6b5c4d",
8  "dataset_id": "ds_7a6b5c4d",
9  "dataset_name": "Support QA Dataset",
10  "workflow_count": 1,
11  "progress": 0,
12  "started_at": null,
13  "completed_at": null,
14  "tags": [
15    {
16      "priority": "high",
17      "team": "nlp-eval"
18    }
19  ],
20  "workflow": [
21    {
22      "type": "completion",
23      "config": {
24        "model": "gpt-4o-mini",
25        "temperature": 0.2,
26        "max_tokens": 256
27      }
28    }
29  ],
30  "evaluator_ids": [
31    "eval_12345"
32  ],
33  "evaluator_slugs": [
34    "accuracy-check"
35  ],
36  "evaluator_workflow_ids": [
37    "wf_eval_67890"
38  ],
39  "batch_size": 16,
40  "concurrency": 4,
41  "enable_tracing": true,
42  "error_message": null
43}
Retrieve an experiment by ID, including workflow and scoring configuration.
Was this page helpful?
Previous

Delete an experiment

Next
Built with

Path parameters

experiment_idstringRequired

Experiment ID returned as id in experiment responses.

Headers

AuthorizationstringRequired

Bearer token. Use Bearer YOUR_API_KEY for API key auth or Bearer <JWT> for dashboard auth.

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