Quickstart

From API key to first document export.

The current beta workflow is based on saved numeric report IDs. Hosted beta will use https://api.teleza.tech; local development uses http://localhost:8587.

What you need

  • Teleza API base URL.
  • Customer-scoped X-API-Key.
  • A saved report definition or hosted starter blueprint report ID.
  • Optional admin JWT only when creating customers or API keys yourself.

Golden workflow

  1. Create or receive a customer-scoped API key.
  2. Create a report definition with dataSourceId, sql, format, and optional parameters.
  3. Preview the report.
  4. Execute JSON.
  5. Export PDF, Excel/XLSX, CSV, JSONL, or NDJSON.
  6. Optionally schedule delivery.
  7. Read usage.

API contract

X-API-Key: <customer-scoped-api-key> POST /api/whiteLabelEngine/v1/reports POST /api/whiteLabelEngine/v1/reports/{reportId}/preview POST /api/whiteLabelEngine/v1/reports/{reportId}/execute?format=json POST /api/whiteLabelEngine/v1/reports/{reportId}/execute?format=pdf|excel|xlsx|csv|jsonl|ndjson POST /api/whiteLabelEngine/v1/reports/{reportId}/schedule GET /api/whiteLabelEngine/v1/reports/{reportId}/usage

Environment

# Local beta TELEZA_API_URL=http://localhost:8587 TELEZA_API_KEY=sk_live_... # Hosted beta, once deployed TELEZA_API_URL=https://api.teleza.tech TELEZA_API_KEY=sk_live_...

Current status: static docs are ready for teleza.tech. The hosted API endpoint should remain reserved until the container host and strict deployment evidence are in place.