Skip to main content

​
Welcome

The Inceptia API lets you integrate and automate conversational campaign management: create campaigns, upload cases, check results, and download recordings.

Getting started

Create your first campaign in 4 steps

​
Before you start

To use the API you need a user account with at least one bot assigned. Access is managed by your Inceptia administrator.
1

Request access

Contact your administrator and ask them to create a user with access to the bot you’re going to integrate. Without that assignment, the API returns an empty bot list.
2

Get your credentials

Your administrator will share the email and password for you to authenticate with, and confirm which environment you can operate in (test or production).
3

Integrate

With that, you can follow the Getting started guide.

​
Servers

​
Authentication

All endpoints (except login and refresh) require a JWT token in the header:
You get the token by calling POST /auth/login/ with your email and password. The token expires — use POST /auth/token/refresh/ to renew it without authenticating again.

​
Pagination

List endpoints use two strategies:
  • Cursor-based (next / previous as URLs): campaigns.
  • Offset (count + next / previous): cases, calls, and inbound.
Follow the next field in the response to get the next page.