VolundOS
Referência da APIConhecimento

Criar documento

Markdown em JSON (`name`, `content`), ou um arquivo em multipart no campo `file`, até 4MB. Com `mode=extract` (o padrão) o arquivo (PDF, DOCX, planilha, texto) é convertido em markdown pelo mesmo extrator da tela. Com `mode=file` ele é guardado como veio (imagem, PDF, planilha, zip...), no caminho `path`. Com `document_id`, os bytes substituem os daquele documento. Arquivos maiores: `uploads`. Exige poder editar a base. Exige o escopo knowledge:write.

Atualizado em 04 de novembro de 2026
POST
/v1/knowledge/bases/{baseId}/documents

Authorization

chaveDeApi
AuthorizationBearer <token>

Chave de API da organização, criada nas configurações. Envie-a em Authorization: Bearer <sua chave>.

In: header

Path Parameters

baseId*string
Formatuuid

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/knowledge/bases/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "content": "string"  }'
{  "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",  "summary": "string",  "chars": 0,  "kind": "markdown",  "path": "string",  "mime_type": "string",  "size_bytes": 0,  "version": 0}

Listar documentos

Paginado e ordenado pelo caminho do documento, que é a identidade dele na base. Cada documento traz `kind` (`markdown` ou `file`) e `path`; arquivos trazem também `mime_type` e `size_bytes`. Exige o escopo knowledge:read.

Ler documento

Markdown: o documento com o conteúdo completo em `content`. Arquivo (`kind: file`): sem `content`, com `download_url`, um link assinado para baixar os bytes, válido por `download_expires_in` segundos. Exige o escopo knowledge:read.