Skip to content

Configuration

The Tinybox client takes a single options object. All fields are optional except token.

FieldTypeDefaultNotes
tokenstringRequired. Workspace bearer token.
endpointstringhttps://api.tinybox.devOverride for self-hosted installs.
timeoutnumber30000Per-request timeout in ms.
retriesnumber3Idempotent retry count.
userAgentstringtinybox-sdk/<version>Suffixed onto outbound requests.
ts
const client = new TinyboxClient({
  token: process.env.TINYBOX_TOKEN!,
  endpoint: 'https://tinybox.internal.example.com',
  timeout: 60_000,
  retries: 5,
});

The client never reads .env or any ambient config; pass everything explicitly so test harnesses behave deterministically.