Developers
Developer API, Webhooks & AI Actions
Query your assistant programmatically via REST API, receive real-time webhook events, and configure AI Custom Function Calling tools.
Updated August 26, 2026
On this page
Developer REST API overview
SiteMind provides a high-performance REST API allowing you to query your trained assistant from mobile apps, custom web interfaces, CLI tools, or internal backend services without loading the Shadow DOM widget.
API keys can be generated and managed under Settings -> API Keys (/dashboard/api-keys). Keys are hashed using SHA-256 before storage and only revealed once upon creation.
Querying the assistant (POST /api/v1/public/chat)
Send JSON queries to `https://sitemind.tech/api/v1/public/chat` with your API key in the `X-API-Key` or `Authorization: Bearer <KEY>` header.
The request payload accepts `{ "message": "Your question", "conversationId": "optional-uuid" }`. The response returns the grounded answer, confidence rating, conversationId, and deduplicated source citations with direct URLs and match snippets.
Listing websites (GET /api/v1/public/websites)
Fetch all configured website domains, status, total indexed pages, and chunk counts for your workspace via `GET /api/v1/public/websites`.
Real-time Outbound Webhooks
Under Webhooks (/dashboard/webhooks), register destination endpoints to receive HTTP POST event notifications whenever interactions occur.
Supported events include `chat.answered` (delivers the complete visitor message, assistant answer, and citation metadata) and `lead.captured` (delivers collected contact names, emails, phones, and company details).
All webhook payloads include a `X-SiteMind-Signature` header computed with HMAC-SHA256 using your endpoint secret so your server can verify authenticity.
AI Custom Function Calling (Tools & Actions)
Define custom functions using standard JSON Schema parameter specifications. When a visitor’s question requires an external action (such as checking order delivery status, reserving a seat, or creating a support ticket), the assistant extracts the required parameters and triggers the tool.
SiteMind supports both `FIRE_AND_FORGET` mode (asynchronous background execution) and `SYNC` mode (the tool response is piped back into the model to summarize for the visitor).
For high-stakes actions, toggle `requiresConfirmation: true` to display an interactive confirmation prompt inside the chat before execution.
Rate limits and quotas
Developer API keys support high concurrency across all workspaces. Outbound webhooks and AI function call quotas scale by plan: 500 calls/month on Growth, 2,500 calls/month on Pro, and unlimited custom capacity on Enterprise.
Related
Customizing your widget
Theme, audio & voice, proactive nudges, guardrails, lead capture, and placement rules across 5 Studio tabs.
Integrations & Cloud Connectors
Sync knowledge automatically from Notion, GitHub, Confluence, Google Drive, and Dropbox with encrypted credentials.
Lead Generation & CRM Export
Capture qualified visitor leads during conversations, export to CSV, and stream real-time lead payloads to your CRM.
Security and data handling
The technical detail behind “the key is domain-locked”: how origin checks and rate limits actually work.