TalkOmni API Reference
Integrate your own systems with TalkOmni. Drive the agent inbox, sync leads and knowledge, and read usage over an API-key authenticated REST API.
Your systems, wired to every conversation
Everything the panel does is available over a REST API with scoped, revocable keys. Build CRM sync, custom dashboards, or your own chat UI on top of the TalkOmni brain.
The API surface
Agent inbox
List conversations and messages, reply as an agent, take over from the bot and resume it, and download attachments.
Leads & attribution
Create, update and list leads, and read the per-project ad-traffic report: first-touch UTM parameters, click IDs and referrer.
Appointments
List, cancel and reschedule the appointments your assistant books.
Forms & submissions
List your forms and read their submissions with the attribution each lead arrived with, and post to a form from your own backend when your own site's form is submitted, so the lead, the webhook and the voice call back all still happen.
Knowledge documents
Upload, replace and delete the documents that ground your assistant's answers.
Webhooks
Subscribe to handoff.requested and get notified the moment a conversation needs a human.
Bring your own chat UI
The headless JavaScript embed gives you the TalkOmni brain (grounded answers, actions, human handoff) behind your own interface: you render the messages, we run the assistant.
Keys, scopes and limits
API keys are scoped per resource and revocable at any time. Requests are rate-limited and every call is audit-logged.
Events pushed to you
The API is the direction you pull. In the other direction we push: a signed webhook fires when a lead is captured, an appointment moves, a voice call ends or a conversation needs a human. The event catalog, the HMAC signature recipe in four languages and the delivery rules are on the integrations page.
Webhooks and integrations →