Documentation

Go from a fresh workspace to live telemetry. Full engineer reference: repository files docs/SDK.md and sdk/README.md.

1. Create an account

Register or sign in. A default workspace is created for you. Start with the AI assistant — you do not need a project for chat.

2. Create a project

Open Projects and create a project for each service you monitor. Each API key belongs to exactly one project (project isolation). (Projects)

3. Generate an API key

In API Keys, create a key for production or staging. Copy the secret once — only the prefix is stored for display afterward. Keys are ZYN-KEY-… project ingest keys, not Supabase service_role secrets. (API Keys)

4. Install the SDK

Build the local package, then path-install it (not published to public npm with the commercial delivery):

cd sdk && npm install && npm run build
npm install /absolute/path/to/zynteksis/sdk

Browser init: new Zynteksis({ apiKey, endpoint }).init(). See the connection guide on the API Keys page and the landing SDK section.

5. Server / HTTP ingest

init() is browser-only. From servers, POST to /api/sdk/heartbeat, /api/sdk/error, /api/sdk/performance, and /api/sdk/events with header X-Zynteksis-Key (or Bearer).

6. Operate

• Errors, Health, and Incidents for monitoring
• AI Assistant for telemetry-backed analysis (plan message quotas)
• Status Pages for public communication
• Billing — for plan limits (checkout provider is pluggable and not bundled)

Troubleshooting

• 401 on ingest — key missing, wrong, or revoked; regenerate on API Keys.
• No data in dashboard — confirm the key's project and that endpoint points at your ZYNTEKSIS origin.
• Rate limits — ingest is limited (default 240 requests / minute / key). Back off and retry.