Docana Platform API
REST API of the Docana platform. Authenticate with a personal API key (Authorization: ApiKey <key>) or reuse the browser session cookie. /api/v1/ is the canonical, versioned surface. The same operations also answer on the versionless /api/ paths, which exist as permanent aliases. All paths use a trailing slash: requests without one are redirected with a 308, which drops the body of POST requests in most HTTP clients.
Authentication
- API Key: apiKey
- API Key: sessionCookie
Personal API key, sent as Authorization: ApiKey <key>. Keys are created self-serve in the platform settings with one of three scopes (see x-key-scopes). Scope-restricted operations reject a key outside their scope with 403.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |
Browser session cookie set by the platform login.
Security Scheme Type: | apiKey |
|---|---|
Cookie parameter name: | SID |