Overview

Orimora REST API (1.0.0)

Programmatic access to documents and collections on your Orimora workspace.

Human-readable guide: see the docs site REST API overview (authentication, scopes, pagination, incremental sync).

Authentication

Create an API key under Settings → Developers (prefix kb_). Send it as a Bearer token on every request:

Authorization: Bearer kb_your_api_key_here

Keys carry scopes such as read, write, and admin. Narrow scopes for integrations.

Base URL

Use your deployment origin (same host as the web app), for example:

https://wiki.example.com

Rate limiting (typical deployment)

• All /api/* routes: about 100 requests per minute per authenticated user or client IP (sliding window; 429 when exceeded).
• Health check GET /api/health is not subject to this global limit.

Responses may include X-RateLimit-Limit, X-RateLimit-Remaining, and on throttle Retry-After with JSON { "error", "retryAfterSeconds" }.

Pagination and incremental sync

• Standard list: use limit (max 100, default 25) and offset; response includes total.
• Incremental sync: pass updatedSince (ISO 8601). Response shape omits classic total pagination; optionally add format=markdown for a markdownText field per row.

Errors

JSON error bodies generally look like { "error": "message" } with HTTP 4xx/5xx.

• Orimora: https://github.com/defcon1702/orimora
• License: MIT
• OpenAPI version: 3.1.0

Authentication

BearerAuth

API key issued from Settings → Developers. Prefix: kb_

Security scheme type: http