Learning in public — this reference is being written in the open. Unfinished pages are excluded from search engines.
paged.IDML Reference
The Paged PlatformREST API

REST API

The editor-server REST surface — authentication, files, account, billing, fonts, and image search — generated from the server's OpenAPI specification.

Tier: ProProIIIreference

In short the editor-server exposes a REST API for the editor's account, storage, billing, and asset features. The endpoints below are generated from the server's OpenAPI spec (which is itself generated from the server's Zod contracts), so this reference matches the running service.

Authentication is cookie-based (a better-auth session). All routes live under /api/*; the spec is also served live at the server's /openapi.json.

Paged Editor Server v0.1.0 · OpenAPI 3.0.3 · 74 endpoints · @ b1d62ce9

meta

Health and service metadata

GET/healthz
GET/readyz

files

User file storage

GET/api/v1/files
POST/api/v1/files
GET/api/v1/files/usage
GET/api/v1/files/{id}
DELETE/api/v1/files/{id}
GET/api/v1/files/{id}/content
PUT/api/v1/files/{id}/content

billing

Subscriptions and invoices

GET/api/v1/billing/subscription
GET/api/v1/billing/invoices

account

Profile and account management

GET/api/v1/account/profile
PATCH/api/v1/account/profile
POST/api/v1/account/email
POST/api/v1/account/password
GET/api/v1/account/sessions
DELETE/api/v1/account/sessions
POST/api/v1/account/sessions/revoke
POST/api/v1/account/delete
POST/api/v1/account/export

fonts

Google Fonts catalog and proxy

GET/api/v1/fonts
GET/api/v1/fonts/{family}/{variant}

images

Image meta-search (Pexels + Unsplash)

GET/api/v1/images/search
POST/api/v1/images/{provider}/{id}/use

dev

Development-only helpers

POST/api/dev/login-as

automation

POST/api/v1/generate
GET/api/v1/generate/{jobId}

Default

POST/api/auth/sign-in/socialsocialSignIn
GET/api/auth/callback/{id}
POST/api/auth/callback/{id}
GET/api/auth/get-sessiongetSession
POST/api/auth/get-sessiongetSessionPost
POST/api/auth/sign-outsignOut
POST/api/auth/sign-up/emailsignUpWithEmailAndPassword
POST/api/auth/sign-in/emailsignInEmail
POST/api/auth/reset-passwordresetPassword
POST/api/auth/verify-passwordverifyPassword
GET/api/auth/verify-email
POST/api/auth/send-verification-emailsendVerificationEmail
POST/api/auth/change-emailchangeEmail
POST/api/auth/change-passwordchangePassword
POST/api/auth/update-sessionupdateSession
POST/api/auth/update-userupdateUser
POST/api/auth/delete-userdeleteUser
POST/api/auth/request-password-resetrequestPasswordReset
GET/api/auth/reset-password/{token}resetPasswordCallback
GET/api/auth/list-sessionslistUserSessions
POST/api/auth/revoke-session
POST/api/auth/revoke-sessions
POST/api/auth/revoke-other-sessions
POST/api/auth/link-sociallinkSocialAccount
GET/api/auth/list-accountslistUserAccounts
GET/api/auth/delete-user/callback
POST/api/auth/unlink-account
POST/api/auth/refresh-token
POST/api/auth/get-access-token
GET/api/auth/account-info
GET/api/auth/ok
GET/api/auth/error

Admin

POST/api/auth/admin/set-rolesetUserRole
GET/api/auth/admin/get-usergetUser
POST/api/auth/admin/create-usercreateUser
POST/api/auth/admin/update-useradminUpdateUser
GET/api/auth/admin/list-userslistUsers
POST/api/auth/admin/list-user-sessionsadminListUserSessions
POST/api/auth/admin/unban-userunbanUser
POST/api/auth/admin/ban-userbanUser
POST/api/auth/admin/impersonate-userimpersonateUser
POST/api/auth/admin/stop-impersonating
POST/api/auth/admin/revoke-user-sessionrevokeUserSession
POST/api/auth/admin/revoke-user-sessionsrevokeUserSessions
POST/api/auth/admin/remove-userremoveUser
POST/api/auth/admin/set-user-passwordsetUserPassword
POST/api/auth/admin/has-permission