ROroarkhq
Simulation Run Plan

List run plans

Changed on

Returns a paginated list of simulation run plans. Optionally filter by search text or agent ID.

get/v1/simulation/plan

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/simulation/plan
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of run plans to return (default: 20, max: 50)

Example:20
afterstring

Cursor for pagination - use the nextCursor value from a previous response

searchTextstring

Search text to filter run plans by name

agentIdstring uuid

Filter run plans by agent ID

Response

Paginated list of run plans

Example response

{
  "data": [
    {
      "template": "accent-handling",
      "scenarios": [
        {
          "variables": {
            "customerName": "John Doe",
            "appointmentDate": "2024-02-15"
          }
        }
      ],
      "flows": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "happyPath": true,
          "edgeCases": [
            {
              "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
              "variables": {
                "tier": "premium"
              }
            }
          ]
        }
      ]
    }
  ]
}

Changes