Developers · Masking API Swagger ReDoc Quickstart →

API reference

Production base URL: https://api.cloudtalknet.com

The full OpenAPI specification is published live from this same service.

Interactive

  • Swagger UI — try every endpoint from the browser. Click Authorize, paste your X-API-Key, and use the Try it out buttons.

Readable

  • ReDoc — clean, single-page reference good for skimming and search.

Machine-readable

  • OpenAPI JSON — point your client generator (openapi-generator, openapi-typescript, etc.) here. The schema is filtered to tenant-facing endpoints only.

What's covered

The schema only includes endpoints you can call with an X-API-Key:

Sessions & calls

  • POST /v1/sessions — open a masked session
  • GET /v1/sessions — list your sessions
  • GET /v1/sessions/{ref} — fetch a single session
  • POST /v1/sessions/{ref}/complete — close a session early
  • POST /v1/calls/originate — originate a call against an open session

Masked numbers (DIDs)

  • GET /v1/did/assignments — list masked numbers assigned to your tenant

API key management — see Manage API keys

  • GET /v1/api-keys — list your keys (no plaintext)
  • POST /v1/api-keys — mint a new key
  • POST /v1/api-keys/{id}/rotate — rotate (revoke + mint in one step)
  • POST /v1/api-keys/{id}/revoke — revoke a specific key

System

  • GET /health — service health probe