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

# Stop a launch and release its spend reservation

> The kill switch. In one call it releases the spend reservation, cancels the
launch's queued and running jobs and runs, and restores the initiative
status this launch promoted — and reports each count separately so you can
see what actually stopped.

Releasing the reservation is the part that matters most: until it is
released the estimate keeps counting against your daily cap for the rest of
the UTC day, whether or not the work ran.

Jobs already finished are left alone. Cancelling a launch that was already
cancelled returns `409`.



## OpenAPI

````yaml /openapi/v1.yaml post /launches/{launchId}/cancel
openapi: 3.1.0
info:
  title: OrgX REST API v1
  version: '1'
  description: >-
    Build accountable work into your product with OrgX REST API v1.


    Create work with one field, attach evidence when it is complete, and keep
    the receipt. Every authenticated request is scoped to the workspace resolved
    from your credential.


    Start with `POST /work`. Human guide:
    https://docs.useorgx.com/docs/api/quickstart
  contact:
    name: OrgX Support
    url: https://useorgx.com/support
    email: support@useorgx.com
  license:
    name: Proprietary
    url: https://useorgx.com/terms
servers:
  - url: https://useorgx.com/api/v1
    description: Production
security: []
tags:
  - name: Work
    description: Create accountable work and complete it with evidence
  - name: Initiatives
    description: Organize related work around an outcome
  - name: Operating processes
    description: Evidence-backed company workflow/process lifecycle
  - name: Operating map
    description: Derived, rebuildable Operating Map projection over the process ledger
  - name: Discovery runs
    description: Wizard and deep-search workflow discovery over connected company sources
  - name: Handoffs
    description: Ledger-backed stage handoffs between operating-process stages
  - name: Events
    description: Replayable, workspace-scoped accepted ledger events
  - name: Projections
    description: Workspace-scoped, rebuildable read projections over OrgX sources
  - name: Episodes
    description: Mission-compatible Episode read adapters
  - name: Receipt validation
    description: Account-free Agent Work Receipt schema discovery and conformance
  - name: Receipt import
    description: Authenticated, workspace-scoped import into the hosted receipt ledger
  - name: Workload diagnosis
    description: >-
      Account-free evaluation of time, agents, systems, authority, and
      accountability boundaries
  - name: Content Studio
    description: >-
      Estimate, showcase, checkout, and payment event operations for Content
      Studio
  - name: Decisions
    description: Raise decisions for human ruling and read their state
  - name: Artifacts
    description: Register produced work against the entity it belongs to
  - name: Launches
    description: Preview and run an initiative launch through its spend gates
  - name: Runs
    description: Control agent runs with pause, resume, cancel, and rollback
  - name: Lifecycle
    description: Pause, resume, retry, or cancel work hierarchy nodes and runs
  - name: Deduplication
    description: Claim durable event fingerprints so duplicate triggers fire once
  - name: Credential
    description: >-
      Resolve the calling credential, the workspaces it reaches, and what it may
      do
  - name: API discovery
    description: Account-free error codes, request schemas, and closed vocabularies for v1
externalDocs:
  description: Human-readable OrgX REST API v1 reference
  url: https://docs.useorgx.com/docs/api/public-api
paths:
  /launches/{launchId}/cancel:
    post:
      tags:
        - Launches
      summary: Stop a launch and release its spend reservation
      description: >-
        The kill switch. In one call it releases the spend reservation, cancels
        the

        launch's queued and running jobs and runs, and restores the initiative

        status this launch promoted — and reports each count separately so you
        can

        see what actually stopped.


        Releasing the reservation is the part that matters most: until it is

        released the estimate keeps counting against your daily cap for the rest
        of

        the UTC day, whether or not the work ran.


        Jobs already finished are left alone. Cancelling a launch that was
        already

        cancelled returns `409`.
      operationId: cancelLaunch
      parameters:
        - name: launchId
          in: path
          required: true
          description: Launch to cancel
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LaunchCancelRequest'
            example:
              workspace_id: 5be1076d-8fd0-4c0f-847f-fd67fdb935e8
              expected_aggregate_version: 2
              reason: Scope changed before the agents got far
      responses:
        '200':
          description: What the cancel actually stopped and released
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LaunchCancelResponse'
              example:
                data:
                  launch_id: 1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                  runs_cancelled: 1
                  jobs_cancelled: 1
                  reservation_released: 1
                  initiative_status_restored: true
                  aggregateVersion: 3
                  eventId: 9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d
                meta:
                  apiVersion: '1'
                  workspaceId: 5be1076d-8fd0-4c0f-847f-fd67fdb935e8
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: The launch changed since it was read, or was already cancelled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
        - cookieAuth: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 200
        pattern: ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,199}$
      description: Workspace-scoped retry key for safe mutation replay.
  schemas:
    LaunchCancelRequest:
      type: object
      required:
        - expected_aggregate_version
      properties:
        workspace_id:
          type: string
          format: uuid
        expected_aggregate_version:
          type: integer
          minimum: 0
        reason:
          type: string
          maxLength: 500
          nullable: true
    LaunchCancelResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: object
          properties:
            launch_id:
              type: string
              format: uuid
            runs_cancelled:
              type: integer
            jobs_cancelled:
              type: integer
            reservation_released:
              type: integer
              description: How many spend reservations stopped counting against your cap.
            initiative_status_restored:
              type: boolean
            aggregateVersion:
              type: integer
            eventId:
              type: string
              format: uuid
              nullable: true
        meta:
          type: object
          properties:
            apiVersion:
              type: string
            workspaceId:
              type: string
              format: uuid
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
            requestId:
              type: string
            timestamp:
              type: string
              format: date-time
            docsUrl:
              type: string
              format: uri
            retryAfter:
              type: integer
              description: Seconds until rate limit resets
  responses:
    BadRequest:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource is unavailable to the caller
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServiceUnavailable:
      description: Ledger or workspace authorization is unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'OrgX API key, sent as `Authorization: Bearer oxk_...`'
    cookieAuth:
      type: apiKey
      in: cookie
      name: __session
      description: Session cookie from web authentication

````