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

# List agents

> The agents in your workspace, newest first. Filter by name with `name`; page with offset and limit.



## OpenAPI

````yaml /api-reference/openapi.json get /agents
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Public REST API for Brilo. Authenticate by sending your API key as a Bearer
    token in the `Authorization` header.
  title: Brilo API
  version: '2025-03-02'
servers:
  - description: Production
    url: https://api.brilo.ai/v1
security: []
tags: []
paths:
  /agents:
    get:
      tags:
        - Agents (public)
      summary: List agents
      description: >-
        The agents in your workspace, newest first. Filter by name with `name`;
        page with offset and limit.
      operationId: listPublicAgents
      parameters:
        - description: Rows to skip.
          in: query
          name: offset
          required: false
          schema:
            default: 0
            description: Rows to skip.
            maximum: 100000
            minimum: 0
            type: integer
        - description: Page size, at most 200.
          in: query
          name: limit
          required: false
          schema:
            default: 50
            description: Page size, at most 200.
            maximum: 200
            minimum: 1
            type: integer
        - description: Only agents whose name contains this, any case.
          in: query
          name: name
          required: false
          schema:
            description: Only agents whose name contains this, any case.
            maxLength: 100
            type: string
        - description: Field and direction, e.g. 'name:asc'. Newest first by default.
          in: query
          name: sort
          required: false
          schema:
            default: created_at:desc
            description: Field and direction, e.g. 'name:asc'. Newest first by default.
            enum:
              - created_at:desc
              - created_at:asc
              - name:asc
              - name:desc
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      additionalProperties: false
                      properties:
                        created_at:
                          type: string
                        description:
                          nullable: true
                          type: string
                        draft_pending:
                          type: boolean
                        id:
                          type: string
                        live_version_id:
                          nullable: true
                          type: string
                        name:
                          nullable: true
                          type: string
                        phone_numbers:
                          items:
                            type: string
                          type: array
                        revision:
                          nullable: true
                          type: string
                        versioning_enabled:
                          type: boolean
                      required:
                        - id
                        - name
                        - description
                        - live_version_id
                        - versioning_enabled
                        - draft_pending
                        - phone_numbers
                        - revision
                        - created_at
                      type: object
                    type: array
                  limit:
                    maximum: 9007199254740991
                    minimum: -9007199254740991
                    type: integer
                  offset:
                    maximum: 9007199254740991
                    minimum: -9007199254740991
                    type: integer
                  total:
                    maximum: 9007199254740991
                    minimum: -9007199254740991
                    type: integer
                required:
                  - data
                  - total
                  - offset
                  - limit
                type: object
          description: ''
        '400':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  details:
                    additionalProperties: {}
                    type: object
                  error_code:
                    type: string
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        error_code:
                          type: string
                        field:
                          type: string
                        message:
                          type: string
                      required:
                        - field
                        - error_code
                        - message
                      type: object
                    type: array
                  hint:
                    type: string
                  message:
                    type: string
                  next_action:
                    additionalProperties: false
                    properties:
                      body:
                        additionalProperties: {}
                        type: object
                      method:
                        type: string
                      path:
                        type: string
                      tool:
                        type: string
                    required:
                      - tool
                      - method
                      - path
                    type: object
                  status:
                    maximum: 9007199254740991
                    minimum: -9007199254740991
                    type: integer
                required:
                  - status
                  - error_code
                  - message
                type: object
          description: validation_failed
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: Enter your API key (Bearer token)
      scheme: bearer
      type: http

````

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