API reference
Base URL https://cybix.app/api. 471 endpoints, generated from the running server.
accounts
- POST
/api/accounts/2fa/disablePublicTotp Disable
- POST
/api/accounts/2fa/enablePublicTotp Enable
- POST
/api/accounts/2fa/recovery-codesPublicTotp New Recovery
- PUT
/api/accounts/2fa/requiredPublicWorkspace Requires 2Fa
- POST
/api/accounts/2fa/setupPublicTotp Setup
- POST
/api/accounts/2fa/verifyPublicVerify Second Factor
- POST
/api/accounts/apple-mobilePublicApple Mobile Sign In
- POST
/api/accounts/deletePublicDelete Account
- POST
/api/accounts/emailPublicChange Unverified Email
- POST
/api/accounts/google-mobilePublicGoogle Mobile Sign In
- GET
/api/accounts/invite/{token}PublicPeek Invite
- POST
/api/accounts/invite/acceptPublicAccept Invite
- POST
/api/accounts/loginPublicLogin
- POST
/api/accounts/login-code/requestPublicRequest Code
- POST
/api/accounts/login-code/verifyPublicVerify Code
- PUT
/api/accounts/me/localePublicSet My Locale
- PUT
/api/accounts/newsletterPublicSet Newsletter
- POST
/api/accounts/oauthPublicOauth Sign In
- GET
/api/accounts/onboardingPublicOnboarding Status
- POST
/api/accounts/onboarding/completePublicComplete Onboarding
- POST
/api/accounts/password/forgotPublicForgot Password
- POST
/api/accounts/password/resetPublicReset Password
- GET
/api/accounts/push-promptPublicRead Push Prompt
- PUT
/api/accounts/push-promptPublicSet Push Prompt
- POST
/api/accounts/registerPublicRegister
- GET
/api/accounts/securityPublicSecurity Status
- POST
/api/accounts/ticketPublicRedeem Ticket
- GET
/api/accounts/ui-statePublicUi State
- POST
/api/accounts/ui-statePublicUpdate Ui State
- POST
/api/accounts/verify-emailPublicVerify Email
- POST
/api/accounts/verify-email/resendPublicResend Verification
- GET
/api/accounts/wa-read-pushPublicRead Wa Read Push
- PUT
/api/accounts/wa-read-pushPublicSet Wa Read Push
- GET
/api/accounts/workspacePublicRead Workspace
- PATCH
/api/accounts/workspacePublicRename Workspace
admin
- GET
/api/admin/ai-usageX-Agent-AuthAi Usage
- PUT
/api/admin/ai-usage/pricesX-Agent-AuthSet Prices
- GET
/api/admin/billingX-Agent-AuthBilling Overview
- GET
/api/admin/demo-requestsX-Agent-AuthList Requests
- PATCH
/api/admin/demo-requests/{request_id}X-Agent-AuthSet Status
- POST
/api/admin/demo-requests/{request_id}/onboardX-Agent-AuthOnboard
- POST
/api/admin/demo-requests/{request_id}/scheduleX-Agent-AuthSchedule Demo
- GET
/api/admin/email-logX-Agent-AuthEmail Log
- GET
/api/admin/growthX-Agent-AuthGrowth
- PUT
/api/admin/growth/spendX-Agent-AuthSet Growth Spend
- GET
/api/admin/kvk/companiesX-Agent-AuthKvk Companies
- POST
/api/admin/kvk/importX-Agent-AuthKvk Import
- GET
/api/admin/leadsX-Agent-AuthLeads
- GET
/api/admin/leads/demo/{request_id}/contextX-Agent-AuthLead Context
- GET
/api/admin/licensesX-Agent-AuthList Licenses
- POST
/api/admin/licensesX-Agent-AuthIssue
- DELETE
/api/admin/licenses/{key}X-Agent-AuthRevoke
- GET
/api/admin/marketing/campaignsX-Agent-AuthList Campaigns
- POST
/api/admin/marketing/campaignsX-Agent-AuthCreate Campaign
- GET
/api/admin/marketing/campaigns/{campaign_id}/audienceX-Agent-AuthPreview Audience
- POST
/api/admin/marketing/campaigns/{campaign_id}/sendX-Agent-AuthSend Campaign
- POST
/api/admin/marketing/campaigns/{campaign_id}/testX-Agent-AuthSend Test
- GET
/api/admin/marketing/flowsX-Agent-AuthGet Flows
- PUT
/api/admin/marketing/flowsX-Agent-AuthPut Flows
- POST
/api/admin/marketing/flows/run-nowX-Agent-AuthRun Now
- GET
/api/admin/marketing/logX-Agent-AuthSend Log
- GET
/api/admin/marketing/templatesX-Agent-AuthCampaign Templates
- GET
/api/admin/overviewX-Agent-AuthOverview
- GET
/api/admin/revenueX-Agent-AuthRevenue
- GET
/api/admin/usageX-Agent-AuthUsage
- PUT
/api/admin/usage/limitsX-Agent-AuthPut Limits
- PATCH
/api/admin/users/{user_id}X-Agent-AuthSet User Details
- DELETE
/api/admin/users/{user_id}X-Agent-AuthDelete User
- PATCH
/api/admin/users/{user_id}/roleX-Agent-AuthSet Role
- GET
/api/admin/workspaces/{workspace_id}X-Agent-AuthWorkspace Detail
- PATCH
/api/admin/workspaces/{workspace_id}X-Agent-AuthSet Workspace Details
- DELETE
/api/admin/workspaces/{workspace_id}X-Agent-AuthDelete Workspace
- PUT
/api/admin/workspaces/{workspace_id}/addonsX-Agent-AuthSet Addons
- GET
/api/admin/workspaces/{workspace_id}/companyX-Agent-AuthWorkspace Company
- PUT
/api/admin/workspaces/{workspace_id}/companyX-Agent-AuthSet Workspace Company
- POST
/api/admin/workspaces/{workspace_id}/impersonateX-Agent-AuthImpersonate
- PATCH
/api/admin/workspaces/{workspace_id}/planX-Agent-AuthSet Plan
- GET
/api/admin/workspaces/{workspace_id}/usersX-Agent-AuthWorkspace Users
agents
- POST
/api/agents/loginX-Agent-AuthAgent Login
- GET
/api/agents/meX-Agent-AuthAgent Me
ai
- POST
/api/ai/assistX-Agent-AuthAssist
- POST
/api/ai/call-prepX-Agent-AuthCall Prep
- POST
/api/ai/chatX-Agent-AuthAssistant Chat
- POST
/api/ai/commandX-Agent-AuthCommand
- POST
/api/ai/composeX-Agent-AuthCompose
- POST
/api/ai/copilotX-Agent-AuthCopilot Suggest
- POST
/api/ai/transcribeX-Agent-AuthTranscribe Audio
- GET
/api/ai/voice-contextX-Agent-AuthVoice Context
analytics
- GET
/api/analytics/ga/configX-Agent-AuthGa Config
- PUT
/api/analytics/ga/configX-Agent-AuthGa Save
- POST
/api/analytics/ga/oauth/exchangeX-Agent-AuthGa Oauth Exchange
- GET
/api/analytics/ga/oauth/urlX-Agent-AuthGa Oauth Url
- GET
/api/analytics/ga/propertiesX-Agent-AuthGa Properties
- PUT
/api/analytics/ga/propertyX-Agent-AuthGa Set Property
- GET
/api/analytics/ga/reportX-Agent-AuthGa Report
- GET
/api/analytics/overviewX-Agent-AuthOverview
- GET
/api/analytics/trafficX-Agent-AuthTraffic
appointments
- GET
/api/appointmentsX-Agent-AuthList Agenda
- POST
/api/appointmentsX-Agent-AuthCreate
- PATCH
/api/appointments/{appointment_id}X-Agent-AuthUpdate
- DELETE
/api/appointments/{appointment_id}X-Agent-AuthCancel
- GET
/api/appointments/{appointment_id}.icsX-Agent-AuthDownload
- POST
/api/appointments/blocksX-Agent-AuthCreate Block
- DELETE
/api/appointments/blocks/{block_id}X-Agent-AuthDelete Block
- POST
/api/appointments/inviteX-Agent-AuthInvite
- GET
/api/appointments/invite/prefillX-Agent-AuthInvite Prefill
assistant
- GET
/api/assistant/channelsX-Agent-AuthGet Channel Overrides
- PUT
/api/assistant/channelsX-Agent-AuthPut Channel Overrides
- POST
/api/assistant/channels/suggestX-Agent-AuthSuggest Channel Instructions
- POST
/api/assistant/learnX-Agent-AuthLearn From Conversations
- GET
/api/assistant/lessonX-Agent-AuthLast Lesson
- POST
/api/assistant/lesson/applyX-Agent-AuthApply Lesson
- GET
/api/assistant/promptX-Agent-AuthPreview Prompt
- GET
/api/assistant/settingsX-Agent-AuthGet Settings
- PUT
/api/assistant/settingsX-Agent-AuthPut Settings
- POST
/api/assistant/simulateX-Agent-AuthSimulate
- POST
/api/assistant/suggestX-Agent-AuthSuggest Settings
- POST
/api/assistant/suggest/qualificationX-Agent-AuthSuggest Qualification
automations
- GET
/api/automationsX-Agent-AuthList Automations
- POST
/api/automationsX-Agent-AuthCreate Automation
- PATCH
/api/automations/{automation_id}X-Agent-AuthUpdate Automation
- DELETE
/api/automations/{automation_id}X-Agent-AuthDelete Automation
- POST
/api/automations/{automation_id}/runX-Agent-AuthRun Automation
- GET
/api/automations/{automation_id}/runsX-Agent-AuthList Runs
billing
- POST
/api/billing/apple/notificationsX-Agent-AuthStore Notification
- POST
/api/billing/apple/verifyX-Agent-AuthVerify Purchase
- POST
/api/billing/checkoutX-Agent-AuthCreate Checkout
- POST
/api/billing/portalX-Agent-AuthCustomer Portal
- GET
/api/billing/statusX-Agent-AuthSubscription Status
- POST
/api/billing/webhookX-Agent-AuthWebhook
book
- GET
/api/book/public/{widget}X-Agent-AuthPage Data
- POST
/api/book/public/{widget}X-Agent-AuthBook
calendar
- GET
/api/calendar/googleX-Agent-AuthStatus
- DELETE
/api/calendar/googleX-Agent-AuthDisconnect
- GET
/api/calendar/google/busyX-Agent-AuthBusy Blocks
- POST
/api/calendar/google/exchangeX-Agent-AuthExchange
- GET
/api/calendar/google/urlX-Agent-AuthConsent Url
calls
- GET
/api/callsX-Agent-AuthList Calls
- POST
/api/calls/{room}/send/chatX-Agent-AuthSend To Conversation
- POST
/api/calls/{room}/send/emailX-Agent-AuthSend By Email
- POST
/api/calls/{room}/transcribeX-Agent-AuthTranscribe
- GET
/api/calls/{room}/transcriptX-Agent-AuthRead Transcript
community
- GET
/api/communityX-Agent-AuthList Posts
- POST
/api/communityX-Agent-AuthCreate Post
- GET
/api/community/{post_id}X-Agent-AuthRead Post
- DELETE
/api/community/{post_id}X-Agent-AuthDelete Post
- POST
/api/community/{post_id}/commentsX-Agent-AuthAdd Comment
company
- GET
/api/companyX-Agent-AuthGet Profile
- PUT
/api/companyX-Agent-AuthPut Profile
- GET
/api/company/lookupX-Agent-AuthLookup
contacts
- GET
/api/contactsX-Agent-AuthList Contacts
- PATCH
/api/contacts/{visitor_id}X-Agent-AuthUpdate Contact
- DELETE
/api/contacts/{visitor_id}X-Agent-AuthDelete Contact
conversations
- GET
/api/conversationsX-Agent-AuthList Conversations
- GET
/api/conversations/{conversation_id}X-Agent-AuthGet Conversation
- PATCH
/api/conversations/{conversation_id}X-Agent-AuthUpdate Conversation
- POST
/api/conversations/{conversation_id}/assignX-Agent-AuthAssign Conversation
- POST
/api/conversations/{conversation_id}/closeX-Agent-AuthClose Conversation
- POST
/api/conversations/{conversation_id}/intakeX-Agent-AuthStart Intake
- DELETE
/api/conversations/{conversation_id}/intakeX-Agent-AuthStop Intake
- POST
/api/conversations/{conversation_id}/matchX-Agent-AuthMatch Specialist
- GET
/api/conversations/{conversation_id}/matchesX-Agent-AuthList Matches
- DELETE
/api/conversations/{conversation_id}/matches/{match_id}X-Agent-AuthRevoke Match
- GET
/api/conversations/{conversation_id}/messagesBearer tokenList Messages
- POST
/api/conversations/{conversation_id}/messagesBearer tokenSend Visitor Message
- PUT
/api/conversations/{conversation_id}/messages/{message_id}/reactionBearer tokenReact To Message
- POST
/api/conversations/{conversation_id}/messages/{message_id}/retryBearer tokenRetry Agent Message
- POST
/api/conversations/{conversation_id}/messages/agentBearer tokenSend Agent Message
- POST
/api/conversations/{conversation_id}/messages/agent/uploadBearer tokenUpload Agent Attachment
- POST
/api/conversations/{conversation_id}/messages/forwardBearer tokenForward Messages
- POST
/api/conversations/{conversation_id}/messages/openerBearer tokenRequest Opener
- POST
/api/conversations/{conversation_id}/messages/uploadBearer tokenUpload Visitor Attachment
- POST
/api/conversations/{conversation_id}/readX-Agent-AuthMark Read
- GET
/api/conversations/{conversation_id}/threadX-Agent-AuthList Conversation Thread
- POST
/api/conversations/{conversation_id}/ticketX-Agent-AuthConvert To Ticket
- POST
/api/conversations/{conversation_id}/typingX-Agent-AuthSet Typing
- POST
/api/conversations/{conversation_id}/unreadX-Agent-AuthMark Unread
- POST
/api/conversations/{conversation_id}/visitor-ticketX-Agent-AuthVisitor Ticket
- GET
/api/conversations/searchX-Agent-AuthSearch Conversations
- GET
/api/conversations/sourcesX-Agent-AuthList Conversation Sources
- POST
/api/conversations/transcribe-voice-notesX-Agent-AuthTranscribe Voice Notes
customer-context
- GET
/api/customer-context/{visitor_id}X-Agent-AuthRead Context
- PUT
/api/customer-context/{visitor_id}X-Agent-AuthWrite Context
- POST
/api/customer-context/{visitor_id}/regenerateX-Agent-AuthRegenerate
- GET
/api/customer-context/backfillX-Agent-AuthBackfill Status
- POST
/api/customer-context/backfillX-Agent-AuthStart Backfill
demo-requests
- POST
/api/demo-requestsX-Agent-AuthSubmit
email-templates
- GET
/api/email-templatesX-Agent-AuthRead Templates
- PUT
/api/email-templatesX-Agent-AuthWrite Templates
geo
- GET
/api/geo/geocodeX-Agent-AuthGeocode
- GET
/api/geo/whereisX-Agent-AuthWhereis
health
- GET
/healthPublicHealth
helpdesk
- GET
/api/helpdeskX-Agent-AuthList Connections
- POST
/api/helpdeskX-Agent-AuthCreate Connection
- PATCH
/api/helpdesk/{connection_id}X-Agent-AuthPatch Connection
- DELETE
/api/helpdesk/{connection_id}X-Agent-AuthDelete Connection
- POST
/api/helpdesk/{connection_id}/syncX-Agent-AuthSync Now
imports
- POST
/api/imports/helpdeskX-Agent-AuthImport Helpdesk
- POST
/api/imports/macrosX-Agent-AuthAdd Macro
- GET
/api/imports/macrosX-Agent-AuthList Macros
- POST
/api/imports/watermelonX-Agent-AuthImport Watermelon
inboxes
- GET
/api/inboxesX-Agent-AuthList Inboxes
- POST
/api/inboxesX-Agent-AuthCreate Inbox
- DELETE
/api/inboxes/{inbox_id}X-Agent-AuthDelete Inbox
intake
- GET
/api/intake/optionsX-Agent-AuthIntake Options
integrations
- GET
/api/integrations/endpointsX-Agent-AuthList Endpoints
- POST
/api/integrations/endpointsX-Agent-AuthCreate Endpoint
- PUT
/api/integrations/endpoints/{endpoint_id}X-Agent-AuthUpdate Endpoint
- DELETE
/api/integrations/endpoints/{endpoint_id}X-Agent-AuthDelete Endpoint
- POST
/api/integrations/endpoints/{endpoint_id}/testX-Agent-AuthTest Endpoint
- GET
/api/integrations/kantexX-Agent-AuthRead Settings
- PUT
/api/integrations/kantexX-Agent-AuthSave Settings
- DELETE
/api/integrations/kantexX-Agent-AuthDisconnect
- GET
/api/integrations/kantex/conversations/{conversation_id}X-Agent-AuthConversation Tickets
- POST
/api/integrations/kantex/testX-Agent-AuthTest Connection
- GET
/api/integrations/keysX-Agent-AuthList Keys
- POST
/api/integrations/keysX-Agent-AuthCreate Key
- DELETE
/api/integrations/keys/{key_id}X-Agent-AuthRevoke Key
- GET
/api/integrations/overviewX-Agent-AuthOverview
- GET
/api/integrations/webhooksX-Agent-AuthList Webhooks
- POST
/api/integrations/webhooksX-Agent-AuthCreate Webhook
- PATCH
/api/integrations/webhooks/{webhook_id}X-Agent-AuthUpdate Webhook
- DELETE
/api/integrations/webhooks/{webhook_id}X-Agent-AuthDelete Webhook
- GET
/api/integrations/webhooks/{webhook_id}/deliveriesX-Agent-AuthList Deliveries
- POST
/api/integrations/webhooks/{webhook_id}/pingX-Agent-AuthPing Webhook
- POST
/api/integrations/webhooks/{webhook_id}/rotate-secretX-Agent-AuthRotate Secret
- GET
/api/integrations/zzpwerkvinden/lead-intakeX-Agent-AuthZzp Lead Intake
internal
- GET
/api/internal/lead-feedX-Agent-AuthLead Feed
invites
- GET
/api/invitesX-Agent-AuthList Invites
- POST
/api/invitesX-Agent-AuthCreate Invite
- DELETE
/api/invites/{invite_id}X-Agent-AuthRevoke Invite
knowledge
- POST
/api/knowledge/crawlX-Agent-AuthCrawl
- GET
/api/knowledge/documentX-Agent-AuthRead Document
- PUT
/api/knowledge/documentX-Agent-AuthWrite Document
- DELETE
/api/knowledge/documentX-Agent-AuthDelete Document
- POST
/api/knowledge/document/assistX-Agent-AuthAssist Document
- POST
/api/knowledge/optimize-allX-Agent-AuthOptimize All
- GET
/api/knowledge/searchX-Agent-AuthSearch
- DELETE
/api/knowledge/sources/{domain}X-Agent-AuthDelete Source
- GET
/api/knowledge/statusX-Agent-AuthStatus
- GET
/api/knowledge/treeX-Agent-AuthTree
leads
- GET
/api/leadsX-Agent-AuthList Leads
- PATCH
/api/leads/{lead_id}X-Agent-AuthPatch Lead
- POST
/api/leads/{lead_id}/enrichX-Agent-AuthEnrich Lead
license
- GET
/api/license/bundleX-Agent-AuthDownload Bundle
- GET
/api/license/mineX-Agent-AuthMy Licenses
- POST
/api/license/validateX-Agent-AuthValidate
mail-hosting
- DELETE
/api/mail-hosting/accounts/{account_id}X-Agent-AuthRemove Mailbox
- GET
/api/mail-hosting/domainsX-Agent-AuthList Domains
- POST
/api/mail-hosting/domainsX-Agent-AuthAdd Domain
- GET
/api/mail-hosting/domains/{domain_id}/accountsX-Agent-AuthList Accounts
- POST
/api/mail-hosting/domains/{domain_id}/accountsX-Agent-AuthCreate Mailbox
- GET
/api/mail-hosting/domains/{domain_id}/dnsX-Agent-AuthDomain Dns
- GET
/api/mail-hosting/statusX-Agent-AuthStatus
mailboxes
- GET
/api/mailboxesX-Agent-AuthList Mailboxes
- POST
/api/mailboxesX-Agent-AuthCreate Mailbox
- DELETE
/api/mailboxes/{mailbox_id}X-Agent-AuthDelete Mailbox
- POST
/api/mailboxes/{mailbox_id}/syncX-Agent-AuthSync Mailbox
- POST
/api/mailboxes/oauth/{provider}/exchangeX-Agent-AuthMailbox Oauth Exchange
- GET
/api/mailboxes/oauth/{provider}/urlX-Agent-AuthMailbox Oauth Url
mcp
- GET
/api/mcpX-Agent-AuthNo Stream
- POST
/api/mcpX-Agent-AuthRpc
- GET
/api/mcp/skillX-Agent-AuthSkill
media
- GET
/api/media/{media_id}X-Agent-AuthGet Media
meet
- POST
/api/meetX-Agent-AuthCreate Meeting
- GET
/api/meetX-Agent-AuthList Meetings
- GET
/api/meet/{code}X-Agent-AuthMeeting Info
- POST
/api/meet/{code}/audioX-Agent-AuthUpload Audio
- GET
/api/meet/{code}/detailX-Agent-AuthMeeting Detail
- POST
/api/meet/{code}/endX-Agent-AuthEnd Meeting
- POST
/api/meet/{code}/hostX-Agent-AuthHost Ticket
- POST
/api/meet/{code}/joinX-Agent-AuthJoin Meeting
members
- GET
/api/membersX-Agent-AuthList Members
- DELETE
/api/members/{user_id}X-Agent-AuthRemove Member
notifications
- GET
/api/notificationsX-Agent-AuthList Notifications
- DELETE
/api/notificationsX-Agent-AuthClear Notifications
- POST
/api/notifications/readX-Agent-AuthRead Notifications
onboarding
- POST
/api/onboarding/applyX-Agent-AuthApply
- POST
/api/onboarding/autofillX-Agent-AuthAutofill
- GET
/api/onboarding/registryX-Agent-AuthRegistry Hint
- GET
/api/onboarding/sectorsX-Agent-AuthSectors
- GET
/api/onboarding/template/{sector}X-Agent-AuthTemplate
ops
- GET
/api/ops/slaX-Agent-AuthRead Sla
- PUT
/api/ops/slaX-Agent-AuthSave Sla
- GET
/api/ops/whatsapp-relayX-Agent-AuthRead Whatsapp Relay
- PUT
/api/ops/whatsapp-relayX-Agent-AuthSave Whatsapp Relay
- GET
/api/ops/workloadX-Agent-AuthRead Workload
- PUT
/api/ops/workloadX-Agent-AuthSave Workload
outbound
- GET
/api/outbound/{collection}X-Agent-AuthList Items
- POST
/api/outbound/{collection}X-Agent-AuthCreate Item
- GET
/api/outbound/{collection}/{item_id}X-Agent-AuthGet Item
- PATCH
/api/outbound/{collection}/{item_id}X-Agent-AuthUpdate Item
- DELETE
/api/outbound/{collection}/{item_id}X-Agent-AuthDelete Item
- POST
/api/outbound/audience/email-countX-Agent-AuthEmail Audience Count
- POST
/api/outbound/public/checklists/{checklist_id}/items/{entry_id}/completeX-Agent-AuthComplete Entry
- GET
/api/outbound/public/e/c/{token}X-Agent-AuthMail Clicked
- GET
/api/outbound/public/e/o/{token}X-Agent-AuthMail Opened
- GET
/api/outbound/public/e/u/{token}X-Agent-AuthUnsubscribe Form
- POST
/api/outbound/public/e/u/{token}X-Agent-AuthUnsubscribe
- POST
/api/outbound/public/eventsX-Agent-AuthEvent
- POST
/api/outbound/public/feedX-Agent-AuthFeed
- POST
/api/outbound/public/surveys/{survey_id}/responsesX-Agent-AuthAnswer Survey
- GET
/api/outbound/surveys/{item_id}/resultsX-Agent-AuthSurvey Results
persona
- GET
/api/personaX-Agent-AuthRead Persona
- PATCH
/api/personaX-Agent-AuthPatch Profile
- POST
/api/persona/correctionsX-Agent-AuthAdd Correction
- GET
/api/persona/correctionsX-Agent-AuthList Corrections
- GET
/api/persona/examplesX-Agent-AuthExamples
- POST
/api/persona/importX-Agent-AuthImport History
- POST
/api/persona/import-archiveX-Agent-AuthImport Archive
- GET
/api/persona/import-statusX-Agent-AuthImport Status
- POST
/api/persona/learn-from-historyX-Agent-AuthLearn From History
- POST
/api/persona/scoreX-Agent-AuthScore
plan
- GET
/api/planX-Agent-AuthRead Plan
- PUT
/api/plan/brandingX-Agent-AuthUpdate Branding
- GET
/api/plan/branding/by-hostX-Agent-AuthBranding By Host
- GET
/api/plan/branding/domain-checkX-Agent-AuthDomain Check
- GET
/api/plan/catalogueX-Agent-AuthCatalogue
- GET
/api/plan/usageX-Agent-AuthRead Usage
plugins
- POST
/api/plugins/wordpress/claimX-Agent-AuthClaim
- POST
/api/plugins/wordpress/connect-codeX-Agent-AuthConnect Code
- POST
/api/plugins/wordpress/exchangeX-Agent-AuthExchange
- POST
/api/plugins/wordpress/handoffX-Agent-AuthHandoff
- POST
/api/plugins/wordpress/site-keyX-Agent-AuthSite Key
- GET
/api/plugins/wordpress/summaryX-Agent-AuthSummary
presence
- GET
/api/presence/availabilityX-Agent-AuthAvailability
- POST
/api/presence/heartbeatX-Agent-AuthHeartbeat
- GET
/api/presence/meX-Agent-AuthMy Workspace Presence
privacy
- GET
/api/privacy/auditX-Agent-AuthGet Audit
- POST
/api/privacy/contacts/{visitor_id}/anonymizeX-Agent-AuthAnonymize Contact
- POST
/api/privacy/contacts/{visitor_id}/eraseX-Agent-AuthErase Contact
- GET
/api/privacy/contacts/{visitor_id}/exportX-Agent-AuthExport Contact
- POST
/api/privacy/conversations/eraseX-Agent-AuthErase Conversations
- GET
/api/privacy/exportX-Agent-AuthExport Workspace
- GET
/api/privacy/settingsX-Agent-AuthGet Settings
- PUT
/api/privacy/settingsX-Agent-AuthPut Settings
- POST
/api/privacy/workspace/deletionX-Agent-AuthSchedule Deletion
- DELETE
/api/privacy/workspace/deletionX-Agent-AuthCancel Deletion
private-ai
- GET
/api/private-ai/connectionsX-Agent-AuthList Connections
- POST
/api/private-ai/connections/{label}/loginX-Agent-AuthLogin
- POST
/api/private-ai/connections/{label}/logoutX-Agent-AuthLogout
- POST
/api/private-ai/connections/{label}/testX-Agent-AuthTest Connection
- POST
/api/private-ai/profilesX-Agent-AuthAdd Profile
- GET
/api/private-ai/testsX-Agent-AuthRecent Tests
provider
- GET
/api/providerX-Agent-AuthRead Provider
- PUT
/api/providerX-Agent-AuthWrite Provider
- POST
/api/provider/testX-Agent-AuthTest Provider
push
- POST
/api/push/devicesX-Agent-AuthRegister Device
- POST
/api/push/devices/unregisterX-Agent-AuthUnregister Device
- POST
/api/push/testX-Agent-AuthSend Test
push-reply
- POST
/api/push-reply/bixX-Agent-AuthBix
- POST
/api/push-reply/readX-Agent-AuthRead
- POST
/api/push-reply/replyX-Agent-AuthReply
reports
- GET
/api/reportsX-Agent-AuthReport
reseller
- POST
/api/reseller/clientsX-Agent-AuthCreate Client
- GET
/api/reseller/clients/{client_id}X-Agent-AuthClient Detail
- PATCH
/api/reseller/clients/{client_id}/planX-Agent-AuthSet Client Plan
- POST
/api/reseller/clients/{client_id}/usersX-Agent-AuthAdd Client User
- GET
/api/reseller/overviewX-Agent-AuthOverview
rtc
- POST
/api/rtc/roomsPublicCreate Room
- POST
/api/rtc/rooms/{room_id}/signalPublicPost Signal
- GET
/api/rtc/rooms/{room_id}/signalPublicGet Signals
seats
- GET
/api/seatsX-Agent-AuthSeat Overview
sessions
- POST
/api/sessionsBearer tokenCreate Session
- GET
/api/sessions/{conversation_id}Bearer tokenGet Session
- POST
/api/sessions/{conversation_id}/endBearer tokenEnd Session
- POST
/api/sessions/{conversation_id}/handoverBearer tokenRequest Handover
- POST
/api/sessions/{conversation_id}/shop-eventBearer tokenShop Event
- PATCH
/api/sessions/{conversation_id}/visitorBearer tokenUpdate Visitor
- GET
/api/sessions/suggestionsBearer tokenSuggestions
share
- GET
/api/share/{token}X-Agent-AuthRead Share
- GET
/api/share/{token}/media/{media_id}X-Agent-AuthRead Share Media
shop
- GET
/api/shop/categoriesX-Agent-AuthCategories
- DELETE
/api/shop/connectX-Agent-AuthDisconnect
- GET
/api/shop/conversionX-Agent-AuthConversion
- PUT
/api/shop/settingsX-Agent-AuthSettings
- POST
/api/shop/shopify/connectX-Agent-AuthConnect Shopify
- GET
/api/shop/statusX-Agent-AuthStatus
- PUT
/api/shop/stores/{store_id}X-Agent-AuthRename Store
- DELETE
/api/shop/stores/{store_id}X-Agent-AuthRemove Store
- POST
/api/shop/syncX-Agent-AuthSync
- GET
/api/shop/webhook-infoX-Agent-AuthWebhook Info
- POST
/api/shop/webhook/shopify/{workspace_id}X-Agent-AuthShopify Webhook
- POST
/api/shop/webhook/woocommerce/{workspace_id}X-Agent-AuthWebhook
- POST
/api/shop/woocommerce/authorizeX-Agent-AuthAuthorize
- POST
/api/shop/woocommerce/connectX-Agent-AuthConnect
- POST
/api/shop/woocommerce/wc-auth/callbackX-Agent-AuthWc Auth Callback
sso
- POST
/api/sso/callbackX-Agent-AuthCallback
- GET
/api/sso/configX-Agent-AuthRead Config
- PUT
/api/sso/configX-Agent-AuthSave Config
- POST
/api/sso/exchangeX-Agent-AuthExchange
- POST
/api/sso/startX-Agent-AuthStart
telegram
- POST
/api/telegram/connectX-Agent-AuthConnect
- DELETE
/api/telegram/connectX-Agent-AuthDisconnect
- GET
/api/telegram/statusX-Agent-AuthStatus
- POST
/api/telegram/webhook/{secret}X-Agent-AuthWebhook
tickets
- GET
/api/ticketsX-Agent-AuthList Tickets
- POST
/api/ticketsX-Agent-AuthCreate Ticket
- GET
/api/tickets/{ticket_id}X-Agent-AuthGet Ticket
- PATCH
/api/tickets/{ticket_id}X-Agent-AuthUpdate Ticket
- DELETE
/api/tickets/{ticket_id}X-Agent-AuthDelete Ticket
- POST
/api/tickets/{ticket_id}/cancelX-Agent-AuthCancel Ticket
- GET
/api/tickets/{ticket_id}/commentsX-Agent-AuthList Comments
- POST
/api/tickets/{ticket_id}/commentsX-Agent-AuthAdd Comment
- POST
/api/tickets/{ticket_id}/expediteX-Agent-AuthExpedite Ticket
track
- POST
/api/trackX-Agent-AuthTrack
translate
- POST
/api/translateX-Agent-AuthTranslate
trial
- GET
/api/trial/admin/pendingX-Agent-AuthPending
- POST
/api/trial/admin/workspaces/{workspace_id}/activateX-Agent-AuthActivate
- POST
/api/trial/admin/workspaces/{workspace_id}/overrideX-Agent-AuthOverride
- GET
/api/trial/agreementX-Agent-AuthGet Agreement
- GET
/api/trial/agreement/{signature_id}/pdfX-Agent-AuthAgreement Pdf
- POST
/api/trial/agreement/signX-Agent-AuthSign Agreement
- GET
/api/trial/agreementsX-Agent-AuthList Agreements
- POST
/api/trial/invoice-requestX-Agent-AuthInvoice Request
- GET
/api/trial/statusX-Agent-AuthGet Status
v1
- GET
/api/v1/contactsX-Agent-AuthList contacts
- GET
/api/v1/conversationsX-Agent-AuthList conversations
- GET
/api/v1/conversations/{conversation_id}X-Agent-AuthGet one conversation
- POST
/api/v1/conversations/{conversation_id}/assignX-Agent-AuthAssign a conversation to a team member
- GET
/api/v1/conversations/{conversation_id}/messagesBearer tokenList messages of a conversation
- POST
/api/v1/conversations/{conversation_id}/messagesBearer tokenSend a message to the contact
- POST
/api/v1/conversations/{conversation_id}/notesX-Agent-AuthAdd an internal note to a conversation
- POST
/api/v1/conversations/{conversation_id}/pauseX-Agent-AuthPause the AI assistant (BIX) on a conversation
- POST
/api/v1/conversations/{conversation_id}/resumeX-Agent-AuthResume the AI assistant (BIX) on a conversation
- GET
/api/v1/endpointsX-Agent-AuthList AI endpoints
- POST
/api/v1/endpoints/{slug}X-Agent-AuthRun an AI endpoint on posted input
- GET
/api/v1/endpoints/{slug}X-Agent-AuthRun an AI endpoint
- GET
/api/v1/meX-Agent-AuthIdentify the API key
- GET
/api/v1/membersX-Agent-AuthList workspace members
- POST
/api/v1/whatsapp/intakesX-Agent-AuthStart a WhatsApp conversation with an AI intake
voice
- POST
/api/voice/brainX-Agent-AuthVoice Brain Reply
- GET
/api/voice/callsX-Agent-AuthList Calls
- POST
/api/voice/callsX-Agent-AuthCreate Call
- DELETE
/api/voice/calls/{call_id}X-Agent-AuthEnd Call
- GET
/api/voice/configX-Agent-AuthVoice Config
- GET
/api/voice/limitsX-Agent-AuthRead Limits
- PUT
/api/voice/limitsX-Agent-AuthWrite Limits
- POST
/api/voice/tokenX-Agent-AuthBrowser Token
- POST
/api/voice/web-callX-Agent-AuthStart Web Call
webpush
- GET
/api/webpush/audienceX-Agent-AuthAudience
- POST
/api/webpush/broadcastX-Agent-AuthBroadcast
- GET
/api/webpush/keyX-Agent-AuthPublic Key
- POST
/api/webpush/subscribeX-Agent-AuthSubscribe
- POST
/api/webpush/testX-Agent-AuthSend Test
- POST
/api/webpush/unsubscribeX-Agent-AuthUnsubscribe
- GET
/api/whatsapp/connectionX-Agent-AuthGet Connection
- DELETE
/api/whatsapp/connectionX-Agent-AuthDisconnect
- POST
/api/whatsapp/connection/connectX-Agent-AuthConnect
- POST
/api/whatsapp/connection/import-groupsX-Agent-AuthImport Groups
- POST
/api/whatsapp/controlX-Agent-AuthControl
- POST
/api/whatsapp/deletedX-Agent-AuthDeleted
- POST
/api/whatsapp/evo/{instance}X-Agent-AuthEvo Webhook
- POST
/api/whatsapp/inboundX-Agent-AuthInbound
- POST
/api/whatsapp/media-upgradeX-Agent-AuthMedia Upgrade
- POST
/api/whatsapp/messages/{message_id}/refetch-mediaBearer tokenRefetch Media
- POST
/api/whatsapp/ownX-Agent-AuthOwn Message
- GET
/api/whatsapp/qrX-Agent-AuthWhatsapp Qr
- POST
/api/whatsapp/readX-Agent-AuthDevice Read
- POST
/api/whatsapp/repairX-Agent-AuthWhatsapp Repair
- GET
/api/whatsapp/statusX-Agent-AuthWhatsapp Status
widget
- POST
/api/widget/assetsX-Agent-AuthUpload Asset
- GET
/api/widget/assets/{name}X-Agent-AuthServe Asset
- POST
/api/widget/fields/suggestX-Agent-AuthSuggest Fields
- GET
/api/widget/settingsPublicGet Settings
- PUT
/api/widget/settingsPublicPut Settings
- GET
/api/widget/widgetsX-Agent-AuthList Widgets
- POST
/api/widget/widgetsX-Agent-AuthCreate Widget
- PATCH
/api/widget/widgets/{widget_id}X-Agent-AuthRename Widget
- DELETE
/api/widget/widgets/{widget_id}X-Agent-AuthDelete Widget
ws
- POST
/api/ws/ticketX-Agent-AuthWs Ticket