Setup

The given APIs are REST APIs and can be used to interact with the OutCaller AI platform, to get your organization information, handle agents, leads, calls, etc. In future we will also support native SDKs for some of the popular languages like JavaScript, Python, etc.

Authentication

All the APIs are authenticated and require a valid API key. Without a valid API key, you will get a 401 Unauthorized error.

API Key

You can get your API key from the OutCaller Dashboard.

• Visit the OutCaller Dashboard
• Select the API Keys from the sidebar

• Click on the Generate New Token button

• Enter the description you want to give to the API key
• Click on the Generate Token button

• The API key will be generated and displayed only once, make sure to copy it and save it in a secure location
• Click on Copy Token to copy the API key to your clipboard

• You can manage your API keys from the API Keys page
• You can delete the API key anytime you want

Headers

You need to pass the API key in the Authorization header. Remember to replace <api-key> with your actual API key. Since it is a bearer token, it is recommended to use it in the Authorization header.

Authorization: Bearer <api-key>

Base URL

The base URL for the API is https://outcallerai.com. The base URL might change in the future, If it happens we will update the base URL in the documentation.

API Endpoints

Currently we have 4 APIs which have several endpoints, they are:

Place a call

To place a call, you need to follow the following steps:

1. Keep your organization information up to date, as it is used to provide more context to agent
2. Create an agent with the required details

• Name
• Description
• Gender
• Script
• Voice

3. Create a lead with the required details
4. Place a call to the lead

When you follow the above steps, you can place a call to the lead.