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

# Listar assistentes

> Lista assistentes com base nos parâmetros fornecidos.



## OpenAPI

````yaml https://api.meuassistente.rdstationmentoria.com.br/rest get /agents
openapi: 3.0.3
info:
  title: Agents
  version: 0.0.1
servers:
  - url: https://api.meuassistente.rdstationmentoria.com.br/rest
security: []
paths:
  /agents:
    get:
      tags:
        - Agents
      summary: Listar assistentes
      description: Lista assistentes com base nos parâmetros fornecidos.
      operationId: agents-list
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: number
            minimum: 1
            default: 1
          description: Número da página
        - name: size
          in: query
          required: false
          schema:
            type: number
            minimum: 1
            maximum: 100
            default: 20
          description: Tamanho da página
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Texto livre para busca pelo nome do assistente
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Identificador do assistente
                        name:
                          type: string
                          description: Nome do assistente
                        description:
                          type: string
                          nullable: true
                          default: null
                          description: >-
                            Instruções ao modelo de IA para direcionar a geração
                            de respostas desejadas
                        avatar:
                          type: object
                          properties:
                            url:
                              type: string
                              description: URL do arquivo
                            title:
                              type: string
                              nullable: true
                              default: null
                              description: Título do arquivo
                            size:
                              type: number
                              nullable: true
                              default: null
                              description: Tamanho do arquivo em bytes
                            key:
                              type: string
                              nullable: true
                              default: null
                              description: Chave única do arquivo
                            ext:
                              type: string
                              nullable: true
                              default: null
                              description: Extensão do arquivo
                            img:
                              type: string
                              nullable: true
                              default: null
                              description: Imagem associada ao arquivo
                            description:
                              type: string
                              nullable: true
                              default: null
                              description: Descrição do arquivo
                          required:
                            - url
                          additionalProperties: false
                          nullable: true
                          default: null
                          description: Avatar do assistente
                        color:
                          type: string
                          pattern: ^#[0-9a-fA-F]{6}$
                          default: '#ff5722'
                          description: Cor associada ao assistente
                        welcome:
                          type: string
                          nullable: true
                          default: null
                          description: Mensagem de boas-vindas do assistente
                        instructions:
                          type: string
                          nullable: true
                          default: null
                          description: Instruções para o assistente
                        'off':
                          type: string
                          nullable: true
                          default: null
                          description: Mensagem quando o assistente não souber a resposta
                        references:
                          type: boolean
                          default: false
                          description: Indica se o assistente usa referências
                        purpose:
                          type: string
                          enum:
                            - general
                            - leads
                            - cs
                          description: Finalidade do assistente
                          default: leads
                        freedom:
                          type: string
                          enum:
                            - free
                            - restricted
                          default: restricted
                          description: Uso da base de conhecimento
                        behavior_type:
                          type: string
                          enum:
                            - basic
                            - custom
                          default: basic
                          description: Configuração de comportamento do assistente
                        status:
                          type: string
                          enum:
                            - online
                            - offline
                            - draft
                          description: Status do assistente
                          default: draft
                        left:
                          type: boolean
                          default: false
                          description: Posição do widget do assistente à esquerda da tela
                        workspaceId:
                          type: string
                          description: Identificador do workspace associado
                        createdAt:
                          type: string
                          format: date-time
                          default: '2026-02-08T00:20:48.442Z'
                          description: Data de criação
                        updatedAt:
                          type: string
                          format: date-time
                          default: '2026-02-08T00:20:48.442Z'
                          description: Data da última atualização
                        createdBy:
                          type: string
                          description: ID do usuário que criou o registro
                          nullable: true
                        updatedBy:
                          type: string
                          description: ID do usuário que atualizou o registro
                          nullable: true
                      required:
                        - id
                        - name
                        - workspaceId
                        - createdBy
                        - updatedBy
                      additionalProperties: false
                    description: Lista de registros da página
                  meta:
                    type: object
                    properties:
                      total:
                        type: number
                        description: Total de registros
                      page:
                        type: number
                        description: Número da página atual
                      size:
                        type: number
                        description: Quantidade de registros da página
                      first:
                        type: number
                        description: Primeira página
                      last:
                        type: number
                        description: Última página
                      next:
                        type: number
                        nullable: true
                        description: Próxima página
                      previous:
                        type: number
                        nullable: true
                        description: Página anterior
                    required:
                      - total
                      - page
                      - size
                      - first
                      - last
                      - next
                      - previous
                    additionalProperties: false
                    description: Metadados da página
                required:
                  - data
                  - meta
                additionalProperties: false
                description: Página de registros
        default:
          $ref: '#/components/responses/error'
      security:
        - Authorization: []
components:
  responses:
    error:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              issues:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                    - message
                  additionalProperties: false
            required:
              - message
              - code
            additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````