List simulation cases

import requests
url = "https://api.synthflow.ai/v2/simulation_cases"
payload = { "body": {
        "page_number": 1,
        "page_size": 10,
        "search": "Customer Support Simulation",
        "simulation_case_type": "custom"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "status": "ok",
  "response": {
    "pagination": {
      "total_records": 25,
      "limit": 10,
      "offset": 0
    },
    "items": [
      {
        "simulation_case_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "workspace_id": "workspace_12345",
        "name": "Customer Support Simulation - Tier 1",
        "prompt": "Simulate a customer support call handling billing inquiries.",
        "type": "custom",
        "success_criteria": [
          "Resolve billing issue",
          "Maintain customer satisfaction"
        ],
        "call_success_type": "all",
        "base_agent": {
          "model_id": "model_xyz_001",
          "agent_name": "SupportBot Alpha",
          "agent_type": "virtual_assistant",
          "voice_engine_type": "neural_tts",
          "phone_number": "+15551234567",
          "updated_at": "2024-01-15T09:30:00Z",
          "image_url": "https://cdn.synthflow.ai/agents/supportbot_alpha.png"
        },
        "created_at": "2024-01-10T08:00: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