Skip to main content
POST
Criar agente

Authorizations

x-jurichat-api-key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header x-jurichat-api-key.

Body

application/json
name
string
required

Nome do agente.

communicationStyle
string
required

Estilo de comunicação do agente.

behavior
string
required

Comportamento esperado do agente.

purpose
string
required

Objetivo do agente.

agentModelId
string
required

ID do modelo de LLM.

Pattern: ^[cC][^\s-]{8,}$
inboxId
string
required

ID da inbox.

Pattern: ^[cC][^\s-]{8,}$
avatarUrl
string

URL do avatar do agente.

productName
string

Nome do produto ou escritório.

productSite
string

Site do produto ou escritório.

productDescription
string

Descrição do produto ou escritório.

canRequestHumanHelp
boolean
default:false

Permite solicitar atendimento humano.

canCreateTickets
boolean
default:false

Permite criar tickets automaticamente.

restrictToAllowedTopics
boolean
default:false

Restringe o agente aos tópicos permitidos.

allowConsultingProcesses
boolean
default:false

Permite consultar processos.

responseDelaySeconds
number | null

Atraso em segundos antes de responder. Null para imediato.

maxInteractionsPerSession
number | null

Limite de interações por sessão. Null para ilimitado.

endTriggerResolvedIntentEnabled
boolean
default:false

Encerra a conversa quando a IA avalia que a dúvida do cliente foi respondida.

endTriggerUserRequestEnabled
boolean
default:false

Encerra a conversa quando o cliente pede explicitamente para encerrar.

endTriggerInactivityEnabled
boolean
default:false

Encerra a conversa após um tempo de silêncio do cliente.

endTriggerInactivityMinutes
integer | null

Minutos de silêncio antes do encerramento por inatividade. Null usa 30.

Required range: 1 <= x <= 10080
endTriggerAction
enum<string>
default:END_WITHOUT_MESSAGE

Ação aplicada a qualquer gatilho de encerramento que disparar.

Available options:
END_WITHOUT_MESSAGE,
END_WITH_FAREWELL
endTriggerFarewellMessage
string | null

Mensagem de despedida. Usada só com END_WITH_FAREWELL.

Maximum string length: 512
activePeriodEnabled
boolean
default:false

Ativa o horário de funcionamento do agente.

activePeriodPreset
enum<string>

Preset de horário de funcionamento.

Available options:
CUSTOM,
BUSINESS_HOURS,
EXTENDED_HOURS,
WEEKENDS_ONLY,
TWENTY_FOUR_SEVEN
idleActions
object[]
transferRules
object[]
ticketRules
object[]
tagRules
object[]
crmRules
object[]
customSchedule
object[]

Response

Default Response

id
string
required
Pattern: ^[cC][^\s-]{8,}$
name
string
required
avatarUrl
string | null
required
communicationStyle
string
required
behavior
string
required
purpose
string
required
agentModelId
string
required
Pattern: ^[cC][^\s-]{8,}$
productName
string | null
required
productSite
string | null
required
productDescription
string | null
required
canRequestHumanHelp
boolean
required
canCreateTickets
boolean
required
restrictToAllowedTopics
boolean
required
responseDelaySeconds
number | null
required
maxInteractionsPerSession
number | null
required
endTriggerResolvedIntentEnabled
boolean
required
endTriggerUserRequestEnabled
boolean
required
endTriggerInactivityEnabled
boolean
required
endTriggerInactivityMinutes
number | null
required
endTriggerAction
string
required
endTriggerFarewellMessage
string | null
required
inboxId
string
required
activePeriodEnabled
boolean
required
activePeriodPreset
string | null
required
allowConsultingProcesses
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
idleActions
object[]
required
transferRules
object[]
required
ticketRules
object[]
required
tagRules
object[]
required
crmRules
object[]
required
customSchedule
object[] | null
required