Visão Geral

A base de conhecimento é o material que seus assistentes consultam para responder seus leads: políticas, tabelas de preço, manuais, perguntas frequentes. Cada item pode ser criado a partir de um texto ou de um arquivo enviado.

Escopo: global ou de um assistente

Todo item de conhecimento tem um escopo, definido pelo campo assistant_id:

`assistant_id`	Escopo	Quem enxerga
ausente ou `null`	Global	Todos os assistentes do tenant
UUID de um assistente	Exclusivo	Apenas aquele assistente

Um item exclusivo pertence a um único assistente. Para compartilhar o mesmo material entre alguns assistentes — mas não todos — deixe o item global e use as exclusões.

Exclusões: recortando um item global

Itens globais aceitam uma lista excluded_assistant_ids. Os assistentes nessa lista deixam de enxergar aquele conhecimento, mesmo ele sendo global.

Item global "Tabela de preços"
  excluded_assistant_ids: ["assistente-suporte"]

  → Assistente de Vendas  ✅ enxerga
  → Assistente de Suporte ❌ não enxerga

Exclusões só se aplicam a itens globais. Tentar excluir um assistente de um item que já tem assistant_id preenchido retorna 409.

Formatos de arquivo aceitos

Categoria	Extensões
Texto	`.txt`, `.md`, `.mdx`, `.rst`, `.adoc`
Documento	`.pdf`, `.html`
Planilha	`.xlsx`, `.xls`, `.csv`

O limite é de 10 MB por arquivo. O conteúdo é extraído como texto e indexado — imagens dentro do arquivo não são interpretadas.

Instrução de uso

O campo opcional usage_instruction (até 2000 caracteres) orienta o assistente sobre quando recorrer àquele conhecimento. É útil quando você tem vários itens parecidos:

{
  "name": "Tabela de preços 2026",
  "usage_instruction": "Use apenas quando o lead perguntar valores. Nunca cite preços de anos anteriores."
}

Objeto de conhecimento

{
  "id": "9f1c2d34-5678-4abc-9def-0123456789ab",
  "tenant_id": "d6b10acc-2307-413f-a4de-4c2edf3f9a70",
  "name": "Política de trocas",
  "description": "Regras de troca e devolução",
  "content": "Trocas em até 30 dias mediante nota fiscal...",
  "source_url": null,
  "usage_instruction": "Use quando o lead perguntar sobre troca ou devolução.",
  "assistant_id": null,
  "excluded_assistant_ids": ["3f8a1b2c-4d5e-6f70-8192-a3b4c5d6e7f8"],
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-02-02T09:12:00Z"
}

Campo	Tipo	Descrição
`id`	UUID	Identificador do conhecimento
`tenant_id`	UUID	Organização dona do item
`name`	string	Nome de exibição (1–255 caracteres)
`description`	string	Descrição livre (até 1000 caracteres)
`content`	string	Texto indexado
`source_url`	string \| null	Preenchido quando o item veio de uma URL
`usage_instruction`	string \| null	Quando usar este conhecimento (até 2000)
`assistant_id`	UUID \| null	`null` = global
`excluded_assistant_ids`	array	Assistentes sem acesso (só para itens globais)

Endpoints

Método	Rota	Descrição
`GET`	`/backend/knowledge`	Listar
`GET`	`/backend/knowledge/{id}`	Obter
`POST`	`/backend/knowledge`	Criar
`PUT`	`/backend/knowledge/{id}`	Atualizar
`DELETE`	`/backend/knowledge/{id}`	Excluir
`PUT`	`/backend/knowledge/{id}/exclusions`	Definir exclusões
`POST`	`/backend/knowledge/{id}/exclusions/{assistantId}`	Excluir um assistente
`DELETE`	`/backend/knowledge/{id}/exclusions/{assistantId}`	Restaurar um assistente

Todos os endpoints operam apenas sobre o conhecimento da organização dona da chave de API usada na requisição. Não é possível ler ou alterar dados de outra organização.

Leads

Status

Tags

Base de Conhecimento

Pipeline (CRM)

Webhooks

Campos Personalizados

Cadências

Conversas

Mensagens

Departamentos

Upload de Arquivos

Templates (Meta/Gupshup)

Follow-up

Visão Geral

Escopo: global ou de um assistente

Exclusões: recortando um item global

Formatos de arquivo aceitos

Instrução de uso

Objeto de conhecimento

Endpoints

​Escopo: global ou de um assistente

​Exclusões: recortando um item global

​Formatos de arquivo aceitos

​Instrução de uso

​Objeto de conhecimento

​Endpoints

Escopo: global ou de um assistente

Exclusões: recortando um item global

Formatos de arquivo aceitos

Instrução de uso

Objeto de conhecimento

Endpoints