Skip to navigation

API Reference Overview

View as Markdown

The public SimZ API Reference documents the Lead Receive submission and batch management endpoints and the Call Export endpoints for retrieving your company’s calls, transcripts and recordings. Other portal, billing, webhook management, support, and internal APIs are intentionally not published.

Authentication models

API areaAuth method
Lead Receive APIX-Company-API-Key: <key> header (key with the leads:write scope).
Call Export APIX-Company-API-Key: <key> header (key with the calls:read scope, created under API Access in the portal).

Included API groups

  • Lead Receive: submit leads to a SimZ agent.
  • Batch Management: check batch status and pause, resume, or cancel accepted backlog.
  • Call Export: list calls in a time window, retrieve transcripts, download recordings.

Excluded API groups

Billing, support, webhook management, portal authentication, agent listing, API key administration, and private operational APIs are not included in this public API reference.