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 <respanApiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "exp_9f8b7c6d5a4e3f21",
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 on Support QA Dataset for accuracy and response quality.",
7   "dataset": "ds_7e6d5c4b3a2f1e09",
8   "dataset_id": "ds_7e6d5c4b3a2f1e09",
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-evaluation"
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_123abc456def"
32   ],
33   "evaluator_slugs": [
34     "accuracy-checker"
35   ],
36   "evaluator_workflow_ids": [
37     "wf_eval_789xyz"
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.

Authentication

AuthorizationBearer

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, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

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