API Reference
You can download your own API reference by going to your instance's host and accessing it via /docs/openapi/json . example: https://canary.novel.dev/docs/openapi/json
Auth
Callback called by an authentication strategy available to the application.
Authentication successful. Redirecting to next step...
Authentication successful. Redirecting to next step...
No content
Proceed to the application after a successful MFA attempt.
Authentication successful. Redirecting to next step...
Authentication successful. Redirecting to next step...
No content
Start the sign up process.
Sign up successful. Redirecting to next step...
Sign up successful. Redirecting to next step...
Authenticate by strategy available to the application.
Authentication successful. Redirecting to next step...
Authentication successful. Redirecting to next step...
Application
Accounts
Update the currently logged in account's profile.
User profile updated successfully.
User profile updated successfully.
No content
Update the currently logged in account's settings.
User configuration updated successfully.
User configuration updated successfully.
No content
Update the currently logged in account's password.
User password updated successfully.
User password updated successfully.
No content
Revoke registered secret so a user can register a new one. It is possible to register and overwrite an existing mfa secret.
MFA secret revoked successfully.
MFA secret revoked successfully.
No content
Organizations
Deactivate an organization tied to the currently logged in session.
Organization has been deactivated.
Organization has been deactivated.
No content
Create a new organization tied to the user making the request.
Organization has been created.
Organization has been created.
Subscription
Subscribe to an available plan.
Subscription created successfully.
Subscription created successfully.
No content
API Keys
Files
Notifications
Register the push token related to the user.
Push token registered successfully.
Push token registered successfully.
No content
Changelog
2024-12-20 - Initial Documentation
Last updated
Was this helpful?