Skip to main content
The Postman collection holds every endpoint in this reference, with the same worked examples and saved responses. It is generated from the API, and each release of the API ships a fresh copy, so it does not fall behind.

Collection

Every endpoint, with examples.

Sandbox environment

For trial workspaces.

Production environment

For workspaces that have gone live.
The files are served by the console, so these links always give the latest release. Save each one as a .json file, or import it straight from the link. In Postman, choose Import, paste a link, and import. Do it once for the collection and once for the environment you need:
The console’s Developers page links the same files.

​
Set it up

1

Import the files

In Postman, choose Import and paste the collection link and the link of the environment you need, or drop in the files you saved. Most people start with sandbox.
2

Select the environment

Pick sandbox or production from the environment menu at the top right. The two differ only in base_url.
3

Fill in two values

In the environment, set api_key to your sk_live_ key from the console’s Developers page, and test_number to the phone you want test calls to ring, in E.164 (+919876543210).
4

Send the first three requests

Open Agents → Create agent and send it, then Calls → Place a call, then Calls → Get call. Each request that creates something saves the new id into a collection variable, so the next request uses it without any copying.
Place a call rings test_number and uses wallet credit. Every send makes a new call, because the collection generates a fresh Idempotency-Key each time.

​
What is inside

Auth is set once on the collection (Authorization: Bearer {{api_key}}), so no request carries a key of its own.

​
Keeping it current

Download the files again when you want the latest. An endpoint that ships in a release is in that release’s collection, and on its page in this reference.