Pular para o conteúdo principal
GET
/
agents
/
{id}
Obter assistente
curl --request GET \
  --url https://api.meuassistente.rdstationmentoria.com.br/rest/agents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "workspaceId": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "description": null,
  "avatar": null,
  "color": "#ff5722",
  "welcome": null,
  "instructions": null,
  "off": null,
  "references": false,
  "purpose": "leads",
  "freedom": "restricted",
  "behavior_type": "basic",
  "status": "draft",
  "left": false,
  "createdAt": "2025-11-26T20:01:11.896Z",
  "updatedAt": "2025-11-26T20:01:11.896Z",
  "kbs": [],
  "destinations": [],
  "fields": [],
  "behavior": {
    "answerLength": "short",
    "personality": "personal",
    "engagement": "active"
  },
  "connections": []
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

​
id
string
obrigatório

Identificador do assistente

Resposta

Successful response

​
id
string
obrigatório

Identificador do assistente

​
name
string
obrigatório

Nome do assistente

​
workspaceId
string
obrigatório

Identificador do workspace associado

​
createdBy
string | null
obrigatório

ID do usuário que criou o registro

​
updatedBy
string | null
obrigatório

ID do usuário que atualizou o registro

​
description
string | null

Instruções ao modelo de IA para direcionar a geração de respostas desejadas

​
avatar
object

Avatar do assistente

​
color
string
padrão:#ff5722

Cor associada ao assistente

​
welcome
string | null

Mensagem de boas-vindas do assistente

​
instructions
string | null

Instruções para o assistente

​
off
string | null

Mensagem quando o assistente não souber a resposta

​
references
boolean
padrão:false

Indica se o assistente usa referências

​
purpose
enum<string>
padrão:leads

Finalidade do assistente

Opções disponíveis:
general,
leads,
cs
​
freedom
enum<string>
padrão:restricted

Uso da base de conhecimento

Opções disponíveis:
free,
restricted
​
behavior_type
enum<string>
padrão:basic

Configuração de comportamento do assistente

Opções disponíveis:
basic,
custom
​
status
enum<string>
padrão:draft

Status do assistente

Opções disponíveis:
online,
offline,
draft
​
left
boolean
padrão:false

Posição do widget do assistente à esquerda da tela

​
createdAt
string<date-time>
padrão:2025-11-26T20:01:11.896Z

Data de criação

​
updatedAt
string<date-time>
padrão:2025-11-26T20:01:11.896Z

Data da última atualização

​
kbs
string[]

Bases de conhecimento associadas ao assistente

Identificador único da base de conhecimento

​
destinations
object[]

Destinos associados ao agente

​
fields
object[]

Campos do assistente

​
behavior
object

Comportamento configurável do assistente

​
connections
object[]

Conectores habilitados