Endpoint

POST /createCatalog

Parâmetros

name
string
required

Nome do formulário.

scope
string
required

Escopo de captura: lead, conversation, global ou form.

description
string

Descrição do formulário.

generalInstructions
string

Instruções gerais para a IA durante a captura.

avatarId
string (UUID)

Vincula o formulário a um avatar específico.

variableIds
array de UUIDs

IDs das variáveis a associar ao formulário.

decisionChains
array

Cadeias de decisão acionadas durante a captura. Cada item contém type, description, content, canRepeat e agents.

Exemplo

curl -X POST {BASE_URL}/createCatalog \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Formulário de Contato",
    "scope": "lead",
    "description": "Captura dados de contato do lead",
    "variableIds": ["uuid-email", "uuid-phone"]
  }'

Resposta

{
  "id": "uuid",
  "host_id": "uuid",
  "avatar_id": null,
  "name": "Formulário de Contato",
  "description": "Captura dados de contato do lead",
  "general_instructions": null,
  "decision_chains": null,
  "scope": "lead",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Campos da Resposta

id
string
UUID do formulário criado.
avatar_id
string | null
UUID do avatar vinculado.
decision_chains
array | null
Cadeias de decisão configuradas.
scope
string
Escopo de captura.

Erros

CódigoDescrição
400Campos obrigatórios ausentes ou variáveis não encontradas
401Token inválido ou ausente
500Erro interno do servidor