sk-...) are created and managed in the Piramyd dashboard.
There is no public account registration endpoint. Accounts are created at dash.piramyd.cloud through the onboarding flow — not via the API. All endpoints below require an existing account.
Endpoint Reference
POST /v1/auth/token
Exchange your credentials for a JWT access token and refresh token. This is your entry point for all subsequent account management calls. Base URL:https://api.piramyd.cloud
Request Body
Response
A short-lived JWT. Pass this as
Authorization: Bearer <access_token> on all account management requests.A longer-lived token. Use it with
POST /v1/auth/refresh to obtain a new token pair without re-entering your password.Example
GET /v1/auth/me
Returns the profile for the currently authenticated account. Use this to confirm token validity or retrieve account details such as your user ID, email, and verification status. Base URL:https://api.piramyd.cloud
Headers
Example
DELETE /v1/auth/me
Permanently deletes your account. This action is irreversible — all associated data, including API keys, will be removed. Base URL:https://api.piramyd.cloud
Headers
POST /v1/auth/refresh
Rotate your token pair. Submit your current refresh token to receive a newaccess_token and refresh_token. The old refresh token is revoked after a successful call.
Base URL: https://api.piramyd.cloud
Request Body
The refresh token returned by
POST /v1/auth/token or a previous POST /v1/auth/refresh call.Response
Example
POST /v1/auth/logout
Revoke the current refresh token, ending the session. The access token will continue to work until it expires naturally, but it can no longer be refreshed. Base URL:https://api.piramyd.cloud
Headers
Email Verification
POST /v1/auth/email-verification/send-code
Sends a verification code to the email address on your account. Call this when your account email shows as unverified.POST /v1/auth/email-verification/verify-code
Submit the code you received to mark your email as verified. Both endpoints requireAuthorization: Bearer <access_token>.
OAuth
Piramyd supports OAuth-based sign-in and account linking. Replace{provider} with a supported provider slug such as github.
GET /v1/auth/oauth//start
Redirects your user to the OAuth provider’s authorization page to begin a sign-in flow. No auth required — redirect your browser or user agent to this URL.GET /v1/auth/oauth//connect/start
Same as/start but links the OAuth provider to an existing account rather than creating a new session. Requires Authorization: Bearer <access_token>.
