Get a simulation suite

GET

https://api.synthflow.ai/v2/simulation_suites/:suite_id

GET

/v2/simulation_suites/:suite_id

1 import requests
2 
3 url = "https://api.synthflow.ai/v2/simulation_suites/suite_id"
4 
5 headers = {"Authorization": "Bearer <token>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

Try it

200Retrieved

1 {
2   "status": "ok",
3   "response": {
4     "id": "string",
5     "name": "string",
6     "model_id": "string",
7     "workspace_id": "string",
8     "language": "en-US",
9     "cases": [
10       {
11         "simulation_case_id": "string",
12         "workspace_id": "string",
13         "name": "string",
14         "prompt": "string",
15         "type": "custom",
16         "success_criteria": [
17           "string"
18         ],
19         "call_success_type": "all",
20         "base_agent": {
21           "model_id": "string",
22           "agent_name": "string",
23           "agent_type": "string",
24           "voice_engine_type": "string",
25           "phone_number": "string",
26           "updated_at": "2024-01-15T09:30:00Z",
27           "image_url": "string"
28         },
29         "created_at": "2024-01-15T09:30:00Z",
30         "updated_at": "2024-01-15T09:30:00Z"
31       }
32     ],
33     "agent": {
34       "id": "string",
35       "name": "string",
36       "avatar": "string"
37     },
38     "created_at": "2024-01-15T09:30:00Z",
39     "updated_at": "2024-01-15T09:30:00Z"
40   }
41 }

Retrieve a simulation suite by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

suite_idstringRequired

Simulation suite ID.

Response

200

statusstring or null

Whether the request was successful.

responseobject or null

Authentication

Path parameters

Response

Errors