{"info":{"_postman_id":"043053e7-3051-4716-bca0-80acd8f3741b","name":"Awaz API","description":"

Here’s a tailored introduction to Awaz.ai's Postman documentation, based on the template provided:

📄 Get started here

This documentation serves as a comprehensive guide to getting started with the Awaz.ai API, including key details, step-by-step instructions, and tips to maximize your experience.

🔖 How to use this documentation

Replace the example content in brackets (()) with specific details about the Awaz.ai API.

Helpful tips are written in codespan for easy identification. Feel free to customize this as per your needs.

Overview

The Awaz.ai API empowers businesses to integrate advanced AI-driven conversation systems into their applications. With Awaz.ai, you can seamlessly manage inbound and outbound calls, define actions, insert prompts, and analyze post-call interactions—all within a no-code environment.

Our API enables:

Automated call transcription.
\n
Real-time decision-making during calls.
\n
Tagging and post-call analysis.
\n

Whether you're handling customer support, lead qualification, or managing call center operations, the Awaz.ai API provides scalable solutions tailored to your needs.

Getting started guide

To begin using the Awaz.ai API, follow these steps:

Obtain API Access:
\n
- Create an Awaz.ai account at https://app.awaz.ai/settings#integrations.
  \n
- Navigate to the \"API Keys\" section in your dashboard to generate your API key.
  \n
\n
Set Up Authentication:
\n
- Include your API key in the Authorization header for each request.
\n
Explore the API Endpoints:
\n
- Refer to the \"Endpoints\" section to test and integrate available functionalities.
\n
Review Rate Limits:
\n
- Familiarize yourself with the API's rate and usage policies to ensure uninterrupted access.
\n

Authentication

The Awaz.ai API uses API Key-based Authentication.

Generate your API key from the \"API Keys\" section in your Awaz.ai account.
\n
Authorization: Bearer
\n

Authentication error responses:

Missing API key: HTTP 401 Unauthorized.
\n
Invalid API key: HTTP 403 Forbidden.
\n

Rate and usage limits

To maintain service quality, Awaz.ai enforces the following API usage limits:

Rate Limit: 100 requests per minute per API key.
\n
Response Headers: Each API response includes headers to track usage:
\n
- X-RateLimit-Limit: Maximum requests per minute.
  \n
- X-RateLimit-Remaining: Remaining requests for the current window.
  \n
- X-RateLimit-Reset: Time when the rate limit resets (UTC epoch).
  \n
\n

Exceeding the rate limit will result in an HTTP 429 Too Many Requests response.

503 response:

An HTTP 503 indicates high traffic. Wait for 5 minutes and retry. Persistent errors should be reported to hello@awaz.ai.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15069431","collectionId":"043053e7-3051-4716-bca0-80acd8f3741b","publishedId":"2sAYJ3EgS7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-20T19:08:19.000Z"},"item":[{"name":"Phones","item":[{"name":"Available Phones","event":[{"listen":"test","script":{"id":"10bfb960-5072-4b9f-b324-f1b4db61c931","exec":[""],"type":"text/javascript","packages":{}}}],"id":"50400d3e-f8f7-4c82-adfb-031801839853","request":{"method":"GET","header":[],"url":"https://api.awaz.ai/v1/phones","description":"

Gets information about the authenticated user.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"043053e7-3051-4716-bca0-80acd8f3741b","id":"043053e7-3051-4716-bca0-80acd8f3741b","name":"Awaz API","type":"collection"}},"urlObject":{"path":["v1","phones"],"host":["https://api.awaz.ai"],"query":[],"variable":[]}},"response":[{"id":"2b5acb60-98d2-4505-beae-61871cb42fce","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.awaz.ai/v1/phones"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"674"},{"key":"ETag","value":"W/\"2a2-skwflCHIqGMTvY/2Vg6tx0DChUo\""},{"key":"Date","value":"Fri, 20 Dec 2024 19:03:07 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"661d7fb88bcadcf1d86fd8b0\",\n \"number\": \"+11111111111\"\n },\n {\n \"id\": \"66247463179840c558c9dd93\",\n \"number\": \"+12222222222\"\n }\n ]\n}"}],"_postman_id":"50400d3e-f8f7-4c82-adfb-031801839853"}],"id":"9f9e0b57-ba95-4612-8ca5-7ff1ea94feb3","_postman_id":"9f9e0b57-ba95-4612-8ca5-7ff1ea94feb3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"043053e7-3051-4716-bca0-80acd8f3741b","id":"043053e7-3051-4716-bca0-80acd8f3741b","name":"Awaz API","type":"collection"}}},{"name":"Calls","item":[{"name":"List Calls","event":[{"listen":"test","script":{"id":"10bfb960-5072-4b9f-b324-f1b4db61c931","exec":[""],"type":"text/javascript","packages":{}}}],"id":"914ec6e0-c01d-4cb2-8689-f615173a087d","request":{"method":"GET","header":[],"url":"https://api.awaz.ai/v1/calls?page=0","description":"

