Skip to main content
POST
Criar assistente

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
name
string
obrigatório

Nome do assistente

description
string | null

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

purpose
enum<string>
padrão:leads

Finalidade do assistente

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

Bases de conhecimento associadas ao assistente

Identificador único da base de conhecimento

fields
object[]

Campos do assistente

avatar
object | null

Avatar do assistente

color
string
padrão:#ff5722

Cor associada ao assistente

Pattern: ^#[0-9a-fA-F]{6}$
status
enum<string>
padrão:draft

Status do assistente

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

Destinos associados ao agente

behavior
object | null

Comportamento configurável do assistente

behavior_type
enum<string>
padrão:basic

Configuração de comportamento do assistente

Opções disponíveis:
basic,
custom
left
boolean
padrão:false

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

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 | null

Avatar do assistente

color
string
padrão:#ff5722

Cor associada ao assistente

Pattern: ^#[0-9a-fA-F]{6}$
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:2026-02-08T00:20:48.487Z

Data de criação

updatedAt
string<date-time>
padrão:2026-02-08T00:20:48.487Z

Data da última atualização