Skip to content
BuildBase
HTTP API menu

Get the signed device token for the caller's session

Resolves the x-session-id itself (no router-level gate) and answers 401 without a live session.

GET/api/v1/public/device-token

Sign-in
None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
Rate limit
Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 300 requests a minute per IP address; up to 30 requests a minute per sessionLimiterKey (some requests are not counted).

Resolves the x-session-id itself (no router-level gate) and answers 401 without a live session. A session with no device, such as an agent's, gets an empty token.

Request

This operation takes no parameters and no body.

Example request

Replace each YOUR_... value with your own.

curl -X GET "https://api.console.buildbase.app/api/v1/public/device-token"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/device-token',
  {
    method: 'GET',
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/public/device-token",
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "data": {
    "deviceToken": "[REDACTED]"
  },
  "success": true
}

Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

Errors

Each refusal, what it means, and what to do. The request changed nothing.

429 Too Many Requests

What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.

What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}