API reference

The public API (/public/v1) is a curated REST surface of 5 resources — leads, contacts, conversations, appointments and tickets — authenticated with an API key, available on the Pro and Enterprise plans.

Get started with the APICreate your key and make your first call in under 10 minutes.

AuthenticationThe X-API-Key header, scopes per resource and per action.

Your first request

GET /me doesn’t require any scope of its own — just a valid key from a tenant on an eligible plan — so it’s the fastest way to check your key works:

curl

curl https://api.nuntius.chat/public/v1/me \
  -H "X-API-Key: aa_YOUR_FULL_KEY"

Python

import requests

res = requests.get(
    "https://api.nuntius.chat/public/v1/me",
    headers={"X-API-Key": "aa_YOUR_FULL_KEY"},
)
res.raise_for_status()
print(res.json())

JavaScript

const res = await fetch("https://api.nuntius.chat/public/v1/me", {
  headers: { "X-API-Key": "aa_YOUR_FULL_KEY" },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

Guides

Plans and limitsWhich plan you need and how many requests you can make.

ErrorsError format and codes the API can return.

VersioningHow /public/v1 evolves without breaking your integration.

API use casesReal integration scenarios.

Generated reference

EndpointsEvery /public/v1 operation, generated from the same OpenAPI definition the MCP server uses.

Related tools

MCP serverConnect your AI assistant to the same API.

llms.txtAn index of the whole portal in plain text.

Frequently asked questions

What plan do I need to use the public API?

Pro or Enterprise. On the Starter plan, any call to /public/v1/* returns 403 PLAN_NOT_ELIGIBLE, even if the key exists and has the right scope. See Plans and limits.

What happens if my key doesn't have the exact scope an endpoint requires?

You get 403 PERMISSION_DENIED, even with the rest of its permissions intact. Every resource has two independent scopes — read and manage. See Authentication.

How do I rotate a key without breaking my integration?

There's no atomic rotation endpoint today: create a new key with the same scopes, update the secret in your integration, then revoke the old one — there's a brief window with both active.

What does the API return if I ask for another tenant's resource?

404, exactly as if the resource didn't exist — never 403, which would confirm the data exists on another account.

How many requests can I make per minute?

180/minute and 50,000/day on Pro; 600/minute and 200,000/day on Enterprise. The quota is counted per key, not per IP. See Plans and limits.

Can I delete a lead, a contact, or any other resource through the API?

No — /public/v1 has no DELETE endpoint at all. See API use cases.

What happens if I send a WhatsApp message outside the 24-hour window?

You get 409 WHATSAPP_SESSION_WINDOW_CLOSED — use POST /conversations/start with an approved template instead. See Errors.

Up next

MCP serverConnect Claude, Cursor or another AI assistant to your account.