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

> Returns which connector families and providers this deployment can create: each OAuth file-service provider is available only when its app is configured on the server, while object-store and inference connections carry their own credentials and are always available. Use it to render the connect UI without probing.



## OpenAPI

````yaml /api-reference/openapi.json get /capabilities/connectors
openapi: 3.1.0
info:
  title: Nvisy API
  summary: Document detection and redaction platform
  description: >-
    Nvisy provides intelligent detection of sensitive content in documents,
    redaction pipelines, and reviewer workflows. This API enables document
    upload, detection analysis, redaction, and collaborative review across your
    workspaces.
  termsOfService: https://nvisy.com/legal/terms-of-service
  contact:
    name: Nvisy Support
    url: https://nvisy.com
    email: hello@nvisy.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 0.1.0
servers: []
security: []
tags:
  - name: Health
    description: Service health checks
  - name: Capabilities
    description: Read-only reference data describing this deployment
  - name: Accounts
    description: Account management and profile operations
  - name: Identities
    description: 'Account sign-in methods: password and linked providers'
  - name: Avatars
    description: Public avatar image serving
  - name: Authentication
    description: Login, signup, and token management
  - name: Workspaces
    description: Workspace creation and management
  - name: Activities
    description: Workspace activity log and export
  - name: Documents
    description: Document upload, download, and management
  - name: Analytics
    description: Aggregate metrics over a workspace's documents
  - 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: Connection Syncs
    description: Connection synchronization runs
  - name: Providers
    description: Inference-provider configuration
  - name: Pipelines
    description: Redaction pipeline configuration
  - name: Detections
    description: Detection analysis and redaction
  - name: Redactions
    description: Redactions produced from a detection, with reviewer edits
  - name: Reviews
    description: Document reviews, the review queue, and their discussion
  - name: Policies
    description: Redaction policy configuration
  - name: Webhooks
    description: Webhook configuration
  - name: Notifications
    description: Account notification management
paths:
  /capabilities/connectors:
    get:
      tags:
        - Capabilities
      summary: List connectors
      description: >-
        Returns which connector families and providers this deployment can
        create: each OAuth file-service provider is available only when its app
        is configured on the server, while object-store and inference
        connections carry their own credentials and are always available. Use it
        to render the connect UI without probing.
      responses:
        '200':
          description: >-
            Which connector families and providers this deployment can create.


            Lets a client render the connect UI without probing: a file-service
            provider

            is only offered when the host has configured its OAuth app, whereas

            object-store and inference connections carry their own credentials
            and are

            always available.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorCapabilities'
        '401':
          description: >-
            The serialized shape of an HTTP error: the inert wire/OpenAPI-schema
            view

            that [`Error`] renders to at the response boundary.


            It carries no builder logic — [`Error`] is the type handlers
            construct and

            thread through `Result`, and it builds an `ErrorResponse` directly
            in its

            `IntoResponse` impl. `context` and `status` are not part of the JSON
            body

            (`context` is logged, `status` sets the HTTP status line).


            [`Error`]: crate::response::Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    ConnectorCapabilities:
      description: >-
        Which connector families and providers this deployment can create.


        Lets a client render the connect UI without probing: a file-service
        provider

        is only offered when the host has configured its OAuth app, whereas

        object-store and inference connections carry their own credentials and
        are

        always available.
      type: object
      properties:
        fileServices:
          description: Availability of each OAuth file-service provider.
          allOf:
            - $ref: '#/components/schemas/FileProviders'
        inference:
          description: >-
            Whether inference connections can be created. Currently always
            `true`, for

            the same reason as object stores.
          type: boolean
        objectStores:
          description: >-
            Whether object-store connections can be created. Currently always
            `true` —

            they carry their own credentials, so nothing gates them server-side
            — but

            clients should read the field rather than assume it.
          type: boolean
      required:
        - fileServices
        - objectStores
        - inference
    ErrorResponse:
      description: >-
        The serialized shape of an HTTP error: the inert wire/OpenAPI-schema
        view

        that [`Error`] renders to at the response boundary.


        It carries no builder logic — [`Error`] is the type handlers construct
        and

        thread through `Result`, and it builds an `ErrorResponse` directly in
        its

        `IntoResponse` impl. `context` and `status` are not part of the JSON
        body

        (`context` is logged, `status` sets the HTTP status line).


        [`Error`]: crate::response::Error
      type: object
      properties:
        message:
          description: User-friendly error message safe for client display.
          type: string
        name:
          description: The error name/type identifier.
          type: string
      required:
        - name
        - message
    FileProviders:
      description: >-
        Per-provider availability for the OAuth file services. Each field is
        `true`

        only when that provider's OAuth app is configured on the server.
      type: object
      properties:
        box:
          description: >-
            Whether Box can be connected. (`box` is a Rust keyword, hence the
            field

            name; the wire name is `box`.)
          type: boolean
        dropbox:
          description: Whether Dropbox can be connected.
          type: boolean
        googleDrive:
          description: Whether Google Drive can be connected.
          type: boolean
        oneDrive:
          description: Whether `OneDrive` can be connected.
          type: boolean
      required:
        - googleDrive
        - dropbox
        - oneDrive
        - box

````