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

# List the API error codes

> Every error code the API emits, with the status it carries, whether repeating the request
can succeed, what happened, and what to do about it.

This is the registry behind the `docsUrl` on every error body. It is account-free and served
from a compiled constant, so it stays available while the dependency that caused your error
is still failing. Pass `?code=` to resolve a single entry.



## OpenAPI

````yaml /openapi/v1.yaml get /errors
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:
  /errors:
    get:
      tags:
        - API discovery
      summary: List the API error codes
      description: >-
        Every error code the API emits, with the status it carries, whether
        repeating the request

        can succeed, what happened, and what to do about it.


        This is the registry behind the `docsUrl` on every error body. It is
        account-free and served

        from a compiled constant, so it stays available while the dependency
        that caused your error

        is still failing. Pass `?code=` to resolve a single entry.
      operationId: listApiErrorCodes
      parameters:
        - name: code
          in: query
          required: false
          schema:
            type: string
          description: Resolve one code instead of listing the registry.
        - name: If-None-Match
          in: header
          required: false
          schema:
            type: string
          description: Prior ETag. A match answers 304.
      responses:
        '200':
          description: The error-code registry
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: object
                    required:
                      - version
                      - docs_url_template
                      - errors
                    properties:
                      version:
                        type: string
                      docs_url_template:
                        type: string
                      envelope:
                        type: object
                        description: The shape of every error body, field by field.
                      errors:
                        type: array
                        items:
                          type: object
                          required:
                            - code
                            - status
                            - retryable
                            - title
                            - remedy
                          properties:
                            code:
                              type: string
                              description: Stable. Safe to branch on.
                            status:
                              type: integer
                            retryable:
                              type: boolean
                              description: >-
                                Whether repeating the identical request can
                                succeed later without the caller changing
                                anything.
                            title:
                              type: string
                            remedy:
                              type: string
                  meta:
                    type: object
                    properties:
                      apiVersion:
                        type: string
                      count:
                        type: integer
                      filtered:
                        type: boolean
              example:
                data:
                  version: '1'
                  docs_url_template: https://docs.useorgx.com/api/errors/{code}
                  envelope:
                    error:
                      code: The registry code. Stable; safe to branch on.
                      message: A curated sentence. Human-facing; never branch on it.
                      requestId: Correlates this response with the server log line.
                  errors:
                    - code: not_found
                      status: 404
                      retryable: false
                      title: No resource is reachable at that id.
                      remedy: >-
                        Confirm the id and that your credential reaches its
                        workspace. Unknown and out-of-scope ids return the same
                        404.
                    - code: rate_limited
                      status: 429
                      retryable: true
                      title: The credential exceeded its rate class for this window.
                      remedy: >-
                        Wait `Retry-After` seconds. Budgets are per credential
                        and per class, not per route.
                meta:
                  apiVersion: '1'
                  count: 218
        '304':
          description: The caller already holds this document
        '429':
          description: Public 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

````