JavaScript

import Reminix from '@reminix/sdk';

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

const clientToken = await client.clientTokens.create({
  publicMetadata: { displayName: 'Jane', plan: 'pro' },
});

console.log(clientToken.id);

{
  "token": "reminix_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.

Payload:

publicMetadata: Displayable properties, exposed via GET /client/token. For agent identity/attributes use serverContext.
serverContext: Agent-facing context (identity, attributes, pass-through). Same shape as request context for chat/invoke. 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 { publicMetadata: { displayName: "Jane", plan: "pro" }, serverContext: { identity: { user_id: "user_123" }, attributes: { user: { name: "Jane", email: "jane@example.com" } } } }
Your backend returns the token to your frontend
Frontend uses the token to call /client/* endpoints

POST

client-tokens

JavaScript

import Reminix from '@reminix/sdk';

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

const clientToken = await client.clientTokens.create({
  publicMetadata: { displayName: 'Jane', plan: 'pro' },
});

console.log(clientToken.id);

{
  "token": "reminix_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

publicMetadata

object

required

Public metadata (display name, plan, etc.) exposed via GET /client/token. For agent identity/attributes use serverContext.

Show child attributes

serverContext

object

Agent-facing context (identity, attributes, pass-through). Only accessible to agents/handlers, never exposed to client. Same shape as request context for chat/invoke.

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

Start a workflow run Revoke a client token

Overview

Projects

Agents

Client Tokens

Conversations

Workflow Runs

OAuth Connections

Create a client token

Authorizations

Body

Response