List simulation cases

curl https://api.synthflow.ai/v2/simulation_cases \
     -H "Authorization: Bearer <token>"

{
  "status": "ok",
  "response": {
    "pagination": {
      "total_records": 1,
      "limit": 1,
      "offset": 0
    },
    "items": [
      {
        "simulation_case_id": "string",
        "workspace_id": "string",
        "suite_id": "string",
        "name": "string",
        "prompt": "string",
        "type": "custom",
        "success_criteria": [
          "string"
        ],
        "call_success_type": "all",
        "base_agent": {
          "model_id": "string",
          "agent_name": "string",
          "agent_type": "string",
          "voice_engine_type": "string",
          "phone_number": "string",
          "updated_at": "2024-01-15T09:30:00Z",
          "image_url": "string"
        },
        "created_at": "2024-01-15T09:30:00Z",
        "updated_at": "2024-01-15T09:30:00Z"
      }
    ]
  }
}

List simulation cases with pagination and optional filtering.

Authentication

AuthorizationBearer

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

Query parameters

page_numberintegerOptional>=1Defaults to 1

Page number.

page_sizeintegerOptional1-100Defaults to 10

Number of items per page.

searchstringOptional

Search term for simulation case names.

simulation_case_typeenumOptional

Filter by simulation case type.

Allowed values:

suite_idstringOptionalformat: "uuid"

Filter by simulation suite ID.

Response

200

statusstring

Whether the request was successful.

responseobject

Errors

400

Bad Request Error

$	curl https://api.synthflow.ai/v2/simulation_cases \
>	-H "Authorization: Bearer <token>"

1	{
2	"status": "ok",
3	"response": {
4	"pagination": {
5	"total_records": 1,
6	"limit": 1,
7	"offset": 0
8	},
9	"items": [
10	{
11	"simulation_case_id": "string",
12	"workspace_id": "string",
13	"suite_id": "string",
14	"name": "string",
15	"prompt": "string",
16	"type": "custom",
17	"success_criteria": [
18	"string"
19	],
20	"call_success_type": "all",
21	"base_agent": {
22	"model_id": "string",
23	"agent_name": "string",
24	"agent_type": "string",
25	"voice_engine_type": "string",
26	"phone_number": "string",
27	"updated_at": "2024-01-15T09:30:00Z",
28	"image_url": "string"
29	},
30	"created_at": "2024-01-15T09:30:00Z",
31	"updated_at": "2024-01-15T09:30:00Z"
32	}
33	]
34	}
35	}