Simulation Template

List simulation templates

Changed on

Returns the built-in simulation templates, each resolved against this project: the metric and check definitions it collects, and the flows it runs with the variants it covers.

A template is a preset rather than a stored object, so building a run from one produces an ordinary run plan you own and can edit afterwards. Pass a slug as template to POST /v1/simulation/run.

Every entry is complete, so there is no per-template endpoint to follow up with, and the list is a fixed catalogue rather than a paginated one. Only templates a request can actually run are listed.

get/v1/simulation/template

Request

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

Response

The built-in simulation templates

Example response

{
  "data": [
    {
      "slug": "red-teaming",
      "title": "Red teaming",
      "description": "Adversarial probing. Tests refusals, jailbreak resistance, and whether the agent’s policy holds.",
      "category": "Safety",
      "metrics": [
        {
          "id": "9c1e2f3a-4b5c-4d6e-8f70-1a2b3c4d5e6f",
          "slug": "compliance_prompt_injection_resistance"
        }
      ],
      "thresholds": [
        {
          "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
          "slug": "compliance_prompt_injection_resistance_check"
        }
      ],
      "flows": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "title": "Prompt injection",
          "slug": "sf-prompt-injection",
          "happyPath": {
            "title": "Direct attempt"
          },
          "edgeCases": [
            {
              "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
              "title": "Encoded payload",
              "slug": "data-embedded-injection"
            }
          ]
        }
      ],
      "includeFlowMetrics": false,
      "sweep": null,
      "defaultMaxSimulationDurationSeconds": 900,
      "defaultEndCallReasons": []
    }
  ]
}

Changes

    • warning

      added the new INTERRUPTION enum value to the /////// response property for the response status

    • info

      added the required property // to the response with the status