---
title: "Obter assistente"
method: GET
path: "/agents/{id}"
tags: ["Agents"]
---

# Obter assistente

`GET /agents/{id}`

Recupera os detalhes de um assistente.

## Path parameters

- `id` string, required

## Response `200`

Successful response

- object
  - `id` string, required — Identificador do assistente
  - `name` string, required — Nome do assistente
  - `description` string, nullable — Instruções ao modelo de IA para direcionar a geração de respostas desejadas
  - `avatar` object, nullable — Avatar do assistente
    - `url` string, required — URL do arquivo
    - `title` string, nullable — Título do arquivo
    - `size` number, nullable — Tamanho do arquivo em bytes
    - `key` string, nullable — Chave única do arquivo
    - `ext` string, nullable — Extensão do arquivo
    - `img` string, nullable — Imagem associada ao arquivo
    - `description` string, nullable — Descrição do arquivo
  - `color` string — Cor associada ao assistente
  - `welcome` string, nullable — Mensagem de boas-vindas do assistente
  - `instructions` string, nullable — Instruções para o assistente
  - `off` string, nullable — Mensagem quando o assistente não souber a resposta
  - `references` boolean — Indica se o assistente usa referências
  - `purpose` 'general' | 'leads' | 'cs' — Finalidade do assistente
  - `freedom` 'free' | 'restricted' — Uso da base de conhecimento
  - `behavior_type` 'basic' | 'custom' — Configuração de comportamento do assistente
  - `status` 'online' | 'offline' | 'draft' — Status do assistente
  - `left` boolean — Posição do widget do assistente à esquerda da tela
  - `model` string, nullable — Modelo de IA do assistente
  - `workspaceId` string, required — Identificador do workspace associado
  - `createdAt` string, date-time — Data de criação
  - `updatedAt` string, date-time — Data da última atualização
  - `createdBy` string, nullable, required — ID do usuário que criou o registro
  - `updatedBy` string, nullable, required — ID do usuário que atualizou o registro
  - `kbs` string[] — Bases de conhecimento associadas ao assistente
  - `destinations` object[] — Destinos associados ao agente
    - `type` 'rdcrm' | 'rd' | 'exact' | 'email' | 'whatsapp', required — Tipo de destino da qualificação
    - `credentials` object, required — Credenciais utilizadas para envio ao destino
    - `qualification` object — Mapa de critérios utilizados para qualificação
  - `fields` object[] — Campos do assistente
    - `fieldId` string, required — Identificador único do campo
    - `position` number, required
    - `required` boolean, required
    - `description` string, nullable, required
  - `behavior` object, nullable — Comportamento configurável do assistente
    - `answerLength` 'short' | 'medium' | 'long' — Comprimento da resposta do agente
    - `personality` 'fun' | 'professional' | 'personal' — Personalidade do agente
    - `engagement` 'active' | 'passive' — Nível de engajamento do agente
  - `connections` object[] — Conectores habilitados
    - `id` string, required
    - `agentId` string, required — Identificador do assistente
    - `connectorId` string, required — ID do conector
    - `status` 'pending_auth' | 'connected' | 'expired' | 'revoked' | 'error'
    - `qualification` object — Mapa de critérios utilizados para qualificação
    - `workspaceId` string, required — Identificador do workspace associado
    - `connector` object, required
      - `id` string, required — ID do conector
      - `name` string, required — Nome
      - `url` string, uri, required — URL (stateless HTTP stream)
      - `settingsUrl` string, uri, nullable — URL de configuração
      - `oneLiner` string, required — Descrição em uma linha
      - `description` string, nullable — Descrição detalhada
      - `logo` string, nullable — Logo
      - `scope` string[], required — Escopos
      - `headers` object[], required — Headers
        - `key` string, required
        - `value` string, required
      - `custom` boolean — É um conector personalizado?
      - `workspaceId` string, required — Identificador do workspace associado
    - `tools` object[]
      - `id` string, required
      - `name` string, required
      - `title` string, nullable
      - `description` string, nullable
      - `inputSchema` object, required
      - `enabled` boolean

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/rdstationmentoria/apis/agents.md) · [All operations](https://skmtc.net/rdstationmentoria/apis/agents/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rdstationmentoria/agents/revisions/53961f5192d9/schema)