Authentication

The Beamery Skills API uses OAuth 2.0 client credentials flow for authentication. All API requests must include a valid access token obtained through the authentication endpoint.

Rate Limits

Rate Limit Headers

To support integration of the Beamery API, each call made to any endpoint will receive response headers following the Draft Version 3 RFC of RateLimit Header Fields for HTTP:

x-ratelimit-reset: 1
x-ratelimit-remaining: 24
x-ratelimit-limit: 40;w=1

• x-ratelimit-reset: Number of seconds until the rate limit window resets
• x-ratelimit-remaining: Remaining requests in the current time window
• x-ratelimit-limit: Configured limit (e.g., 40 requests per second)

Rate Limit Logic

Implement the following logic to respect rate limits:

Perform HTTP request to any endpoints of Beamery Public-API

If response == 429 OR X-RateLimit-Remaining < 1 Then
  wait until X-RateLimit-Reset before triggering next request
Else
  Trigger next request

Generate OAuth Token

curl https://frontier.beamery.com/v1/oauth/token \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "your_client_id",
    "clientSecret": "your_client_secret"
  }'

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Get Token Permissions

curl https://frontier.beamery.com/v1/oauth/token/permissions \
  -H "Authorization: Bearer your_access_token"

{
  "roles": [
    "admin",
    "user"
  ],
  "permissions": [
    "read:tasks",
    "write:tasks",
    "read:skills",
    "write:skills"
  ]
}

Using Your Access Token

Once you have obtained an access token, include it in the Authorization header of all API requests:

Authorization: Bearer your_access_token