JavaScript

import Limitry from '@limitry/sdk';

const client = new Limitry({
  apiKey: process.env['LIMITRY_API_KEY'], // This is the default and can be omitted
});

const clientToken = await client.clientTokens.create({
  context: { customerId: 'cust_123', plan: 'pro' },
});

console.log(clientToken.id);

{
  "token": "limitry_ct_abc123def456...",
  "id": "ct_abc123",
  "expiresAt": "2024-01-15T11:30:00Z"
}

Client Tokens

Create a client token

Create a short-lived client token for browser SDK use.

Use case: Your backend calls this endpoint to generate a token, then passes it to your frontend. The frontend uses the token to make authenticated requests to /client/* endpoints.

Context types:

context: Public data accessible to the client via /client/context
serverContext: Private data only accessible to handlers (never exposed to client)

Security:

Tokens are short-lived (default 1 hour, max 24 hours)
Both context types are trusted and cannot be tampered with
Store the token securely - it will only be shown once

Example flow:

User logs in to your app
Your backend calls POST /v1/client-tokens with { context: { customerId: "cust_123" }, serverContext: { creditLimit: 1000 } }
Your backend returns the token to your frontend
Frontend uses the token to call /client/* endpoints (e.g., check limits)

POST

client-tokens

JavaScript

import Limitry from '@limitry/sdk';

const client = new Limitry({
  apiKey: process.env['LIMITRY_API_KEY'], // This is the default and can be omitted
});

const clientToken = await client.clientTokens.create({
  context: { customerId: 'cust_123', plan: 'pro' },
});

console.log(clientToken.id);

{
  "token": "limitry_ct_abc123def456...",
  "id": "ct_abc123",
  "expiresAt": "2024-01-15T11:30:00Z"
}

Authorizations

Authorization

string

header

required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Body

application/json

context

object

required

Public context accessible to the client via /client/context (e.g., { customerId: "...", plan: "..." })

Show child attributes

serverContext

object

Private context only accessible to handlers, never exposed to client (e.g., { internalId: "..." })

Show child attributes

ttlSeconds

integer

Time-to-live in seconds. Default: 3600 (1 hour). Max: 86400 (24 hours).

Required range: 0 < x <= 86400

Response

Client token created successfully

token

string

required

The client token. Store this securely - it will not be shown again.

string

required

Token ID for management purposes

expiresAt

string<date-time>

required

ISO 8601 timestamp when the token expires

Get customer balances Revoke a client token

⌘I

Overview

Projects

Events

Meters

Limits

Balances

Customers

Client Tokens

Create a client token

Authorizations

Body

Response