API REST

A Next Wiki traz uma API REST para ler e escrever tudo no seu workspace — documentos, coleções, tags, membros e mais. Toda rota fica sob /api na sua instância.

URL base: https://SUA-WIKI/api — troque SUA-WIKI pelo seu host (ex.: https://wiki.suaempresa.com).

Autenticação

Todas as requisições autenticam com uma chave de API pessoal. Crie uma em Configurações → API (ou POST /api/chaves). A chave é exibida uma única vez e começa com nwk_.

Envie-a em toda requisição, em um dos cabeçalhos:

curl https://SUA-WIKI/api/workspaces \
  -H "X-Api-Key: nwk_seu_token"

# ou
curl https://SUA-WIKI/api/workspaces \
  -H "Authorization: Bearer nwk_seu_token"

Escopos. A chave pode ser irrestrita (acesso total, com as permissões do dono) ou limitada a escopos:

Escopo	Concede
`docs:ler`	ler documentos e metadados
`docs:escrever`	criar e atualizar documentos

Documentos

Método	Rota	Descrição
`GET`	`/documentos/{id}`	Obter documento (metadados + markdown)
`POST`	`/documentos`	Criar documento
`PUT`	`/documentos/{id}/conteudo`	Salvar markdown (título/conteúdo)
`PATCH`	`/documentos/{id}/renomear`	Renomear
`PATCH`	`/documentos/{id}/mover`	Mover para outra coleção
`PATCH`	`/documentos/{id}/tipo`	Definir tipo de documento
`PUT`	`/documentos/{id}/tags`	Definir tags
`POST`	`/documentos/{id}/publicar`	Gerar link público
`POST`	`/documentos/{id}/despublicar`	Remover o link público
`GET`	`/documentos/{id}/comentarios`	Listar comentários
`POST`	`/documentos/{id}/comentarios`	Criar comentário
`GET`	`/documentos/{id}/versoes`	Listar versões
`GET`	`/documentos/{id}/versoes/{n}`	Obter uma versão
`POST`	`/documentos/{id}/versoes/{n}/restaurar`	Restaurar versão
`POST`	`/documentos/{id}/arquivar`	Arquivar
`POST`	`/documentos/{id}/restaurar`	Restaurar da lixeira
`DELETE`	`/documentos/{id}`	Excluir definitivamente

Coleções

Método	Rota	Descrição
`GET`	`/colecoes/{id}`	Obter coleção
`GET`	`/colecoes/{id}/documentos`	Listar documentos dela
`POST`	`/colecoes`	Criar coleção
`PATCH`	`/colecoes/{id}`	Atualizar
`DELETE`	`/colecoes/{id}`	Excluir
`GET` `PUT`	`/colecoes/{id}/permissoes`	Ler/gravar permissões (owner)

Workspaces e busca

Método	Rota	Descrição
`GET`	`/workspaces`	Listar workspaces
`GET`	`/workspaces/{id}`	Obter um workspace
`POST`	`/workspaces`	Criar workspace
`GET`	`/workspaces/{id}/arvore`	Árvore (coleções + documentos)
`GET`	`/workspaces/{id}/busca?q=`	Busca por texto
`GET`	`/workspaces/{id}/busca-semantica?q=`	Busca semântica (se ativada)
`GET`	`/workspaces/{id}/lixeira`	Lixeira (documentos arquivados)

Tags e favoritos

Método	Rota	Descrição
`GET` `POST`	`/workspaces/{wid}/tags`	Listar / criar tags
`DELETE`	`/workspaces/{wid}/tags/{id}`	Excluir tag
`GET`	`/favoritos`	Listar documentos favoritos do usuário

Membros e grupos

Método	Rota	Descrição
`GET`	`/workspaces/{wid}/membros`	Listar membros
`POST`	`/workspaces/{wid}/convites`	Convidar alguém
`GET` `POST`	`/workspaces/{wid}/grupos`	Listar / criar grupos
`PUT` `DELETE`	`/grupos/{id}`	Atualizar / excluir grupo
`POST` `DELETE`	`/grupos/{id}/membros/{userId}`	Adicionar / remover membro do grupo

Webhooks

Assine eventos e receba um POST assinado a cada mudança.

Método	Rota	Descrição
`GET`	`/webhooks/eventos`	Catálogo de eventos disponíveis
`GET` `POST`	`/workspaces/{wid}/webhooks`	Listar / criar webhook
`PUT` `DELETE`	`/webhooks/{id}`	Atualizar / excluir
`GET`	`/webhooks/{id}/entregas`	Últimas entregas (log)
`POST`	`/webhooks/{id}/testar`	Enviar evento de teste

Assinatura. Cada entrega é assinada (HMAC-SHA256) no cabeçalho NextWiki-Signature: t=<unix>,s=<hex>, onde o payload assinado é "<unix>.<corpo>". O evento também vem em NextWiki-Event.

Chaves de API

Método	Rota	Descrição
`GET`	`/chaves`	Listar suas chaves
`POST`	`/chaves`	Criar chave (retorna o token uma vez)
`PATCH`	`/chaves/{id}/renomear`	Renomear
`POST`	`/chaves/{id}/revogar`	Revogar
`DELETE`	`/chaves/{id}`	Excluir

Quer que um agente de IA ou IDE leia e edite a wiki? Veja o servidor MCP.

Referência da API