Pular para o conteúdo principal
POST
/
agents
Criar assistente
curl --request POST \
  --url https://api.meuassistente.rdstationmentoria.com.br/rest/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": null,
  "purpose": "leads",
  "kbs": [],
  "fields": [
    "name",
    "email"
  ],
  "name": "<string>",
  "avatar": null,
  "color": "#ff5722",
  "status": "draft",
  "destinations": [],
  "behavior": {
    "answerLength": "short",
    "personality": "personal",
    "engagement": "active"
  },
  "behavior_type": "basic",
  "left": false,
  "customFields": []
}'
{
  "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.021Z",
  "updatedAt": "2025-07-21T17:52:50.021Z",
  "createdBy": "<string>",
  "updatedBy": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Nome do assistente

description
string | null

Função do assistente

purpose
enum<string>
default:leads

Finalidade do assistente

Opções disponíveis:
general,
leads,
cs
kbs
string[]

Bases de conhecimento associadas ao agente

Identificador único da base de conhecimento

fields
enum<string>[]

Campos de perguntas utilizados pelo assistente

avatar
object | null

Avatar do assistente

color
string
default:#ff5722

Cor associada ao assistente

status
enum<string>
default:draft

Status do assistente

Opções disponíveis:
online,
offline,
draft
destinations
object[]

Destinos associados ao agente

behavior
object | null

Comportamento configurável do agente

behavior_type
enum<string>
default:basic

Configuração de comportamento do assistente

Opções disponíveis:
basic,
custom
left
boolean
default:false

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

customFields
string[]

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.021Z

Data de criação

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

Data da última atualização