Pular para o conteúdo

Importe conteúdo de fontes externas para a Base de Conhecimento. Estes endpoints processam o conteúdo de forma assíncrona.

Importe conteúdo de fontes externas para a Base de Conhecimento. Estes endpoints processam o conteúdo de forma assíncrona.

Todos os endpoints de importação processam o conteúdo de forma assíncrona. Após enviar uma requisição de importação, o conteúdo é extraído (scraped) e adicionado à Base de Conhecimento em segundo plano. Cada artigo importado é então processado automaticamente e entra no ar por conta própria — não há etapa de retreinamento para disparar.

Para acompanhar o progresso:

  1. Use List Articles para verificar se os artigos importados aparecem
  2. Aguarde pending_embed_count chegar a 0 em Get Knowledge Base Settings, ou verifique o embed_state de cada artigo até que ele indique "embedded"

Importações grandes entram no ar gradualmente, artigo por artigo, e não todas de uma vez.

Extraia (scrape) o conteúdo de uma única página da web ou de um site inteiro e importe-o.

Escopo: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/website

Request Body

ParameterDescription
url
string, required
URL a ser extraída
mode
string
"individual" (padrão), "site_wide" ou "individual_with_summary"
phrases
array of strings
Frases-chave a serem extraídas
html_selector
string
Seletor CSS para direcionar um conteúdo específico
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/website \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://example.com/docs",
"mode": "individual"
}'

Response 202 Accepted

{
"status": "success",
"url": "https://example.com/docs",
"article": {}
}

Importe a transcrição de um vídeo do YouTube.

Escopo: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/youtube

Request Body

ParameterDescription
url
string, required
URL do vídeo do YouTube
toast_process_uuid
string, required
UUID v4 para rastrear o processo de importação
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/youtube \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"toast_process_uuid": "550e8400-e29b-41d4-a716-446655440000"
}'

Response 202 Accepted — A transcrição é processada de forma assíncrona.

Importe conteúdo de todos os links de um sitemap XML.

Escopo: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/site-map

Request Body

ParameterDescription
site_map
string, required
URL de um sitemap XML
link_filter_regex
string
Regex para filtrar quais links importar (padrão: ".*")
html_selector
string
Seletor CSS para direcionar um conteúdo específico
summarize
boolean
Se o conteúdo importado deve ser resumido (padrão: false)
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/site-map \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"site_map": "https://example.com/sitemap.xml"
}'

Response 202 Accepted

{
"status": "success",
"links": ["https://example.com/page1", "https://example.com/page2"]
}

Importe conteúdo de uma lista específica de URLs.

Escopo: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/scrape-list

Request Body

ParameterDescription
links
array of strings, required
Lista de URLs a serem extraídas (não vazia)
tags
array of strings
Tags a aplicar aos artigos importados
html_selector
string
Seletor CSS para direcionar um conteúdo específico
summarize
boolean
Se o conteúdo importado deve ser resumido (padrão: false)
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/scrape-list \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"links": ["https://example.com/page1", "https://example.com/page2"],
"tags": ["imported"]
}'

Response 202 Accepted

{
"status": "success",
"links": ["https://example.com/page1", "https://example.com/page2"]
}

Remova da Base de Conhecimento artigos do tipo URL importados anteriormente.

Escopo: write_all

DELETE https://app.quickchat.ai/v1/api/knowledge_base/import_external

Request Body

ParameterDescription
links
array of strings, required
Lista de URLs a remover (mín. 1)

Todas as URLs fornecidas devem existir na Base de Conhecimento como artigos do tipo URL. Se alguma URL não corresponder a um artigo existente, a requisição retorna 404.

Terminal window
curl -X DELETE https://app.quickchat.ai/v1/api/knowledge_base/import_external \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"links": ["https://example.com/page1"]
}'

Response 200 OK