Authentication

Get a user token

Use this endpoint to create a user token for a specific user. This token can be safely passed to your user-facing front-end.

post/auth/user_token

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/auth/user_token
  • Auth
    HTTP bearer

Headers

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Request body

user_idstring required
originstring nullable

Origin of the request, used for CSRF protection. If set, the token will only be valid for requests originating from this origin.

expires_instring nullable

Token lifetime, e.g., '30m', '2h', '1d'. Defaults to 24 hours if not provided. Maximum 30 days.

Example request

{
  "expires_in": "30m"
}

Response

Successful Response

tokenstring required
expires_atstring date-time required

Changes

No operation changes recorded.