SDK Reference
Node.js / TypeScript: Configuration
Overview
Configure base URL, timeouts, retry policy, and custom HTTP agents for corporate proxies.
Use separate client instances per environment (staging vs production API keys).
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
Prerequisites
- Node.js / TypeScript runtime installed
- Organization API key
When to use this workflow
- Onboarding new team members to Zof terminology and workflows
- Authoring internal runbooks aligned with Console labels
- Designing CI/CD or webhook integrations against documented behavior
Step-by-step procedure
Environment profiles
Instantiate separate clients for staging and production keys.
Never share API key across environments in one client instance.
Key concepts
- baseUrl
- API base URL override for private cloud deployments.
- timeoutMs
- HTTP client timeout; increase for large exports.
- maxRetries
- Automatic retry count for idempotent GET on 5xx/429.
Best practices
- Separate client instances per environment
- Set explicit timeouts for CI jobs
Example
const client = new ZofClient({ apiKey, baseUrl: 'https://api.zof.ai/v1', timeoutMs: 30000, maxRetries: 3 });Was this page helpful?
