VolundOS
Referência da APIConhecimento

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.

Atualizado em 04 de novembro de 2026
GET
/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

Query Parameters

limit?integer

Documentos por página (1 a 200, padrão 50).

offset?integer

Deslocamento em documentos (padrão 0).

path_prefix?string

Filtra pelo começo do caminho (ex.: files/pasta/).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/knowledge/bases/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents"
{  "documents": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "summary": "string",      "status": "string",      "storage_path": "string",      "char_count": 0,      "version": 0,      "created_at": "2019-08-24T14:15:22Z",      "kind": "markdown",      "path": "string",      "mime_type": "string",      "size_bytes": 0    }  ],  "total": 0,  "offset": 0,  "limit": 0,  "has_more": true}

Excluir base de conhecimento

Exclui a base e todos os documentos dela. Só o dono. Exige o escopo knowledge:write.

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.