Skip to main content
POST
/
auth
/
access-token
Get Access Token
curl --request POST \
  --url https://api.beamstudio.ai/auth/access-token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": "bm_key_xxxxxxxxxxxxx"
}
'
{
  "idToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
apiKey
string
required

Your API key obtained from the Beam dashboard. Format: bm_key_xxxxxxxxxxxxx

Example:

"bm_key_xxxxxxxxxxxxx"

Response

201 - application/json

Access token generated successfully

​
idToken
string
required

JWT access token to be used in Authorization header as Bearer token. Valid for 10 minutes.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

​
refreshToken
string

Refresh token used to obtain new access tokens when they expire. Store this securely.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."