API reference

Overview

You should directly interact with the APIs if:

• You are building your own frontend and want to query APIs exposed via the backend SDK.
• You are not using the backend SDK and want to query the core directly.

Please make sure that you have seen the architecture page.

Core driver interface

This is the API used by the backend SDK to query the SuperTokens Core.

Open API Spec

To know which version you should see:

• Check the version of the core you are running (for managed service, visit the dashboard, else run supertokens --version command)
• Go to the SuperTokens-core GitHub page
• Switch to the branch that matches the version of the core your running
• Open the file called coreDriverInterfaceSupported.json
• In there, you see an array of X.Y values, pick the latest one, and see the API spec for that.

Frontend driver interface

This is the API used by the frontend SDK to query the backend SDK APIs.

Open API Spec

To know which version you should see:

• Go to the GitHub page of the backend or frontend SDK you are using
• Switch to the branch that matches the version of the SDK
• Open the file called frontendDriverInterfaceSupported.json
• In there, you see an array of X.Y values, pick the latest one, and see the API spec for that.