WHIZZVOICE
Docs · Reference · OpenAPI

OpenAPI.

The full API is described by an OpenAPI 3.1 spec. Point any standard tool at it to generate typed clients, mock servers, and Postman collections — no hand-written bindings required.

Download#

The spec lives at a single, stable URL:

spec URL
https://voice.whizztech.ai/openapi.json

Fetch it to a file:

curl
curl -s https://voice.whizztech.ai/openapi.json -o openapi.json

Generate a client#

Feed the spec URL directly to your generator of choice — most read a remote URL as happily as a local file. Using generic OpenAPI tooling:

generate
# TypeScript client
openapi-generator-cli generate \
  -i https://voice.whizztech.ai/openapi.json \
  -g typescript-fetch \
  -o ./clients/ts

# Python client
openapi-generator-cli generate \
  -i https://voice.whizztech.ai/openapi.json \
  -g python \
  -o ./clients/py

The generated client speaks the same https://voice.whizztech.ai/v1 base and the same resources you see throughout these docs. Add your wz_live_ or wz_test_key as the bearer token and it's ready.

What's covered#

The spec is tagged by resource, one tag per section of this documentation:

FieldTypeDescription
AgentstagCreate, read, update, publish, and delete voice agents.
Phone numberstagBuy, import, bring your own SIP, attach, and release numbers.
CallstagPlace outbound calls, list and retrieve calls, read transcripts and outcomes.
CampaignstagBulk outbound: recipients, target concurrency, and totals.
WebhookstagRegister endpoints and receive call.started / call.completed / call.failed.
UsagetagCredit balance and daily voice-minute, call, and telephony metering.

The spec stays in lockstep with these pages — the same shapes, fields, and status codes. Every request and response references a named schema, so generated types match the JSON you get back.

Import to Postman#

In Postman, choose Import → Link and paste the openapi.json URL directly. Postman builds a collection with every endpoint, its parameters, and example bodies; set a collection-level bearer token with your API key and you can call the live API from the first request.

NextBack to Introduction→