All paths are relative to https://pkgplane.richaisolutions.com. For request and response schemas,
and to try a call in the browser, open the API explorer.
The machine-readable OpenAPI 3.1 document is at
/api/openapi.json.
System
| Method | Path | Does | Accepts |
|---|---|---|---|
GET |
/api/health |
Reports the version, build time and whether the database answers | Public |
Account
| Method | Path | Does | Accepts |
|---|---|---|---|
GET |
/api/me |
Returns the account the request acts as | Session or API key |
API keys
These accept a session only, so an API key can’t manage keys. See Accounts and access.
| Method | Path | Does | Accepts |
|---|---|---|---|
GET |
/api/api-keys |
Lists your keys, newest first. Never includes the keys themselves | Session |
POST |
/api/api-keys |
Creates a key and returns it, once, in key |
Session, not while acting as another user |
PATCH |
/api/api-keys/{id} |
Renames, describes, disables or enables a key | Session |
DELETE |
/api/api-keys/{id} |
Deletes a key | Session |
Invitations
| Method | Path | Does | Accepts |
|---|---|---|---|
GET |
/api/invitations |
Lists invites: pending and expired, then accepted | Admin session |
POST |
/api/invitations |
Invites an email, replacing its pending invite | Admin session |
POST |
/api/invitations/{id}/resend |
Sends an invite again with a new link; the old link stops working | Admin session |
DELETE |
/api/invitations/{id} |
Revokes an invite | Admin session |
POST |
/api/invitations/lookup |
Returns an invite’s email, from its token | Public |
POST |
/api/invitations/accept |
Accepts an invite: creates a verified account and signs in | Public |
Sign-in
Sign-in, sign-up, passkeys and admin tools live under /api/auth/*. They’re served by
Better Auth for the website, and aren’t a stable API: use the website
for them.