API reference
A JSON API over the pages, databases, members and settings of a hosted Lydie workspace.
View as MarkdownEvery endpoint is generated from the operations the Lydie app itself runs, so the API can do what the app can. The full OpenAPI 3.1 document works with code generators and API clients.
- Send a token in the
Authorizationheader. See Authentication. GETandDELETEtake their input as query parameters. Other methods take a JSON body.- Document ids are ULIDs. Timestamps are ISO 8601 in UTC.
- Errors share one envelope. See Errors and versions.
https://api.lydie.co/v1Lydie-Version: 2026-11-12Resources
- Documents21 endpointsPages in a workspace: a tree of documents, each with a title, typed properties (frontmatter) and a Markdown body.
- Databases36 endpointsA database is a document whose children are its rows. Each row is a document; its values are the row's properties.
- Attachments8 endpointsFiles attached to a workspace or a document, stored by their SHA-256 hash. Upload the bytes first, then record the attachment.
- Trash2 endpointsDeleted documents and attachments stay in the trash until they are restored or purged.
- History3 endpointsSessions group the changes an agent made, so they can be reviewed and undone together.
- Workspaces4 endpointsA workspace holds documents, members and teamspaces. An API token belongs to exactly one.
- Members4 endpointsPeople in a workspace and their roles: owner, admin, member or guest.
- Teamspaces11 endpointsGroups of pages with their own members. Open teamspaces are visible to every member; closed and private ones are not.
- Invitations7 endpointsEmail invitations to join a workspace.
- Sharing9 endpointsWho can see a page: grants to people, teamspaces or the whole workspace, restricted pages, and public links.
- Notifications6 endpointsYour inbox: mentions, shares and accepted invitations.
- Publishing17 endpointsPublish documents to GitHub, WordPress or a webhook. A connection holds the credentials; a publication says what goes where.
- API tokens3 endpointsPersonal API tokens. These endpoints need a signed-in session: a token cannot create or list tokens.
- Connected apps2 endpointsApps you allowed through OAuth, such as MCP clients. Signed-in session only.