Skip to main content
GET
/
v1
/
simulation
/
scenarios
List Simulation Scenarios
curl --request GET \
  --url https://api.eqho.ai/v1/simulation/scenarios \
  --header 'X-API-KEY: <api-key>'
{
  "scenarios": [
    {
      "_id": "<string>",
      "account_id": "<string>",
      "name": "<string>",
      "folder": "<string>",
      "lead_scenario": {
        "persona": "<string>",
        "instructions": {
          "task_instructions": "You are acting as a lead in the following conversation, follow lead script precisely: {{transcript}}",
          "language": "en",
          "reason_for_call": "<string>",
          "known_info": "<string>",
          "unknown_info": "<string>"
        },
        "actions": {
          "terminate_call": {
            "name": "<string>",
            "slug": "<string>",
            "instructions": "<string>",
            "messages": {
              "start": "<string>",
              "completed": "<string>",
              "failed": "<string>",
              "delayed": "<string>"
            },
            "minimum_execution_time_milliseconds": 123,
            "delayed_timing_milliseconds": 123,
            "type": "call_transfer",
            "is_async": true,
            "settings": {},
            "execution_type": "live",
            "response_mode": "interactive",
            "execution_order": 123
          }
        }
      },
      "description": {
        "purpose": "<string>",
        "notes": "<string>"
      },
      "environment_setup": {
        "dynamic_variables": {},
        "conversation_direction": "inbound",
        "conversation_medium": "chatbot",
        "action_mocks": {},
        "message_history": [
          {
            "role": "system",
            "content": "<string>",
            "turn_idx": 123,
            "timestamp": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "evaluation_criteria": {
        "actions": [
          {
            "tool_call_id": "<string>",
            "requestor": "assistant",
            "name": "<string>",
            "arguments": {},
            "info": "<string>",
            "compare_args": [
              "<string>"
            ]
          }
        ],
        "nl_assertions": [
          "<string>"
        ]
      },
      "history": {
        "revision": 0,
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "unknown",
        "last_modified_at": "2023-11-07T05:31:56Z",
        "last_modified_by": "unknown"
      }
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Response

200 - application/json

Successful Response

A collection of simulation scenarios

scenarios
SimulationScenarioModel · object[]
required

List of simulation scenarios