Ir para o conteúdo

Documentos

Ingestão de texto e arquivos, listagem, remoção e export completo da base.

Atualizado em 10 de ago. de 2026

Dois caminhos de entrada: texto puro em JSON, ou arquivo em multipart/form-data. Nos dois a indexação é síncrona — extração, corte em trechos (512 tokens com sobreposição de 50, ajustáveis) e embedding acontecem na chamada, e a resposta já confirma chunks e embed_tokens. O documento sai nas buscas imediatamente.

POSThttps://api.hinow.ai/v1/rag/documentsBearer

Indexa um texto na base.

Parâmetros

  • rag_idstring· bodyobrigatório

    A base de destino.

  • textstring· bodyobrigatório

    O conteúdo.

  • filenamestring· body

    Nome/origem exibido nas buscas. Padrão `document.txt`.

  • document_idstring· body

    Reenviar com o mesmo id substitui o documento (idempotente).

  • metadataobject· body

    Pares livres, devolvidos nas buscas.

  • chunk_sizeinteger· body

    Tokens por trecho. Padrão 512.

  • chunk_overlapinteger· body

    Sobreposição entre trechos. Padrão 50.

Respostas

200Documento indexado
{
  "document_id": "7bfee913effd4d40bac1c80a3daff25f",
  "chunks": 1,
  "embed_tokens": 21
}
POSThttps://api.hinow.ai/v1/rag/documents/uploadBearer

Envia um arquivo (multipart/form-data). PDF, DOCX, PPTX, XLSX, HTML, Markdown e qualquer texto — veja a tabela de formatos na página RAG.

Parâmetros

  • filefile· bodyobrigatório

    Até 25 MB.

  • rag_idstring· bodyobrigatório
  • document_idstring· body

    Substituição idempotente, como no texto.

Respostas

200Arquivo extraído e indexado
{
  "document_id": "ef01480c509642298911297df854885f",
  "chunks": 1,
  "embed_tokens": 18
}
415Formato legado (.doc/.xls) — converta antes
422Arquivo corrompido ou ilegível

O tamanho do trecho é a decisão que mais pesa

Trechos curtos acertam o parágrafo mas perdem o contexto em volta; trechos longos trazem contexto e diluem a similaridade. O padrão de 512 tokens funciona bem para documentação e políticas; para FAQ puro, prefira pares de pergunta e resposta.

GEThttps://api.hinow.ai/v1/rag/documentsBearer

Lista os documentos da base.

Parâmetros

  • rag_idstring· queryobrigatório

Respostas

200Documentos com contagem de trechos
{
  "documents": [
    {
      "document_id": "ef01480c...",
      "source": "garantia.pdf",
      "chunk_count": 1,
      "metadata": { "filename": "garantia.pdf", ... }
    }
  ]
}
DELETEhttps://api.hinow.ai/v1/rag/documents/{document_id}Bearer

Remove um documento. Ele vai para a lixeira e pode ser restaurado por 15 dias.

Parâmetros

  • document_idstring· pathobrigatório
  • rag_idstring· queryobrigatório

Respostas

200Removido (com cópia na lixeira)
{
  "document_id": "56ef03f5...",
  "deleted": true,
  "trashed": true
}
404Documento fora do escopo/base informados
GEThttps://api.hinow.ai/v1/rag/documents/exportBearer

Exporta a base inteira com o texto completo de cada documento — backup e migração.

Parâmetros

  • rag_idstring· queryobrigatório

Respostas

200Todos os documentos com texto completo
{
  "rag_id": "1d9cf4ae...",
  "count": 7,
  "documents": [
    { "document_id": "...", "source": "trocas.docx", "text": "...", "metadata": {...} }
  ]
}

Exemplo

# texto puro
curl -s https://api.hinow.ai/v1/rag/documents \
  -H "Authorization: Bearer hi_SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rag_id": "1d9cf4ae05f64a9faf987981b22cdeae",
    "text": "O cancelamento pode ser feito a qualquer momento no painel, sem multa.",
    "filename": "cancelamento.txt"
  }'

# arquivo
curl -s https://api.hinow.ai/v1/rag/documents/upload \
  -H "Authorization: Bearer hi_SUA_API_KEY" \
  -F "file=@precos.xlsx" \
  -F "rag_id=1d9cf4ae05f64a9faf987981b22cdeae"
Esta página foi útil?