API reference

Organization sign-in, sessions and password changes

• POST/auth/login
• POST/auth/logout
• GET/auth/me
• POST/auth/password

Link messaging accounts and see which platforms are supported

• GET/channels/providers
• POST/channels/connect
• DELETE/channels/connections/{id}
• GET/channels/connections

Products — the facts the AI quotes from

• GET/products
• POST/products
• POST/products/import
• GET/products/{id}
• DELETE/products/{id}

FAQs, policies and documents, plus retrieval inspection

• GET/knowledge/documents
• POST/knowledge/documents
• DELETE/knowledge/documents/{id}
• POST/knowledge/preview

Conversations, messages, and approving AI drafts

• GET/conversations
• GET/conversations/{id}/messages
• POST/conversations/messages/{messageId}/approve

Search products, knowledge documents and contacts with one query

• GET/search

Issue, list and revoke your organization's API keys

• GET/api-keys
• POST/api-keys
• DELETE/api-keys/{id}

Create your own organization. The only route needing no credential

• POST/organizations

Called by messaging platforms, not by your application

• GET/webhooks/{providerKey}
• POST/webhooks/{providerKey}

Liveness and readiness probes

• GET/health
• GET/health/ready

Administrator accounts and sign-in. The control plane

• POST/admin/auth/login
• POST/admin/auth/logout
• GET/admin/auth/me
• POST/admin/auth/password
• GET/admin/users
• POST/admin/users
• POST/admin/users/{id}/disabled

Provision a tenant. Requires an admin credential

• GET/admin/organizations
• POST/admin/organizations
• GET/admin/organizations/{id}
• POST/admin/organizations/{id}/password-reset
• POST/admin/organizations/{id}/api-keys