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

# List recognizers

> Returns the recognizers the engine has registered, grouped into NER and LLM — each with its name, optional description, and provider. Connection details and credentials are never exposed.



## OpenAPI

````yaml /api-reference/openapi.json get /catalog/recognizers/
openapi: 3.1.0
info:
  title: Nvisy API
  summary: Document processing and annotation platform
  description: >-
    Nvisy provides intelligent document processing, annotation, and analysis
    capabilities. This API enables document upload, OCR processing, embedding
    generation, and semantic search across your document collections.
  termsOfService: https://nvisy.com/legal/terms-of-service
  contact:
    name: Nvisy Support
    url: https://nvisy.com
    email: hello@nvisy.com
  license:
    name: Proprietary
    url: https://nvisy.com/license
  version: 0.1.0
servers: []
security: []
tags:
  - name: Accounts
    description: Account management and profile operations
  - name: Authentication
    description: Login, signup, and token management
  - name: Workspaces
    description: Workspace creation and management
  - name: Files
    description: File upload, download, and management
  - name: Members
    description: Workspace member management
  - name: Invites
    description: Workspace invitation handling
  - name: API Tokens
    description: API token management
  - name: Connections
    description: External provider connections
  - name: Pipelines
    description: Redaction pipeline configuration
  - name: Pipeline Runs
    description: Pipeline run execution and review
  - name: Policies
    description: Redaction policy configuration
  - name: Webhooks
    description: Webhook configuration
  - name: Notifications
    description: Account notification management
  - name: Health
    description: Service health checks
paths:
  /catalog/recognizers/:
    get:
      tags:
        - Catalog
      summary: List recognizers
      description: >-
        Returns the recognizers the engine has registered, grouped into NER and
        LLM — each with its name, optional description, and provider. Connection
        details and credentials are never exposed.
      responses:
        '200':
          description: The engine's registered recognizers, grouped by kind.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecognizerCatalog'
        '401':
          description: >-
            HTTP error response representation with security-conscious design.


            This struct contains all the information needed to serialize an
            error

            response, including the error name, message, HTTP status code,
            resource

            information, and user-friendly messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    RecognizerCatalog:
      description: The engine's registered recognizers, grouped by kind.
      type: object
      properties:
        llm:
          description: LLM recognizers.
          type: array
          items:
            $ref: '#/components/schemas/RegisteredRecognizer'
        ner:
          description: NER (named-entity recognition) recognizers.
          type: array
          items:
            $ref: '#/components/schemas/RegisteredRecognizer'
      required:
        - ner
        - llm
    ErrorResponse:
      description: |-
        HTTP error response representation with security-conscious design.

        This struct contains all the information needed to serialize an error
        response, including the error name, message, HTTP status code, resource
        information, and user-friendly messages.
      type: object
      properties:
        message:
          description: User-friendly error message safe for client display
          type: string
        name:
          description: The error name/type identifier
          type: string
        resource:
          description: The resource that the error relates to (optional, set by handler)
          type: string
        suggestion:
          description: Helpful suggestion for resolving the error (optional)
          type: string
        validation:
          description: Validation error details for field-specific errors
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorDetail'
      required:
        - name
        - message
    RegisteredRecognizer:
      description: |-
        Public view of one recognizer in the engine's NER or LLM
        lineup.

        Carries the name a request's allowlist picks by, an optional
        human-readable description, and a provider slug identifying
        the backend kind. Connection details and (future)
        credentials stay in the private `NerConfig` / `LlmConfig`.

        Owned rather than borrowing from the engine so callers can
        carry the value past the borrow that produced it. Cloning is
        cheap — [`HipStr`] shares the backing string via an `Arc`
        header.
      type: object
      properties:
        description:
          description: Optional human-readable description.
          type: string
        name:
          description: |-
            Recognizer name — the identifier a request's allowlist
            picks by.
          type: string
        provider:
          description: |-
            Provider slug. NER: `"bento"`, `"mock"`. LLM: `"openai"`,
            `"anthropic"`, `"gemini"`, `"ollama"`, `"mock"`.
          type: string
      required:
        - name
        - provider
    ValidationErrorDetail:
      description: Validation error details for field-specific errors.
      type: object
      properties:
        code:
          description: Error code for the validation failure
          type: string
        field:
          description: Field name that failed validation
          type: string
        message:
          description: Human-readable error message
          type: string
        params:
          description: Additional parameters related to the validation error
          type: object
          additionalProperties: true
      required:
        - field
        - code
        - message

````