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

# List the registry agents chat can use

> The registry agents general chat can hand a task to, with the tools each can use and whether it changes something. An agent that can change something asks for your approval before it starts, and then uses those tools without asking again.



## OpenAPI

````yaml get /api/chat/agents
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/chat/agents:
    get:
      tags:
        - Chat
      summary: List the registry agents chat can use
      description: >-
        The registry agents general chat can hand a task to, with the tools each
        can use and whether it changes something. An agent that can change
        something asks for your approval before it starts, and then uses those
        tools without asking again.
      operationId: list_agents_api_chat_agents_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ChatAgentInfo'
                type: array
                title: Response List Agents Api Chat Agents Get
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ChatAgentInfo:
      properties:
        tool_name:
          type: string
          title: Tool Name
          description: The chat tool that runs it, agent_<name>.
        label:
          type: string
          title: Label
          description: The agent's display name.
        version:
          type: string
          title: Version
          description: The version chat runs.
        role:
          type: string
          title: Role
          description: The agent's role.
        writes:
          type: boolean
          title: Writes
          description: Whether a call waits for your approval.
        tools:
          items:
            $ref: '#/components/schemas/ChatAgentToolInfo'
          type: array
          title: Tools
          description: The tools it can use.
      type: object
      required:
        - tool_name
        - label
        - version
        - role
        - writes
        - tools
      title: ChatAgentInfo
      description: A registry agent general chat can hand a task to.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    ChatAgentToolInfo:
      properties:
        name:
          type: string
          title: Name
          description: The tool's name.
        server:
          type: string
          title: Server
          description: The MCP server it is on.
        writes:
          type: boolean
          title: Writes
          description: >-
            Whether it changes something. Approving the agent's call lets it use
            these without asking again.
      type: object
      required:
        - name
        - server
        - writes
      title: ChatAgentToolInfo
      description: One tool a registry agent can use from chat.
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.