API: connect iAgentify to your own systems

iAgentify has a REST API so that your own server can talk to an agent and pull the leads into your CRM. It is used with API keys, which admins and owners create under Settings › API. Whether the API answers depends on your plan. It is a tool for someone who writes code: if you do not have that person, you do not need it to use iAgentify.

What it lets you do

The API has three calls:

What goes through the API is treated like any other conversation:

• It appears under Conversations, with the note “Writing through the API”, and your team can take over.
• Every reply uses credits, the same as on your website chat or on WhatsApp.
• The agent answers with the same knowledge and the same instructions. It can capture a lead or hand the conversation to a person, and the answer to the call says so.
• If a person is handling the conversation, it is paused or the agent is not active, the call returns no reply from the agent.

What it does not let you do

• It does not create or configure agents, add knowledge, or manage appointments, conversations or the team. That is done in the app.
• There are no webhooks. iAgentify does not call your system when a lead or a message comes in: your server asks every so often, for example for the leads created since the last time it asked.
• There is no streamed reply. The reply arrives whole, once it is finished.
• There are no ready-made connectors for particular CRMs or for automation tools. The integration is written by whoever runs your systems.

If all you want is your leads in a spreadsheet, you do not need the API: see export your leads.

What you need

• A plan that includes it. As of 6 October 2026 the Standard and Premium plans include it, and the Basic plan does not. If your plan does not include it, under Settings › API you see “Your plan does not include API access”: you can prepare your keys, but the API rejects the calls until you change plan.
• Role. You need to be an Admin or an Owner. The rest of the team does not see this section.
• A server of your own. The key must not be put in a web page or a mobile app: anyone who sees it can use your agents and read your leads.

Create a key

1. Go to Settings and open the API tab. You can also go straight to Settings › API (opens the app).

2. Under API keys, press Create key.

3. Enter the Key name: one that tells you where it is used, such as “CRM integration”.

4. Press Create key. “Save your key now” appears with the full key.

5. Copy it and keep it somewhere safe. Then press I have saved it.

Create one key per integration: that way you can revoke one without stopping the others. There is room for 10 active keys per account. The list shows when each one was Last used, which tells you which are still alive.

Revoke a key

1. Under API keys, press the revoke button of the key.

2. Confirm with Revoke key. “Key revoked” appears.

The integrations that use it stop working at once, and it cannot be undone. Revoke a key whenever you suspect someone outside has seen it, and when the person who held it leaves the team.

Where the documentation is

On the same screen, below the keys, the How to use the API section has everything the person writing the code needs: the Base URL, how to send the key in the Authorization header, each call with its parameters and an example that can be copied, and the errors. Show that screen to your developer, or give them the Admin role so they can see it.

The facts people ask about most:

Common errors

If a call fails and you do not know why, open a ticket from Support with the approximate time and the text of the error. Do not paste the key into the ticket.