API documentation

Public integration boundaries

Alexandria supplies shared book intelligence through its consumer API. Stache owns user-specific library and reading state. Integrations must use the API for the service that owns the data. A shared book identifier does not grant access to a reader's personal records.

All products are In development. There is no approved versioned public API reference linked here yet. Endpoint URLs, authentication headers, request schemas, generated-client packages and compatibility guarantees must come from an approved release's public reference. Do not infer them from this overview.

Prepare an integration

1. Decide whether the integration needs shared book information or user-specific state.
2. Identify the supported server and API versions before choosing a client library.
3. Use documented authentication and keep credentials server-side where appropriate.
4. Handle authorization failures, missing records and temporary service failures explicitly.
5. Use documented pagination and rate limits; do not assume one response contains every result.

Avoid blindly retrying writes after a timeout. Determine whether the original operation succeeded or use a documented idempotency mechanism when available. Treat returned book descriptions and other external text as untrusted content.

Compatibility and reporting

Test against a disposable installation before using personal data. Record versions and redact credentials from request examples. For a failure report, include the operation, response status and expected behavior, without private library contents. See upgrades and troubleshooting.