Reference
API reference
Every endpoint of the integrable.cloud REST API — 188 operations in 18 groups — with parameters, schemas and an example request for each. Generated from the same OpenAPI document the SDKs are built from.
- Base URL
- https://api.integrable.cloud
- Version
- 2026-09-03
- Operations
- 188 in 18 groups
- OpenAPI
- /openapi.json
Before your first call
The Integrable Cloud API.
Authenticate with Authorization: Bearer sk_live_.... Keys are created in the dashboard under Settings -> API keys and carry scopes; a call outside a key's scopes is refused with 403.
Every mutating request accepts Idempotency-Key. Every response carries X-API-Version and, where a budget applies, RateLimit-*.
There is also an MCP server at /mcp for connecting this workspace to Claude, ChatGPT or an editor. It uses the same API keys.
New here? The quickstart goes from key to first message; retries, versioning and limits is the contract every endpoint shares; error codes explains each failure; the SDKs wrap all of it for TypeScript and Python. Point a code generator, Postman or an assistant at /openapi.json.
Bots
Create, configure and embed assistants: generate one from a plain-language description or a scan of a website, rehearse it before it goes live, restore an earlier version, and fetch the snippet a site pastes in.
- get/api/botsList bots
- post/api/botsCreate bot
- post/api/bots/generateGenerate bot
- get/api/bots/modelsAvailable models
- post/api/bots/onboarding/rehearseRehearse blueprint
- post/api/bots/onboarding/scanScan website
- post/api/bots/onboarding/variantsGenerate variants
- get/api/bots/{bot_id}Get bot
- patch/api/bots/{bot_id}Update bot
- delete/api/bots/{bot_id}Delete bot
- post/api/bots/{bot_id}/duplicateDuplicate bot
- get/api/bots/{bot_id}/embedGet embed
- get/api/bots/{bot_id}/funnelGet funnel
- post/api/bots/{bot_id}/rotate-keyRotate key
- post/api/bots/{bot_id}/suggest-improvementsSuggest improvements
- post/api/bots/{bot_id}/testTest message
- post/api/bots/{bot_id}/theme/avatarUpload avatar
- delete/api/bots/{bot_id}/theme/avatarDelete avatar
- post/api/bots/{bot_id}/theme/generateGenerate theme
- get/api/bots/{bot_id}/versionsList versions
- post/api/bots/{bot_id}/versions/{version}/restoreRestore version
Knowledge base
What an assistant answers from. Add pasted text, a single URL, a whole site or an uploaded file, watch indexing finish, and run the bot's own retrieval to see exactly what comes back for a query.
- get/api/bots/{bot_id}/knowledgeList documents
- post/api/bots/{bot_id}/knowledgeCreate document
- post/api/bots/{bot_id}/knowledge/searchSearch knowledge
- post/api/bots/{bot_id}/knowledge/uploadUpload document
- delete/api/bots/{bot_id}/knowledge/{document_id}Delete document
- get/api/bots/{bot_id}/knowledge/{document_id}/downloadDownload document
- post/api/bots/{bot_id}/knowledge/{document_id}/reindexReindex document
- get/api/bots/{bot_id}/knowledge/{document_id}/statusDocument status
Dashboard
The data behind the dashboard: conversations and contacts — including subject-access export and erasure — per-bot analytics and knowledge gaps, API keys, request logs, plan usage and saved views.
- get/api/api-keysList API keys
- post/api/api-keysCreate API key
- delete/api/api-keys/{api_key_id}Revoke API key
- get/api/bots/{bot_id}/analyticsBot analytics
- get/api/bots/{bot_id}/analytics/gapsKnowledge gaps
- get/api/bots/{bot_id}/analytics/insightsBot insights
- get/api/bots/{bot_id}/contactsList contacts
- get/api/bots/{bot_id}/contacts/exportExport contacts
- get/api/bots/{bot_id}/contacts/{contact_id}/dataExport subject data
- delete/api/bots/{bot_id}/contacts/{contact_id}/dataErase subject data
- get/api/bots/{bot_id}/conversationsList conversations
- post/api/bots/{bot_id}/conversations/bulkBulk update conversations
- get/api/bots/{bot_id}/conversations/{conversation_id}Get conversation
- get/api/logsList request logs
- get/api/logs/summaryRequest log summary
- get/api/overviewOrg overview
- get/api/usagePlan usage
- get/api/viewsList saved views
- post/api/viewsCreate saved view
- patch/api/views/{view_id}Update saved view
- delete/api/views/{view_id}Delete saved view
Inbox
Human handoff. The queue of visitors waiting for a person, longest wait first, and the calls a teammate makes to claim a conversation, reply in it, release it or resolve it.
Flows
Scripted conversation paths that run alongside grounded answers: create and edit a flow, walk it with canned answers, publish it, and see where visitors stop.
Tools
Actions an assistant can call during a chat. Define a tool, check which credential it holds, run it once exactly as a chat turn would, and read back every call it has made.
Calendars
Calendar connections and bookings: connect a provider, read availability, create and cancel bookings, and list what is coming up.
- get/api/calendarsList calendars
- get/api/calendars/bookings/upcomingList upcoming
- post/api/calendars/bookings/{booking_id}/cancelCancel booking
- get/api/calendars/connect/{provider}Connect a calendar
- patch/api/calendars/{connection_id}Update connection
- delete/api/calendars/{connection_id}Disconnect a calendar
- get/api/calendars/{connection_id}/availabilityGet availability
- post/api/calendars/{connection_id}/bookCreate booking
Destinations
Where captured leads and events are sent: connect a provider, choose which events it receives, or remove it.
Webhooks
Signed event delivery to your own endpoints. Register an endpoint, rotate its signing secret, browse the event catalogue, and inspect, test or replay individual deliveries.
- get/api/webhooksList webhooks
- post/api/webhooksCreate webhook
- get/api/webhooks/deliveriesList all deliveries
- get/api/webhooks/deliveries/{delivery_id}Get delivery
- post/api/webhooks/deliveries/{delivery_id}/replayReplay delivery
- get/api/webhooks/eventsList events
- get/api/webhooks/{webhook_id}Get webhook
- patch/api/webhooks/{webhook_id}Update webhook
- delete/api/webhooks/{webhook_id}Delete webhook
- post/api/webhooks/{webhook_id}/rotate-secretRotate secret
- post/api/webhooks/{webhook_id}/testTest webhook
Alerts
Notifications to your team when something needs attention. Price a setting before saving it, verify a destination, connect Telegram, and send a test that looks exactly like a real alert.
- get/api/alertsList channels
- put/api/alertsSave channel
- post/api/alerts/estimateEstimate an alert's cost
- post/api/alerts/telegram/connectConnect Telegram
- post/api/alerts/telegram/pollCheck the Telegram connection
- delete/api/alerts/{policy_id}Delete channel
- post/api/alerts/{policy_id}/testTest channel
- post/api/alerts/{policy_id}/verifyFinish verification
- post/api/alerts/{policy_id}/verify/startStart verification
Insights
Reporting for one bot or the whole organisation: activity and audit logs, AI recommendations, visitor intents, satisfaction, website traffic, the credit balance and statement, reports and verifiable conversation archives.
- get/api/activityWorkspace activity
- patch/api/advice/{recommendation_id}Acknowledge a recommendation
- post/api/archive/importImport archive
- post/api/archive/viewView archive
- get/api/archivesList archives
- get/api/audit-logAudit log
- get/api/bots/{bot_id}/adviceBot recommendations
- get/api/bots/{bot_id}/archiveExport archive
- get/api/bots/{bot_id}/dashboardBot dashboard
- get/api/bots/{bot_id}/intentsVisitor intents
- get/api/bots/{bot_id}/reportBot report
- get/api/bots/{bot_id}/satisfactionSatisfaction
- get/api/bots/{bot_id}/trafficWebsite traffic
- get/api/creditsCredit balance
- get/api/credits/exportExport the credit statement
- get/api/credits/statementCredit statement
- get/api/dashboardOrg dashboard
- get/api/exportsList exports
- get/api/exports/formatsExport formats
- get/api/preferencesGet dashboard preferences
- put/api/preferencesSet dashboard preferences
- get/api/reportOrg report
Workspace
The workspace itself: members and their roles, invitations, agency sub-accounts beneath this workspace, and tenant-scoped encryption.
- get/api/workspaceGet the workspace
- patch/api/workspaceUpdate workspace
- get/api/workspace/encryptionRead encryption
- put/api/workspace/encryptionSet encryption
- get/api/workspace/hierarchyWorkspace hierarchy
- get/api/workspace/invitationsList invitations
- post/api/workspace/invitationsCreate invitation
- delete/api/workspace/invitations/{invitation_id}Revoke invitation
- get/api/workspace/membersList members
- patch/api/workspace/members/{user_id}Change member role
- delete/api/workspace/members/{user_id}Remove member
- get/api/workspace/sub-accountsList sub accounts
- post/api/workspace/sub-accountsCreate sub account
- patch/api/workspace/sub-accounts/{sub_account_id}Update sub account
- delete/api/workspace/sub-accounts/{sub_account_id}Delete sub account
Auth
Accounts and sessions: registration and email verification, password and one-time-code sign-in, Google sign-in, multi-factor authentication, linked identities and accepting an invitation.
- post/api/auth/accept-invitationAccept invitation
- post/api/auth/change-passwordChange password
- post/api/auth/forgot-passwordForgot password
- post/api/auth/googleComplete Google sign-in
- get/api/auth/google/startStart Google sign-in
- get/api/auth/identitiesList identities
- delete/api/auth/identities/{provider}Unlink identity
- get/api/auth/invitationPreview invitation
- post/api/auth/loginLog in
- post/api/auth/logoutLog out
- post/api/auth/logout-allLog out everywhere
- get/api/auth/meGet the current user
- get/api/auth/mfaMFA status
- post/api/auth/mfa/activateActivate MFA
- post/api/auth/mfa/disableDisable MFA
- post/api/auth/mfa/recovery-codesRegenerate recovery codes
- post/api/auth/mfa/setupSetup MFA
- post/api/auth/mfa/verifyVerify MFA
- get/api/auth/organizationsList my organizations
- post/api/auth/otp/requestRequest OTP
- post/api/auth/otp/verifyVerify OTP
- post/api/auth/refreshRefresh a session
- post/api/auth/registerRegister an account
- post/api/auth/resend-verificationResend verification
- post/api/auth/reset-passwordReset password
- get/api/auth/verification-statusVerification status
- post/api/auth/verify-emailVerify email
Billing
Plans and payment: the price list, hosted checkout, the provider's billing portal, the current subscription, payment history, receipts as JSON or PDF, and the billing profile.
- post/api/billing/checkoutStart a checkout
- get/api/billing/paymentsPayment history
- get/api/billing/payments/{payment_id}/receiptGet a receipt
- get/api/billing/payments/{payment_id}/receipt.pdfDownload a receipt as PDF
- get/api/billing/plansList plans
- post/api/billing/portalOpen the billing portal
- get/api/billing/profileGet the billing profile
- put/api/billing/profileUpdate the billing profile
- get/api/billing/subscriptionGet the subscription
Notifications
Each person's own notification preferences, with the defaults filled in for anything they never set.
Support
Support tickets from inside the product: raise one, reply to it, close it, rate the outcome, and read the categories to choose from.
- get/api/supportList tickets
- post/api/supportCreate a ticket
- get/api/support/categoriesList ticket categories
- get/api/support/statsTicket statistics
- get/api/support/{ticket_id}Get a ticket
- post/api/support/{ticket_id}/closeClose a ticket
- post/api/support/{ticket_id}/rateRate a ticket
- post/api/support/{ticket_id}/replyReply to a ticket
Integrations
The OAuth callback every third-party connection completes through, dispatched on the provider's name.
Health
Liveness and readiness probes for monitoring: one answers without touching any dependency, the other checks the ones a request needs. Neither requires authentication.
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.