Gets information about the authenticated user.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"043053e7-3051-4716-bca0-80acd8f3741b","id":"043053e7-3051-4716-bca0-80acd8f3741b","name":"Awaz API","type":"collection"}},"urlObject":{"path":["v1","calls"],"host":["https://api.awaz.ai"],"query":[{"key":"page","value":"0"},{"disabled":true,"key":"id","value":"686430c0eeff74916f889a10"}],"variable":[]}},"response":[{"id":"116f0ace-fa4e-4f4a-b7cd-624c0c61ab58","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.awaz.ai/v1/calls?page=0","host":["https://api.awaz.ai"],"path":["v1","calls"],"query":[{"key":"page","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"644"},{"key":"ETag","value":"W/\"284-19ITM1hbtcVFX8xd+yK+ElmF2rk\""},{"key":"Date","value":"Fri, 20 Dec 2024 19:12:20 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"674b1c995e504fadc9b6fab9\",\n \"contact\": {\n \"id\": \"6625bd4a871629827802ecb8\",\n \"name\": \"Contact Name\",\n \"phone\": \"+11111111111\",\n \"email\": \"contact@email.com\"\n },\n \"status\": \"pickup\",\n \"extracted_variables\": {}\n }\n ]\n}"}],"_postman_id":"914ec6e0-c01d-4cb2-8689-f615173a087d"},{"name":"Schedule a Call","event":[{"listen":"test","script":{"id":"10bfb960-5072-4b9f-b324-f1b4db61c931","exec":[""],"type":"text/javascript","packages":{}}}],"id":"11250d6c-fd31-4b30-9a66-5b0bc074ef6e","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"agent\": \"65ff9abe3fdcbe533d3be143\",\n \"name\": \"Contact Name\",\n \"phone\": \"+11111111111\",\n \"from\": \"661d7fb88bcadcf1d86fd8b0\",\n \"datetime\": \"2024-01-01T00:00:00-00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.awaz.ai/v1/calls","description":"

Gets information about the authenticated user.

\n","urlObject":{"path":["v1","companies","add","credits"],"host":["https://api.awaz.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"a63207dd-f732-4ca1-b2ff-fed00d149d06"},{"name":"Add workspace minutes","event":[{"listen":"test","script":{"id":"10bfb960-5072-4b9f-b324-f1b4db61c931","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9c2eea22-462a-4625-b29e-4122a75ce2a3","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"company\": {\n \"email\": \"workspace@email.com\"\n // \"id\": \"IDOFTHECOMPANY\" // optional for precision\n },\n \"minutes\": 10\n}","options":{"raw":{"language":"json"}}},"url":"https://api.awaz.ai/v1/companies/add/credits","description":"

Gets information about the authenticated user.

\n","urlObject":{"path":["v1","companies","add","credits"],"host":["https://api.awaz.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c2eea22-462a-4625-b29e-4122a75ce2a3"}],"id":"1b13099d-0b83-4ebc-beb0-0908d8a76fd5","_postman_id":"1b13099d-0b83-4ebc-beb0-0908d8a76fd5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"043053e7-3051-4716-bca0-80acd8f3741b","id":"043053e7-3051-4716-bca0-80acd8f3741b","name":"Awaz API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{apiKey}}"}]}},"event":[{"listen":"prerequest","script":{"id":"8ecd9dc8-4e0f-4b3a-81cf-dc72ab82191c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e8db91ed-a776-4a36-897e-05941badcff9","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.awaz.ai"}]}