Open API Docs

This guide is for developers who want to integrate with the platform programmatically. It covers the current public API surface, signing rules, field constraints, error handling, and practical request examples.

What you can do with the API

• Read document lists
• Read a single document
• Create a document
• Update a document
• Delete a document

Current public scope

The current public API focuses on document resources under the base path below:

/api/open/documents

Recommended reading order

1. Start with "Quick Start" to prepare credentials and complete the first signed request.
2. Then read "Signature Authentication" to confirm the signing string, timestamp, and body hash rules.
3. Finally, read the endpoint-specific chapters you need.

Important constraints

• Every public API request requires RSA signature authentication.
• The document detail endpoint uses document id, not slug.
• Child documents inherit the top-level category and cannot define their own category independently.
• If the category of a top-level document changes, the entire subtree is updated together.