Skip to main content
POST
/
v1
/
sim-suites
/
{suite_id}
/
runs
/
{suite_run_id}
/
cancel
Cancel every non-terminal child of a suite run
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/sim-suites/{suite_id}/runs/{suite_run_id}/cancel \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "runs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scenario_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tool_overrides": {},
      "status": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "error_text": "<string>",
      "inputs_snapshot": {},
      "created_at": "2023-11-07T05:31:56Z",
      "recording_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "recording_status": "<string>"
    }
  ],
  "release_eval_status": "<string>",
  "release_eval_verdict": {
    "status": "<string>",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "suite_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "summary": {
      "total_scenarios": 0,
      "passed_scenarios": 0,
      "failed_scenarios": 0,
      "pending_scenarios": 0,
      "critical_failures": 0
    },
    "schema_version": 1,
    "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "max_failures": 0,
    "scenarios": [
      {
        "simulation_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "scenario_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "<string>",
        "session_eval_status": "<string>",
        "critical_total": 0,
        "critical_succeeded": 0,
        "critical_failed": 0,
        "critical_pending": 0,
        "evaluators": [
          {
            "evaluator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "status": "<string>",
            "name": "<string>",
            "is_critical": false,
            "severity": "<string>",
            "score": 123,
            "threshold": 123,
            "reason": "<string>"
          }
        ]
      }
    ]
  },
  "release_eval_completed_at": "2023-11-07T05:31:56Z",
  "release_eval_error": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
suite_id
string<uuid>
required
​
suite_run_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
suite_id
string<uuid>
required
​
agent_id
string<uuid>
required
​
agent_revision_id
string<uuid> | null
required
​
created_by
string | null
required
​
created_at
string<date-time>
required
​
status
string
required
​
runs
SimulationRunResponse · object[]
​
release_eval_status
string | null
​
release_eval_verdict
ReleaseVerdict · object
​
release_eval_completed_at
string<date-time> | null
​
release_eval_error
string | null