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>",
  "description": null,
  "avatar": null,
  "color": "#ff5722",
  "welcome": null,
  "instructions": null,
  "off": null,
  "references": false,
  "purpose": "leads",
  "freedom": "restricted",
  "behavior_type": "basic",
  "status": "draft",
  "fields": [
    "name",
    "email"
  ],
  "left": false,
  "forceLeadIdentification": false,
  "workspaceId": "<string>",
  "createdAt": "2025-07-21T17:52:50.020Z",
  "updatedAt": "2025-07-21T17:52:50.020Z",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "kbs": [],
  "destinations": [],
  "customFields": [],
  "behavior": {
    "answerLength": "short",
    "personality": "personal",
    "engagement": "active"
  },
  "agentPlugins": []
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Identificador do assistente

Response

Successful response

​
id
string
required

Identificador do assistente

​
name
string
required

Nome do assistente

​
workspaceId
string
required

Identificador do workspace associado

​
createdBy
string | null
required

ID do usuário que criou o registro

​
updatedBy
string | null
required

ID do usuário que atualizou o registro

​
description
string | null

Função do assistente

​
avatar
object | null

Avatar do assistente

​
color
string
default:#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
default:false

Indica se o assistente usa referências

​
purpose
enum<string>
default:leads

Finalidade do assistente

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

Uso da base de conhecimento

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

Configuração de comportamento do assistente

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

Status do assistente

Opções disponíveis:
online,
offline,
draft
​
fields
enum<string>[]

Campos de perguntas utilizados pelo assistente

​
left
boolean
default:false

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

​
forceLeadIdentification
boolean
default:false

Identificar lead automaticamente no início da conversa

​
createdAt
string<date-time>
default:2025-07-21T17:52:50.020Z

Data de criação

​
updatedAt
string<date-time>
default:2025-07-21T17:52:50.020Z

Data da última atualização

​
kbs
string[]

Bases de conhecimento associadas ao agente

Identificador único da base de conhecimento

​
destinations
object[]

Destinos associados ao agente

​
customFields
string[]

Campos personalizados do agente

Identificador único do campo

​
behavior
object | null

Comportamento configurável do agente

​
agentPlugins
object[]

Plugins associados ao agente e suas qualificações