> ## 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.

# Pause, resume, retry, or cancel a work node

> Apply one lifecycle action to an initiative, workstream, milestone, task, or run you own.
Actions cascade sensibly — pausing an initiative pauses its active runs. Each action is
validated against current state, so repeating an already-applied action is safe.



## OpenAPI

````yaml /openapi/v1.yaml post /lifecycle
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:
  /lifecycle:
    post:
      tags:
        - Lifecycle
      summary: Pause, resume, retry, or cancel a work node
      description: >-
        Apply one lifecycle action to an initiative, workstream, milestone,
        task, or run you own.

        Actions cascade sensibly — pausing an initiative pauses its active runs.
        Each action is

        validated against current state, so repeating an already-applied action
        is safe.
      operationId: applyLifecycleAction
      parameters:
        - $ref: '#/components/parameters/IdempotencyKeyOptional'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LifecycleRequest'
            example:
              level: initiative
              id: 1481c341-089b-4be0-809b-49cb6e4fee48
              action: pause
      responses:
        '200':
          description: Lifecycle action applied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleResult'
              example:
                ok: true
                action: pause
                level: initiative
                id: 1481c341-089b-4be0-809b-49cb6e4fee48
                affected:
                  nodes: 4
                  runsPaused: 2
                  runsCancelled: 0
                  redispatched: 0
                message: Initiative paused; 2 active runs paused with it.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: The action could not be applied to the node's current state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                error:
                  code: lifecycle_action_failed
                  message: The initiative is already active.
                  requestId: req_01J5YB8X4Y
                  timestamp: '2026-08-18T18:30:00.000Z'
                  docsUrl: >-
                    https://useorgx.com/api/v1/errors?code=lifecycle_action_failed
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
components:
  parameters:
    IdempotencyKeyOptional:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 200
        pattern: ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,199}$
      description: >-
        Accepted for forward compatibility. Replay safety for this operation
        comes from its own state checks, described on the operation.
  schemas:
    LifecycleRequest:
      type: object
      additionalProperties: false
      required:
        - level
        - id
        - action
      properties:
        level:
          type: string
          enum:
            - initiative
            - workstream
            - milestone
            - task
            - run
        id:
          type: string
          format: uuid
        action:
          type: string
          enum:
            - pause
            - resume
            - retry
            - cancel
    LifecycleResult:
      type: object
      required:
        - ok
        - action
        - level
        - id
        - affected
      additionalProperties: true
      properties:
        ok:
          type: boolean
        action:
          type: string
        level:
          type: string
        id:
          type: string
          format: uuid
        affected:
          type: object
          properties:
            nodes:
              type: integer
            runsPaused:
              type: integer
            runsCancelled:
              type: integer
            redispatched:
              type: integer
        message:
          type: string
        blockReasons:
          type: array
          items:
            type: string
    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_...`'

````