How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SuperTokens Sessions API

Session creation, verification, refresh, and revocation

SuperTokens Sessions API is one of 10 APIs that SuperTokens publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, a JSON-LD context, and 2 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 5.1.

Requests are made against a single base URL, http://{host}:{port}.

6 operations 4 paths 12 schemas 2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.1
Base URL
https://{supertokens-core-host}:{port}
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

SuperTokens Sessions API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — SuperTokens Core API key (configured in config.yaml or via environment variable)

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Sessions 6

Session creation, verification, refresh, and revocation

POST
/recipe/session
Create Session
createSession body → 200
GET
/recipe/session
Get Session
getSession 2 params → 200401
POST
/recipe/session/refresh
Refresh Session
refreshSession body → 200401
POST
/recipe/session/remove
Remove Sessions
removeSessions body → 200
GET
/recipe/session/data
Get Session Data
getSessionData 1 param → 200
PUT
/recipe/session/data
Update Session Data
updateSessionData body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Session (5 properties), CreateSessionResponse (5 properties), CreateSessionRequest (4 properties), GetSessionResponse (3 properties). Each schema is shown below with its type and property counts.

RemoveSessionsRequest
object
2 properties
RefreshSessionRequest
object
3 properties 1 required
StatusResponse
object
1 property
Session
object
A SuperTokens authentication session
5 properties
CreateSessionRequest
object
4 properties 3 required
GetSessionResponse
object
3 properties
RemoveSessionsResponse
object
2 properties
CreateSessionResponse
object
5 properties
UpdateSessionDataRequest
object
2 properties 2 required
Token
object
A token object with value and expiry
3 properties
SessionDataResponse
object
2 properties
ErrorResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

supertokens-sessions-api-openapi.yml Raw ↑

Other APIs SuperTokens publishes across the network.

SuperTokens Email Password API
SuperTokens Email Verification API
SuperTokens Health API
SuperTokens Multi Tenancy API
SuperTokens Passwordless API
SuperTokens Third Party API
SuperTokens User Metadata API
SuperTokens User Roles API
SuperTokens Users API
Where this information came from

This is an independent, third-party profile of SuperTokens Sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.