Knowledge Base

A Base de Conhecimento é o núcleo da expertise do seu Agente de IA — ela contém todas as informações que sua IA usa para responder perguntas. Estes endpoints permitem gerenciar a configuração da Base de Conhecimento e acompanhar o status de processamento do seu conteúdo.

A Base de Conhecimento se baseia nos Articles que você cria, importa de sites ou envia como arquivos. Não existe etapa de retreinamento: cada artigo que você cria, atualiza ou exclui é processado automaticamente em segundo plano e tem efeito nas conversas assim que fica pronto.

Get Settings

Recupere a configuração da sua Base de Conhecimento.

Scope: read_all

GET https://app.quickchat.ai/v1/api/knowledge_base/

Shell

curl https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

Response 200 OK

{
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"],
  "pending_embed_count": 0,
  "failed_embed_count": 0
}

Field	Description
one_word_description string	Nome do Agente de IA. Dashboard: Identity > Profile > AI Agent Name
short_description string	System prompt / descrição do Agente de IA. Dashboard: Identity > Profile > AI Agent Description
ai_commands array of strings	Diretrizes de comportamento. Dashboard: Identity > Conversation Style > AI Guidelines
pending_embed_count integer	Artigos ainda em processamento. 0 significa que tudo o que você enviou está no ar
failed_embed_count integer	Artigos cujo processamento falhou. Reprocesse-os com Retry Failed Articles

Aguardando o conteúdo entrar no ar

Consulte este endpoint após uma escrita e aguarde pending_embed_count chegar a 0. O status por artigo também está disponível no campo embed_state em Articles.

Nota

Esses três campos (one_word_description, short_description, ai_commands) são compartilhados com Chatbot Settings. Atualizar por qualquer um dos endpoints modifica os mesmos dados subjacentes.

Update Settings

Scope: write_all

PATCH https://app.quickchat.ai/v1/api/knowledge_base/

Request Body

Parameter	Description
one_word_description string	Nome do Agente de IA
short_description string	System prompt / descrição do Agente de IA
ai_commands array of strings	AI Guidelines

Shell

curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "one_word_description": "Sales Bot"
}'

Python

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={"one_word_description": "Sales Bot"},
)
data = response.json()

Response 200 OK — Retorna as configurações da Base de Conhecimento atualizadas (mesmo schema de Get Settings).

Retry Failed Articles

Reprocessa todos os artigos cujo processamento falhou. Artigos que já estão no ar ou ainda em andamento não são afetados, e a chamada pode ser repetida com segurança.

Os artigos com falha também são reprocessados automaticamente, então este endpoint só é necessário quando você não quer esperar por isso.

Scope: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)

Response 200 OK

{
  "retried": 2
}

Field	Description
retried integer	Quantos artigos com falha foram enfileirados para reprocessamento

Retrain Knowledge Base Deprecated

POST https://app.quickchat.ai/v1/api/knowledge_base/retrain/

O retreinamento não existe mais — as alterações em artigos são processadas automaticamente. Este endpoint é mantido apenas para que integrações existentes continuem funcionando: ele aceita a requisição, não faz nada e retorna 200 OK.

Você pode remover a chamada da sua integração. Se você fazia polling até o retreinamento terminar, aguarde pending_embed_count chegar a 0 em Get Settings.

---