> ## 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.

# Obter assistente

> Recupera os detalhes de um assistente.



## OpenAPI

````yaml https://api.meuassistente.rdstationmentoria.com.br/rest get /agents/{id}
openapi: 3.0.3
info:
  title: Agents
  version: 0.0.1
servers:
  - url: https://api.meuassistente.rdstationmentoria.com.br/rest
security: []
paths:
  /agents/{id}:
    get:
      tags:
        - Agents
      summary: Obter assistente
      description: Recupera os detalhes de um assistente.
      operationId: agents-get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Identificador do assistente
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                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.445Z'
                    description: Data de criação
                  updatedAt:
                    type: string
                    format: date-time
                    default: '2026-02-08T00:20:48.445Z'
                    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
                  kbs:
                    type: array
                    items:
                      type: string
                      description: Identificador único da base de conhecimento
                    default: []
                    description: Bases de conhecimento associadas ao assistente
                  destinations:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - rdcrm
                            - rd
                            - exact
                            - email
                            - whatsapp
                          description: Tipo de destino da qualificação
                        credentials:
                          type: object
                          additionalProperties: {}
                          description: Credenciais utilizadas para envio ao destino
                        qualification:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              operator:
                                type: string
                                enum:
                                  - equals
                                description: Operador utilizado para comparação
                              value:
                                description: Valor a ser comparado
                              type:
                                type: string
                                enum:
                                  - text
                                  - email
                                  - phone
                                  - number
                                  - url
                                  - boolean
                                  - date
                                  - choice
                                  - multi_choice
                                  - cpf
                                  - cnpj
                                description: Tipo do campo
                            required:
                              - operator
                              - type
                            additionalProperties: false
                            description: >-
                              Critério de qualificação com operador, valor e
                              tipo
                          default: {}
                          description: Mapa de critérios utilizados para qualificação
                      required:
                        - type
                        - credentials
                      additionalProperties: false
                    default: []
                    description: Destinos associados ao agente
                  fields:
                    type: array
                    items:
                      type: object
                      properties:
                        fieldId:
                          type: string
                          description: Identificador único do campo
                        position:
                          type: number
                        required:
                          type: boolean
                        description:
                          type: string
                          nullable: true
                      required:
                        - fieldId
                        - position
                        - required
                        - description
                      additionalProperties: false
                    default: []
                    description: Campos do assistente
                  behavior:
                    type: object
                    properties:
                      answerLength:
                        type: string
                        enum:
                          - short
                          - medium
                          - long
                        default: short
                        description: Comprimento da resposta do agente
                      personality:
                        type: string
                        enum:
                          - fun
                          - professional
                          - personal
                        default: personal
                        description: Personalidade do agente
                      engagement:
                        type: string
                        enum:
                          - active
                          - passive
                        default: active
                        description: Nível de engajamento do agente
                    additionalProperties: false
                    nullable: true
                    default:
                      answerLength: short
                      personality: personal
                      engagement: active
                    description: Comportamento configurável do assistente
                  connections:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        agentId:
                          type: string
                          description: Identificador do assistente
                        connectorId:
                          type: string
                          description: ID do conector
                        status:
                          type: string
                          enum:
                            - pending_auth
                            - connected
                            - expired
                            - revoked
                            - error
                          default: pending_auth
                        qualification:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              operator:
                                type: string
                                enum:
                                  - equals
                                description: Operador utilizado para comparação
                              value:
                                description: Valor a ser comparado
                              type:
                                type: string
                                enum:
                                  - text
                                  - email
                                  - phone
                                  - number
                                  - url
                                  - boolean
                                  - date
                                  - choice
                                  - multi_choice
                                  - cpf
                                  - cnpj
                                description: Tipo do campo
                            required:
                              - operator
                              - type
                            additionalProperties: false
                            description: >-
                              Critério de qualificação com operador, valor e
                              tipo
                          default: {}
                          description: Mapa de critérios utilizados para qualificação
                        workspaceId:
                          type: string
                          description: Identificador do workspace associado
                        connector:
                          type: object
                          properties:
                            id:
                              type: string
                              description: ID do conector
                            name:
                              type: string
                              description: Nome
                            url:
                              type: string
                              format: uri
                              description: URL (stateless HTTP stream)
                            settingsUrl:
                              type: string
                              format: uri
                              nullable: true
                              default: null
                              description: URL de configuração
                            oneLiner:
                              type: string
                              description: Descrição em uma linha
                            description:
                              type: string
                              nullable: true
                              default: null
                              description: Descrição detalhada
                            logo:
                              type: string
                              nullable: true
                              default: null
                              description: Logo
                            scope:
                              type: array
                              items:
                                type: string
                              description: Escopos
                            headers:
                              type: array
                              items:
                                type: object
                                properties:
                                  key:
                                    type: string
                                  value:
                                    type: string
                                required:
                                  - key
                                  - value
                                additionalProperties: false
                              description: Headers
                            custom:
                              type: boolean
                              default: true
                              description: É um conector personalizado?
                            workspaceId:
                              type: string
                              description: Identificador do workspace associado
                          required:
                            - id
                            - name
                            - url
                            - oneLiner
                            - scope
                            - headers
                            - workspaceId
                          additionalProperties: false
                        tools:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              name:
                                type: string
                              title:
                                type: string
                                nullable: true
                                default: null
                              description:
                                type: string
                                nullable: true
                                default: null
                              inputSchema:
                                type: object
                                additionalProperties: {}
                              enabled:
                                type: boolean
                                default: true
                            required:
                              - id
                              - name
                              - inputSchema
                            additionalProperties: false
                          default: []
                      required:
                        - id
                        - agentId
                        - connectorId
                        - workspaceId
                        - connector
                      additionalProperties: false
                    default: []
                    description: Conectores habilitados
                required:
                  - id
                  - name
                  - workspaceId
                  - createdBy
                  - updatedBy
                additionalProperties: false
        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

````