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

# Ingest schemas

> List schemas participating in Black Hole.

Participating schemas the agent can classify against. Auth0 + allowlist.


## OpenAPI

````yaml GET /api/v2/ingest/schemas/
openapi: 3.1.0
info:
  title: Abacus Docs API
  version: 1.0.0
  description: |
    REST + SSE surface for Abacus Docs on the same host as the web app
    (`https://abacusdocs.com`). Paths are `/api/v2/…`.

    Authenticate with an organisation API key (`sk-abacus-*`) as a Bearer
    token, or an Auth0 access token. Cross-tenant reads return **404**, not
    403. Page-based lists use `?page=` and `?page_size=`.

    Extraction, reprocess, schema tests, and chat turns spend credits.
    See the help centre Credits pages for rates.
  contact:
    name: Abacus Docs
    url: https://abacusdocs.com/contact
servers:
  - url: https://abacusdocs.com
    description: Production (Extract)
security: []
paths:
  /api/v2/ingest/schemas/:
    get:
      tags:
        - v2/ingest
      summary: List schemas an item may be matched to
      description: >-
        Every published, non-deprecated ACTIVE struct in the caller's org
        (CONTRACT §2.5) — NOT filtered to ``black_hole_enabled`` targets;
        matching a non-enabled one via ``POST /items/{item_id}/match/``
        auto-enables it. Requires ``ingest:read``.
      operationId: v2_ingest_schemas_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaListResponse'
          description: ''
        '403':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
        '426':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
      security:
        - bearerAuth: []
components:
  schemas:
    SchemaListResponse:
      type: object
      description: 200 body of GET /api/v2/ingest/schemas/.
      properties:
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/Schema'
      required:
        - schemas
    Schema:
      type: object
      description: One entry in GET /api/v2/ingest/schemas/ (CONTRACT §2.5).
      properties:
        slug:
          type: string
        name:
          type: string
        version:
          type: integer
          description: The integer version_number of current_version.
        black_hole_enabled:
          type: boolean
      required:
        - black_hole_enabled
        - name
        - slug
        - version
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Auth0 access token for a signed-in user. Send `Authorization: Bearer
        <token>`.

        The SPA and desktop agent use this. Prefer an organisation API key for

        server-to-server integrations.

````