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

# List agents

> Returns the agents this API key can use: every agent of the key's owner,
or only the agents the key is restricted to.




## OpenAPI

````yaml /openapi.yaml get /agents
openapi: 3.0.3
info:
  title: ReyGrid API
  version: 1.0.3
  description: |
    ReyGrid API

    ## Persistent user conversations

    If you want to build a separate conversation system for each user,
    build a wrapper layer around the ReyGrid API.

    The wrapper should manage the application's own user IDs and map them
    to ReyGrid conversations.

    The wrapper is responsible for:
    - Managing and identifying users.
    - Storing the relationship between the application's userId and
      ReyGrid conversationId.
    - Persisting conversation IDs in the application's own database.
    - Reusing the stored conversationId when the same user continues
      a conversation.
    - Verifying that conversation IDs belong to the expected user before
      using them.

    ReyGrid's userId can also be used as a stable identifier for persistent
    conversations. However, if the application requires its own user and
    conversation management, it should maintain this mapping in its own
    database.
servers:
  - url: https://reygrid.com/api/v1
security: []
paths:
  /agents:
    get:
      summary: List agents
      description: |
        Returns the agents this API key can use: every agent of the key's owner,
        or only the agents the key is restricted to.
      operationId: listAgents
      responses:
        '200':
          description: Agents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentsResponse'
              example:
                success: true
                agents:
                  - id:
                      AgentId: null
                    name: Support
                    model: gpt-4o-mini-2024-07-18
                    instructions: >-
                      Answer customer questions about orders, shipping and
                      refunds.
                    usage: 119.5
                    createdAt: '2026-08-25T00:43:49.979Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl https://reygrid.com/api/v1/agents \
              -H "Authorization: Bearer $REYGRID_API_KEY"
        - lang: python
          label: Python SDK
          source: |-
            from reygrid import ReyGrid

            client = ReyGrid(api_key="YOUR_API_KEY")

            for agent in client.list_agents().agents:
                print(agent.id, agent.name, agent.model)
        - lang: javascript
          label: TypeScript SDK
          source: >-
            import { ReyGrid } from "reygrid";


            const client = new ReyGrid({ apiKey: "YOUR_API_KEY" });


            const { agents } = await client.listAgents();

            for (const agent of agents) console.log(agent.id, agent.name,
            agent.model);
components:
  schemas:
    AgentsResponse:
      type: object
      properties:
        success:
          type: boolean
        agents:
          type: array
          items:
            $ref: '#/components/schemas/Agent'
    Agent:
      type: object
      properties:
        id:
          type: string
          example:
            AgentId: null
        name:
          type: string
          example: Support
        model:
          type: string
          example: gpt-4o-mini-2024-07-18
        instructions:
          type: string
        usage:
          type: number
          description: Credits spent by the agent so far.
        createdAt:
          type: string
          format: date-time
    AuthErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          example: Unauthorized
        code:
          type: string
          example: AUTH_REQUIRED
  responses:
    Unauthorized:
      description: API key is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: Unauthorized
            code: AUTH_REQUIRED
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API-Key
      description: ReyGrid API key sent as a Bearer token.

````

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