Retrieve an experiment

GET

https://api.respan.ai/api/v2/experiments/:experiment_id/

GET

/api/v2/experiments/:experiment_id/

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

1 {
2   "id": "exp_1234567890abcdef",
3   "name": "Customer Support Chatbot Evaluation",
4   "description": "Experiment to evaluate the accuracy and response time of the customer support chatbot workflows.",
5   "createdAt": "2024-05-10T09:15:00Z",
6   "status": "active",
7   "workflows": [
8     {
9       "id": "wf_001",
10       "name": "Intent Classification Workflow",
11       "description": "Workflow to classify user intents from chat inputs.",
12       "steps": [
13         {
14           "stepId": "step_1",
15           "type": "text_preprocessing",
16           "config": {
17             "remove_stopwords": true,
18             "lowercase": true
19           }
20         },
21         {
22           "stepId": "step_2",
23           "type": "model_inference",
24           "modelId": "model_intent_v2",
25           "parameters": {
26             "confidence_threshold": 0.75
27           }
28         }
29       ]
30     },
31     {
32       "id": "wf_002",
33       "name": "Response Generation Workflow",
34       "description": "Generates responses based on classified intents.",
35       "steps": [
36         {
37           "stepId": "step_1",
38           "type": "template_selection",
39           "config": {
40             "use_fallback": true
41           }
42         },
43         {
44           "stepId": "step_2",
45           "type": "response_ranking",
46           "parameters": {
47             "top_k": 3
48           }
49         }
50       ]
51     }
52   ],
53   "configuration": {
54     "loggingEnabled": true,
55     "evaluationMetrics": [
56       "accuracy",
57       "response_time",
58       "user_satisfaction"
59     ],
60     "notificationEmails": [
61       "team_lead@company.com",
62       "qa_manager@company.com"
63     ]
64   }
65 }

Retrieve an experiment by ID, including its workflows and configuration.

Path parameters

experiment_idstringRequired

The ID of the experiment to retrieve.

Response

Successful response for Retrieve experiment

Errors

401

Unauthorized Error

Path parameters

Headers

Response

Errors