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

# Get request schemas for v1 operations

> JSON Schema for the request bodies the API enforces, generated from the same validators the
handlers parse with, so the published shape matches the enforced shape.

Covers the operations whose inner shapes are otherwise reachable only by trial and error:
decisions, operating-process proposals, the handoff return, escalate, and cancel bodies,
lifecycle commands, discovery promotion, and receipt import. Account-free.



## OpenAPI

````yaml /openapi/v1.yaml get /meta/schemas
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:
  /meta/schemas:
    get:
      tags:
        - API discovery
      summary: Get request schemas for v1 operations
      description: >-
        JSON Schema for the request bodies the API enforces, generated from the
        same validators the

        handlers parse with, so the published shape matches the enforced shape.


        Covers the operations whose inner shapes are otherwise reachable only by
        trial and error:

        decisions, operating-process proposals, the handoff return, escalate,
        and cancel bodies,

        lifecycle commands, discovery promotion, and receipt import.
        Account-free.
      operationId: getApiRequestSchemas
      parameters:
        - name: If-None-Match
          in: header
          required: false
          schema:
            type: string
          description: Prior ETag. A match answers 304.
      responses:
        '200':
          description: Request and document schemas for v1
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: object
                    required:
                      - version
                      - dialect
                      - request_schemas
                      - document_schemas
                    properties:
                      version:
                        type: string
                      dialect:
                        type: string
                      generated_from:
                        type: string
                      enums_url:
                        type: string
                        format: uri
                      errors_url:
                        type: string
                        format: uri
                      request_schemas:
                        type: array
                        items:
                          type: object
                          required:
                            - id
                            - method
                            - path
                            - location
                            - json_schema
                          properties:
                            id:
                              type: string
                            method:
                              type: string
                            path:
                              type: string
                            location:
                              type: string
                            description:
                              type: string
                            json_schema:
                              type: object
                      document_schemas:
                        type: array
                        items:
                          type: object
                          required:
                            - id
                            - json_schema
                          properties:
                            id:
                              type: string
                            description:
                              type: string
                            json_schema:
                              type: object
                  meta:
                    type: object
                    properties:
                      apiVersion:
                        type: string
                      count:
                        type: integer
              example:
                data:
                  version: '1'
                  dialect: https://json-schema.org/draft/2020-12/schema
                  generated_from: >-
                    The validators the route handlers parse with, converted at
                    module load.
                  enums_url: https://useorgx.com/api/v1/meta/enums
                  errors_url: https://useorgx.com/api/v1/errors
                  request_schemas:
                    - id: returnHandoff
                      method: POST
                      path: /handoffs/{handoffId}/return
                      location: body
                      description: >-
                        Return a claimed handoff to its origin stage.
                        Concurrency is checked against
                        expected_aggregate_version.
                      json_schema:
                        type: object
                        required:
                          - workspace_id
                          - expected_aggregate_version
                        properties:
                          workspace_id:
                            type: string
                            format: uuid
                          expected_aggregate_version:
                            type: integer
                            minimum: 0
                  document_schemas:
                    - id: agentWorkReceipt
                      description: >-
                        The Agent Work Receipt document accepted by the importer
                        and the account-free validator.
                      json_schema:
                        $ref: '#/components/schemas/AgentWorkReceipt'
                meta:
                  apiVersion: '1'
                  count: 9
        '304':
          description: The caller already holds this document
        '429':
          description: Public schema registry rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
      security: []
components:
  schemas:
    PublicApiError:
      type: object
      required:
        - error
      properties:
        ok:
          type: boolean
        valid:
          type: boolean
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            issues:
              type: array
              items:
                type: object

````