Powered by NovaDocs
Welcome to NovaDocsStart with Installation → Install with Docker, or switch language to Polish (PL).

API endpoints

Admin6 min readUpdated Aug 7, 2026

API endpoints

Base path: /api/v1

Unless noted, send Authorization: Bearer nd_....

Projects

MethodPathDescription
GET/api/v1/projectsList projects
POST/api/v1/projectsCreate project
GET/api/v1/projects/:idGet one project
PATCH/api/v1/projects/:idUpdate project
DELETE/api/v1/projects/:idDelete project

Articles

MethodPathDescription
GET/api/v1/articles?projectId=List articles
POST/api/v1/articlesCreate article
GET/api/v1/articles/:idGet article
PATCH/api/v1/articles/:idUpdate article
DELETE/api/v1/articles/:idDelete article

Create example:

bash
curl -X POST https://your-domain.com/api/v1/articles \
  -H "Authorization: Bearer nd_your_key" \
  -H "Content-Type: application/json" \
  -d "{\"projectId\":\"PROJECT_ID\",\"title\":\"Hello\",\"contentMarkdown\":"# Hello\\n\\nWorld\" }"

Categories

MethodPathDescription
GET/api/v1/categories?projectId=List categories
POST/api/v1/categoriesCreate category

Media

MethodPathDescription
GET/api/v1/media?projectId=List media files
MethodPathDescription
GET/api/v1/search?q=&projectId=Search articles

Webhooks

MethodPathDescription
POST/api/v1/webhooks/testSend a test delivery

Body: { "webhookId": "..." }

Import / export / tools

MethodPathDescription
GET/api/export/markdown?projectId=Markdown ZIP
GET/api/export/json?projectId=JSON dump
POST/api/import/markdownImport Markdown
POST/api/sync/githubSync from GitHub
POST/api/broken-links/scanScan broken links

Full table with notes: open /api-docs on your installation.

Was this helpful?