Create API token

POST

/tokens

Create a new API token. The secret token is only returned once.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Token created

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/tokens' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "description": "string",
    "scopes": [
        "messages:send"
    ],
    "expiresAt": "2019-08-24T14:15:22.123Z"
}'

Response Example

{
    "token": {
        "token_id": "string",
        "name": "string",
        "description": "string",
        "scopes": [
            "string"
        ],
        "last_used_at": "2019-08-24T14:15:22.123Z",
        "usage_count": 0,
        "is_active": true,
        "expires_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2019-08-24T14:15:22.123Z"
    },
    "secretToken": "string"
}

Modified at 2025-12-13 02:50:35

List API tokens

Revoke API token