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

# List Tools



## OpenAPI

````yaml GET /tool
openapi: 3.1.0
info:
  title: Onyx API
  description: Onyx API for AI-powered enterprise search and chat
  version: Development
servers:
  - url: https://cloud.onyx.app/api
security: []
paths:
  /tool:
    get:
      tags:
        - public
      summary: List Tools
      operationId: list_tools
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ToolSnapshot'
                title: Response List Tools Tool Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    ToolSnapshot:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        definition:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Definition
        display_name:
          type: string
          title: Display Name
        in_code_tool_id:
          anyOf:
            - type: string
            - type: 'null'
          title: In Code Tool Id
        custom_headers:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Custom Headers
        passthrough_auth:
          type: boolean
          title: Passthrough Auth
        mcp_server_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Mcp Server Id
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
        oauth_config_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Oauth Config Id
        oauth_config_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Oauth Config Name
        enabled:
          type: boolean
          title: Enabled
          default: true
        chat_selectable:
          type: boolean
          title: Chat Selectable
          default: true
        agent_creation_selectable:
          type: boolean
          title: Agent Creation Selectable
          default: true
        default_enabled:
          type: boolean
          title: Default Enabled
          default: false
      type: object
      required:
        - id
        - name
        - description
        - definition
        - display_name
        - in_code_tool_id
        - custom_headers
        - passthrough_auth
      title: ToolSnapshot
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authorization header with Bearer token

````