Options
| Option | Default | Description |
|---|---|---|
token (required) | - | The short-lived member token. For server-mode clients, this is the Org-API-Key. |
environment | live | Declarative label for the credential’s environment; the other value is sandbox. See Environments. |
baseUrl | canonical host | Override the API host. |
orgId | - | Optional. Included in the User-Agent for support attribution. |
tokenExpiresAt / tokenExpiresAtMs | - | Optional. Token expiry; enables proactive refresh. See Authentication. |
refreshToken | - | Optional hook returning a fresh token and expiry. Called proactively within refreshSkew, and reactively once on a 401. |
maxRetries | 2 | Retry attempts on 429/5xx. See Retries and idempotency. |
timeout / timeoutMs | none | Per-request timeout. |
refreshSkew / refreshSkewMs | 30s | Refresh proactively when the token is within this window of expiry. |
userAgentSuffix | - | Optional. Appended to the User-Agent. |
Names are shared across SDKs; the duplicated rows (for example
timeout /
timeoutMs) show the idiomatic spelling per language. Pass whichever your SDK
exposes - they configure the same behavior.User-Agent
Every request carries aUser-Agent the server uses for attribution and support.
Its format is:
{lang}ists,swift, orkotlin.{sdkVersion}and{specVersion}are embedded generated constants - see Versioning.envis your configuredenvironment;orgis appended whenorgIdis set.- The optional trailing
<suffix>is youruserAgentSuffix.
expys-sdk-ts/1.2.0 (spec/1.0.0; env=live; org=org_123) my-app/1.0.
Related
Authentication
Tokens, expiry, and the refresh hook.
Environments
Sandbox vs live, selected by your credential.
Retries
Backoff and idempotency behavior.