ApiaryLens.devOpen Source Apiary Intelligence

OpenAPI 3.1 · API 1.0.0

One contract.
Every supported backend.

The Node/SQLite Compose profile and Cloudflare D1/R2 profile expose the same organization-scoped API and synchronization behavior.

OpenAPI JSONContract guide
Authentication

Browser clients use secure opaque sessions and rotating CSRF tokens. Long-lived bearer tokens are not stored in the browser.

24 generated operations

GET
/bootstrap/status

Check whether first-owner setup is available

Identity
POST
/bootstrap

Create the first owner and family

Identity
POST
/auth/sign-in

Start a secure browser session

Identity
POST
/auth/recover

Consume a recovery code and replace the account password

Identity
GET
/session

Rotate and read the current authenticated session

Identity
POST
/session/revoke-others

Revoke every other session for the current user

Identity
POST
/auth/sign-out

Revoke the current session

Identity
GET
/members

List active members in the current family

Identity
DELETE
/members/{membershipId}

Remove a non-owner family member and revoke their sessions

Identity
GET
/invitations

List unexpired pending invitations for the current family

Identity
POST
/invitations

Create an expiring family invitation

Identity
DELETE
/invitations/{invitationId}

Revoke a pending invitation

Identity
POST
/invitations/{invitationId}/replace

Revoke a pending invitation and create a replacement link

Identity
POST
/invitations/accept

Accept a family invitation

Identity
POST
/sync/push

Apply an ordered idempotent mutation batch

Synchronization
GET
/sync/pull

Read organization changes after an opaque cursor

Synchronization
GET
/resources/{type}

List active records of one resource type

Resources
GET
/resources/{type}/{id}

Read one active organization-scoped record

Resources
GET
/media/{id}/content

Download authorized original image

Media
PUT
/media/{id}/content

Upload and integrity-check original image

Media
DELETE
/media/{id}/content

Delete private image content

Media
PUT
/media/{id}/thumbnail

Upload an authorized JPEG thumbnail

Media
GET
/export/full

Download structured data, CSV files, and original media

Ownership
POST
/import/full

Restore the workspace from a full export archive, replacing current records

Ownership