Skip to main content
Immutable SDK configuration. The Parmana Runtime gates every route except GET /health, GET /ready, GET /openapi.yaml, and GET /documentation behind a caller bearer key (packages/api/src/middleware/caller-auth.ts). See apiKey below and /api-reference/authentication.

​
Properties

​
endpoint

readonly endpoint: string
Parmana Runtime endpoint. Example: https://runtime.example.com

​
apiKey?

readonly optional apiKey?: string
Caller bearer key, minted by scripts/generate-api-key.ts. Sent as Authorization: Bearer <apiKey> on every request. Omit only against a Runtime started with PARMANA_AUTH_DISABLED=true (local development only); every other deployment rejects an unauthenticated request with a 401 before a Business Transaction is even constructed.

​
timeout?

readonly optional timeout?: number
Request timeout (milliseconds). Default: 30000

​
retryPolicy?

readonly optional retryPolicy?: RetryPolicy
Retry configuration.

​
transport?

readonly optional transport?: Transport
Transport implementation. If omitted, the client builds an HttpTransport from this same configuration, so timeout, retryPolicy, apiKey and userAgent apply.

​
userAgent?

readonly optional userAgent?: string
Optional SDK user agent.