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

# Register an ingest agent

> Register a Black Hole desktop agent.

Black Hole desktop-agent install. **Auth0 only** (`ingest:write`). The organization must be allowlisted or this 404s. See [Black Hole](/black-hole).


## OpenAPI

````yaml POST /api/v2/ingest/agents/
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/agents/:
    post:
      tags:
        - v2/ingest
      summary: Register a black-hole agent install
      description: >-
        Creates one agent identity for a fresh desktop-agent install (CONTRACT
        §2.1). Requires the ``ingest:write`` scope but no ``X-Agent-Id`` header
        (this call mints it). The returned ``min_poll_seconds`` is the floor for
        the items-feed poll interval. Auth0 bearer JWT only — API keys and
        session cookies are rejected with 403 ``auth0_required``.
      operationId: v2_ingest_agents_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentRegisterRequestRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRegisterResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          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:
    AgentRegisterRequestRequest:
      type: object
      description: POST /api/v2/ingest/agents/ body (CONTRACT §2.1).
      properties:
        hostname:
          type: string
          minLength: 1
          maxLength: 255
        os:
          type: string
          minLength: 1
          maxLength: 50
        app_version:
          type: string
          minLength: 1
          maxLength: 50
      required:
        - app_version
        - hostname
        - os
    AgentRegisterResponse:
      type: object
      description: 201 body for agent registration.
      properties:
        agent_id:
          type: string
        min_poll_seconds:
          type: integer
      required:
        - agent_id
        - min_poll_seconds
  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.

````