> ## Documentation Index
> Fetch the complete documentation index at: https://doc.featherhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel every non-terminal child of a suite run



## OpenAPI

````yaml /api-reference/openapi.json post /v1/sim-suites/{suite_id}/runs/{suite_run_id}/cancel
openapi: 3.1.0
info:
  title: Feather API
  description: >-
    Unified customer experience platform API. Manages identity, conversations,
    memory, agents, procedures, policies, model routing, knowledge bases,
    integrations, and runtime execution.
  version: 1.21.0
servers:
  - url: https://api-sandbox.featherhq.com
    description: Sandbox
  - url: http://localhost:8000
    description: Local dev
security: []
paths:
  /v1/sim-suites/{suite_id}/runs/{suite_run_id}/cancel:
    post:
      tags:
        - sim_suites
      summary: Cancel every non-terminal child of a suite run
      operationId: cancelSimulationSuiteRun
      parameters:
        - name: suite_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Suite Id
        - name: suite_run_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Suite Run Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationSuiteRunResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    SimulationSuiteRunResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        organization_id:
          type: string
          format: uuid
          title: Organization Id
        suite_id:
          type: string
          format: uuid
          title: Suite Id
        agent_id:
          type: string
          format: uuid
          title: Agent Id
        agent_revision_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Agent Revision Id
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
        status:
          type: string
          title: Status
        runs:
          items:
            $ref: '#/components/schemas/SimulationRunResponse'
          type: array
          title: Runs
        release_eval_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Release Eval Status
        release_eval_verdict:
          anyOf:
            - $ref: '#/components/schemas/ReleaseVerdict'
            - type: 'null'
        release_eval_completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Release Eval Completed At
        release_eval_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Release Eval Error
      type: object
      required:
        - id
        - organization_id
        - suite_id
        - agent_id
        - agent_revision_id
        - created_by
        - created_at
        - status
      title: SimulationSuiteRunResponse
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
        message:
          type: string
          title: Message
      type: object
      required:
        - error
        - message
      title: ErrorResponse
      description: Standard error response returned by all API error handlers.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SimulationRunResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        session_id:
          type: string
          format: uuid
          title: Session Id
        organization_id:
          type: string
          format: uuid
          title: Organization Id
        agent_id:
          type: string
          format: uuid
          title: Agent Id
        agent_revision_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Agent Revision Id
        persona_id:
          type: string
          format: uuid
          title: Persona Id
        scenario_id:
          type: string
          format: uuid
          title: Scenario Id
        channel:
          $ref: '#/components/schemas/ScenarioChannel'
        tool_overrides:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Tool Overrides
        status:
          type: string
          title: Status
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
        error_text:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Text
        inputs_snapshot:
          additionalProperties: true
          type: object
          title: Inputs Snapshot
        created_at:
          type: string
          format: date-time
          title: Created At
        recording_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Recording Id
        recording_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Recording Status
      type: object
      required:
        - id
        - session_id
        - organization_id
        - agent_id
        - agent_revision_id
        - persona_id
        - scenario_id
        - channel
        - tool_overrides
        - status
        - started_at
        - finished_at
        - error_text
        - inputs_snapshot
        - created_at
      title: SimulationRunResponse
    ReleaseVerdict:
      properties:
        schema_version:
          type: integer
          title: Schema Version
          default: 1
        status:
          type: string
          title: Status
        agent_id:
          type: string
          format: uuid
          title: Agent Id
        agent_revision_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Agent Revision Id
        suite_id:
          type: string
          format: uuid
          title: Suite Id
        suite_run_id:
          type: string
          format: uuid
          title: Suite Run Id
        max_failures:
          type: integer
          title: Max Failures
          default: 0
        summary:
          $ref: '#/components/schemas/ReleaseVerdictSummary'
        scenarios:
          items:
            $ref: '#/components/schemas/ReleaseVerdictScenario'
          type: array
          title: Scenarios
      type: object
      required:
        - status
        - agent_id
        - suite_id
        - suite_run_id
        - summary
      title: ReleaseVerdict
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ScenarioChannel:
      type: string
      enum:
        - text
        - voice
      title: ScenarioChannel
    ReleaseVerdictSummary:
      properties:
        total_scenarios:
          type: integer
          title: Total Scenarios
          default: 0
        passed_scenarios:
          type: integer
          title: Passed Scenarios
          default: 0
        failed_scenarios:
          type: integer
          title: Failed Scenarios
          default: 0
        pending_scenarios:
          type: integer
          title: Pending Scenarios
          default: 0
        critical_failures:
          type: integer
          title: Critical Failures
          default: 0
      type: object
      title: ReleaseVerdictSummary
    ReleaseVerdictScenario:
      properties:
        simulation_run_id:
          type: string
          format: uuid
          title: Simulation Run Id
        session_id:
          type: string
          format: uuid
          title: Session Id
        scenario_id:
          type: string
          format: uuid
          title: Scenario Id
        persona_id:
          type: string
          format: uuid
          title: Persona Id
        status:
          type: string
          title: Status
        session_eval_status:
          type: string
          title: Session Eval Status
        critical_total:
          type: integer
          title: Critical Total
          default: 0
        critical_succeeded:
          type: integer
          title: Critical Succeeded
          default: 0
        critical_failed:
          type: integer
          title: Critical Failed
          default: 0
        critical_pending:
          type: integer
          title: Critical Pending
          default: 0
        evaluators:
          items:
            $ref: '#/components/schemas/ReleaseVerdictEvaluator'
          type: array
          title: Evaluators
      type: object
      required:
        - simulation_run_id
        - session_id
        - scenario_id
        - persona_id
        - status
        - session_eval_status
      title: ReleaseVerdictScenario
    ReleaseVerdictEvaluator:
      properties:
        evaluator_id:
          type: string
          format: uuid
          title: Evaluator Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        is_critical:
          type: boolean
          title: Is Critical
          default: false
        severity:
          anyOf:
            - type: string
            - type: 'null'
          title: Severity
        status:
          type: string
          title: Status
        score:
          anyOf:
            - type: number
            - type: 'null'
          title: Score
        threshold:
          anyOf:
            - type: number
            - type: 'null'
          title: Threshold
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
      type: object
      required:
        - evaluator_id
        - status
      title: ReleaseVerdictEvaluator
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````