Pathnovo API

Version 0.1.0 · Base path /api/v1

The Pathnovo REST API exposes 35 endpoints across 8 resource groups. Most endpoints require a bearer token obtained from POST /auth/login.

Authentication

Every authenticated endpoint expects the header:

Authorization header

Authorization: Bearer <access_token>

Tokens expire; use POST /auth/refresh to rotate.

Resource groups

User registration, login, token refresh, and profile endpoints. All authenticated requests use a bearer token obtained here.

Organisation-scoped user and role management. Most endpoints require the caller to be an org admin.

Project CRUD within an organisation, plus project membership and per-project settings.

Upload, batch upload, and URL import. Returns a job ID immediately (202) — use the status endpoints to poll.

Retrieve and override document classification, plus per-project accuracy metrics.

Job status, results, document types, pipelines, and the config-resolution preview (default → org → project cascade).

SharePoint integration

Webhook receivers for SharePoint change notifications and a connect endpoint to pair a library with a Pathnovo package.

Liveness and readiness probes for Kubernetes / load balancers.

Conventions

All request and response bodies are JSON unless noted (e.g. uploads use multipart/form-data).
Upload endpoints return 202 Accepted with a job ID — poll the status endpoint or subscribe to SSE progress.
Timestamps are ISO-8601 UTC; IDs are UUIDv4.
Errors follow FastAPI's standard shape: {"detail": "…"}.

Replies within 2 min