Get a simulation suite

GET

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

GET

/v2/simulation_suites/:suite_id

1 curl https://api.synthflow.ai/v2/simulation_suites/suite_id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

1 {
2   "status": "ok",
3   "response": {
4     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5     "name": "Customer Support Simulation Suite",
6     "model_id": "model-987654321",
7     "workspace_id": "workspace-123456789",
8     "language": "en-US",
9     "cases": [
10       {
11         "simulation_case_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
12         "workspace_id": "workspace-123456789",
13         "name": "Order Status Inquiry",
14         "prompt": "Customer asks about the status of their recent order.",
15         "type": "custom",
16         "success_criteria": [
17           "Provide accurate order status",
18           "Offer estimated delivery date"
19         ],
20         "call_success_type": "all",
21         "base_agent": {
22           "model_id": "agent-model-001",
23           "agent_name": "SupportBot",
24           "agent_type": "virtual_assistant",
25           "voice_engine_type": "neural_tts",
26           "phone_number": "+1234567890",
27           "updated_at": "2024-01-15T09:30:00Z",
28           "image_url": "https://example.com/avatars/supportbot.png"
29         },
30         "created_at": "2024-01-15T09:30:00Z",
31         "updated_at": "2024-01-15T09:30:00Z"
32       }
33     ],
34     "agent": {
35       "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
36       "name": "SupportBot",
37       "avatar": "https://example.com/avatars/supportbot.png"
38     },
39     "created_at": "2024-01-15T09:30:00Z",
40     "updated_at": "2024-01-15T09:30:00Z"
41   }
42 }

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

Whether the request was successful.

responseobject

Errors

400

Bad Request Error

404

Not Found Error