API Reference - Wave API

The Wave API is a JSON REST API. All endpoints are served under the /v1 prefix.

Scope: the reference lists every route that an API key can call: voice (callbacks, calls, in-call control, conferencing, recordings, call flows, queues, virtual numbers, voicemail, verify, voice authentication, web calling), usage, and messaging (messages, templates, broadcasts, contacts). Routes that are enabled per environment say so on their page. Routes that only the dashboard uses (for example webhook endpoints and numbers) are not in the reference — manage those in the Wave dashboard.

Base URL

https://api.wave.sa

Authentication

Every developer request authenticates with an API key as a Bearer token — a sandbox key (sk_sandbox_…) to test, or a production key (sk_live_…) for billed calls from your project’s own number. Sandbox and production are properties of a project. Some routes need a production key; their page says so.

Authorization: Bearer sk_sandbox_xxxxxxxxxxxx

Get your key from the Wave dashboard. See Authentication.

Versioning

All endpoints are under /v1. Breaking changes ship under a new version prefix.

Response format

Success responses return the resource directly (no envelope). Errors return a standard bilingual envelope:

{
  "error_code": "VALIDATION_ERROR",
  "message": "…",
  "message_ar": "…",
  "request_id": "req_…",
  "docs_url": "https://wave.sa/docs/errors"
}

See Errors for the full code list.

Endpoints

The Endpoints section is generated from the OpenAPI spec and includes an interactive playground. The spec is generated from the API code and checked on every change, so it lists every route an API key can call. Each operation says which scope it needs.

​Base URL

​Authentication

​Versioning

​Response format

​Endpoints

Base URL

Authentication

Versioning

Response format

Endpoints