Skip to main content
POST
/
v1
/
auth
/
token
Generate a short lived Bearer token
curl --request POST \
  --url https://api.eu.volubile.ai/v1/auth/token \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "scope": [
    "calls:read"
  ]
}
'
{
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjN2Y4...",
  "expiresIn": 900,
  "tokenType": "Bearer"
}

Authorizations

X-Api-Key
string
header
required

Your API key.

Body

application/json

Payload used to issue a short lived Bearer token from an API key

scope
enum<string>[]
required

List of scopes granted to the issued Bearer token

Available options:
calls:read,
calls:write,
campaigns:read,
campaigns:write,
agents:read,
agents:write,
integrations:read,
integrations:write

Response

OK

Short lived Bearer token issued from a valid API key

token
string

Signed JWT Bearer token

Example:

"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjN2Y4..."

expiresIn
integer<int64>

Token lifetime in seconds

Example:

900

tokenType
string

Token type

Example:

"Bearer"