API reference

Base URL https://cybix.app/api. 471 endpoints, generated from the running server.

accounts

  • POST/api/accounts/2fa/disablePublic

    Totp Disable

  • POST/api/accounts/2fa/enablePublic

    Totp Enable

  • POST/api/accounts/2fa/recovery-codesPublic

    Totp New Recovery

  • PUT/api/accounts/2fa/requiredPublic

    Workspace Requires 2Fa

  • POST/api/accounts/2fa/setupPublic

    Totp Setup

  • POST/api/accounts/2fa/verifyPublic

    Verify Second Factor

  • POST/api/accounts/apple-mobilePublic

    Apple Mobile Sign In

  • POST/api/accounts/deletePublic

    Delete Account

  • POST/api/accounts/emailPublic

    Change Unverified Email

  • POST/api/accounts/google-mobilePublic

    Google Mobile Sign In

  • GET/api/accounts/invite/{token}Public

    Peek Invite

  • POST/api/accounts/invite/acceptPublic

    Accept Invite

  • POST/api/accounts/loginPublic

    Login

  • POST/api/accounts/login-code/requestPublic

    Request Code

  • POST/api/accounts/login-code/verifyPublic

    Verify Code

  • PUT/api/accounts/me/localePublic

    Set My Locale

  • PUT/api/accounts/newsletterPublic

    Set Newsletter

  • POST/api/accounts/oauthPublic

    Oauth Sign In

  • GET/api/accounts/onboardingPublic

    Onboarding Status

  • POST/api/accounts/onboarding/completePublic

    Complete Onboarding

  • POST/api/accounts/password/forgotPublic

    Forgot Password

  • POST/api/accounts/password/resetPublic

    Reset Password

  • GET/api/accounts/push-promptPublic

    Read Push Prompt

  • PUT/api/accounts/push-promptPublic

    Set Push Prompt

  • POST/api/accounts/registerPublic

    Register

  • GET/api/accounts/securityPublic

    Security Status

  • POST/api/accounts/ticketPublic

    Redeem Ticket

  • GET/api/accounts/ui-statePublic

    Ui State

  • POST/api/accounts/ui-statePublic

    Update Ui State

  • POST/api/accounts/verify-emailPublic

    Verify Email

  • POST/api/accounts/verify-email/resendPublic

    Resend Verification

  • GET/api/accounts/wa-read-pushPublic

    Read Wa Read Push

  • PUT/api/accounts/wa-read-pushPublic

    Set Wa Read Push

  • GET/api/accounts/workspacePublic

    Read Workspace

  • PATCH/api/accounts/workspacePublic

    Rename Workspace

admin

  • GET/api/admin/ai-usageX-Agent-Auth

    Ai Usage

  • PUT/api/admin/ai-usage/pricesX-Agent-Auth

    Set Prices

  • GET/api/admin/billingX-Agent-Auth

    Billing Overview

  • GET/api/admin/demo-requestsX-Agent-Auth

    List Requests

  • PATCH/api/admin/demo-requests/{request_id}X-Agent-Auth

    Set Status

  • POST/api/admin/demo-requests/{request_id}/onboardX-Agent-Auth

    Onboard

  • POST/api/admin/demo-requests/{request_id}/scheduleX-Agent-Auth

    Schedule Demo

  • GET/api/admin/email-logX-Agent-Auth

    Email Log

  • GET/api/admin/growthX-Agent-Auth

    Growth

  • PUT/api/admin/growth/spendX-Agent-Auth

    Set Growth Spend

  • GET/api/admin/kvk/companiesX-Agent-Auth

    Kvk Companies

  • POST/api/admin/kvk/importX-Agent-Auth

    Kvk Import

  • GET/api/admin/leadsX-Agent-Auth

    Leads

  • GET/api/admin/leads/demo/{request_id}/contextX-Agent-Auth

    Lead Context

  • GET/api/admin/licensesX-Agent-Auth

    List Licenses

  • POST/api/admin/licensesX-Agent-Auth

    Issue

  • DELETE/api/admin/licenses/{key}X-Agent-Auth

    Revoke

  • GET/api/admin/marketing/campaignsX-Agent-Auth

    List Campaigns

  • POST/api/admin/marketing/campaignsX-Agent-Auth

    Create Campaign

  • GET/api/admin/marketing/campaigns/{campaign_id}/audienceX-Agent-Auth

    Preview Audience

  • POST/api/admin/marketing/campaigns/{campaign_id}/sendX-Agent-Auth

    Send Campaign

  • POST/api/admin/marketing/campaigns/{campaign_id}/testX-Agent-Auth

    Send Test

  • GET/api/admin/marketing/flowsX-Agent-Auth

    Get Flows

  • PUT/api/admin/marketing/flowsX-Agent-Auth

    Put Flows

  • POST/api/admin/marketing/flows/run-nowX-Agent-Auth

    Run Now

  • GET/api/admin/marketing/logX-Agent-Auth

    Send Log

  • GET/api/admin/marketing/templatesX-Agent-Auth

    Campaign Templates

  • GET/api/admin/overviewX-Agent-Auth

    Overview

  • GET/api/admin/revenueX-Agent-Auth

    Revenue

  • GET/api/admin/usageX-Agent-Auth

    Usage

  • PUT/api/admin/usage/limitsX-Agent-Auth

    Put Limits

  • PATCH/api/admin/users/{user_id}X-Agent-Auth

    Set User Details

  • DELETE/api/admin/users/{user_id}X-Agent-Auth

    Delete User

  • PATCH/api/admin/users/{user_id}/roleX-Agent-Auth

    Set Role

  • GET/api/admin/workspaces/{workspace_id}X-Agent-Auth

    Workspace Detail

  • PATCH/api/admin/workspaces/{workspace_id}X-Agent-Auth

    Set Workspace Details

  • DELETE/api/admin/workspaces/{workspace_id}X-Agent-Auth

    Delete Workspace

  • PUT/api/admin/workspaces/{workspace_id}/addonsX-Agent-Auth

    Set Addons

  • GET/api/admin/workspaces/{workspace_id}/companyX-Agent-Auth

    Workspace Company

  • PUT/api/admin/workspaces/{workspace_id}/companyX-Agent-Auth

    Set Workspace Company

  • POST/api/admin/workspaces/{workspace_id}/impersonateX-Agent-Auth

    Impersonate

  • PATCH/api/admin/workspaces/{workspace_id}/planX-Agent-Auth

    Set Plan

  • GET/api/admin/workspaces/{workspace_id}/usersX-Agent-Auth

    Workspace Users

agents

  • POST/api/agents/loginX-Agent-Auth

    Agent Login

  • GET/api/agents/meX-Agent-Auth

    Agent Me

ai

  • POST/api/ai/assistX-Agent-Auth

    Assist

  • POST/api/ai/call-prepX-Agent-Auth

    Call Prep

  • POST/api/ai/chatX-Agent-Auth

    Assistant Chat

  • POST/api/ai/commandX-Agent-Auth

    Command

  • POST/api/ai/composeX-Agent-Auth

    Compose

  • POST/api/ai/copilotX-Agent-Auth

    Copilot Suggest

  • POST/api/ai/transcribeX-Agent-Auth

    Transcribe Audio

  • GET/api/ai/voice-contextX-Agent-Auth

    Voice Context

analytics

  • GET/api/analytics/ga/configX-Agent-Auth

    Ga Config

  • PUT/api/analytics/ga/configX-Agent-Auth

    Ga Save

  • POST/api/analytics/ga/oauth/exchangeX-Agent-Auth

    Ga Oauth Exchange

  • GET/api/analytics/ga/oauth/urlX-Agent-Auth

    Ga Oauth Url

  • GET/api/analytics/ga/propertiesX-Agent-Auth

    Ga Properties

  • PUT/api/analytics/ga/propertyX-Agent-Auth

    Ga Set Property

  • GET/api/analytics/ga/reportX-Agent-Auth

    Ga Report

  • GET/api/analytics/overviewX-Agent-Auth

    Overview

  • GET/api/analytics/trafficX-Agent-Auth

    Traffic

appointments

  • GET/api/appointmentsX-Agent-Auth

    List Agenda

  • POST/api/appointmentsX-Agent-Auth

    Create

  • PATCH/api/appointments/{appointment_id}X-Agent-Auth

    Update

  • DELETE/api/appointments/{appointment_id}X-Agent-Auth

    Cancel

  • GET/api/appointments/{appointment_id}.icsX-Agent-Auth

    Download

  • POST/api/appointments/blocksX-Agent-Auth

    Create Block

  • DELETE/api/appointments/blocks/{block_id}X-Agent-Auth

    Delete Block

  • POST/api/appointments/inviteX-Agent-Auth

    Invite

  • GET/api/appointments/invite/prefillX-Agent-Auth

    Invite Prefill

assistant

  • GET/api/assistant/channelsX-Agent-Auth

    Get Channel Overrides

  • PUT/api/assistant/channelsX-Agent-Auth

    Put Channel Overrides

  • POST/api/assistant/channels/suggestX-Agent-Auth

    Suggest Channel Instructions

  • POST/api/assistant/learnX-Agent-Auth

    Learn From Conversations

  • GET/api/assistant/lessonX-Agent-Auth

    Last Lesson

  • POST/api/assistant/lesson/applyX-Agent-Auth

    Apply Lesson

  • GET/api/assistant/promptX-Agent-Auth

    Preview Prompt

  • GET/api/assistant/settingsX-Agent-Auth

    Get Settings

  • PUT/api/assistant/settingsX-Agent-Auth

    Put Settings

  • POST/api/assistant/simulateX-Agent-Auth

    Simulate

  • POST/api/assistant/suggestX-Agent-Auth

    Suggest Settings

  • POST/api/assistant/suggest/qualificationX-Agent-Auth

    Suggest Qualification

automations

  • GET/api/automationsX-Agent-Auth

    List Automations

  • POST/api/automationsX-Agent-Auth

    Create Automation

  • PATCH/api/automations/{automation_id}X-Agent-Auth

    Update Automation

  • DELETE/api/automations/{automation_id}X-Agent-Auth

    Delete Automation

  • POST/api/automations/{automation_id}/runX-Agent-Auth

    Run Automation

  • GET/api/automations/{automation_id}/runsX-Agent-Auth

    List Runs

billing

  • POST/api/billing/apple/notificationsX-Agent-Auth

    Store Notification

  • POST/api/billing/apple/verifyX-Agent-Auth

    Verify Purchase

  • POST/api/billing/checkoutX-Agent-Auth

    Create Checkout

  • POST/api/billing/portalX-Agent-Auth

    Customer Portal

  • GET/api/billing/statusX-Agent-Auth

    Subscription Status

  • POST/api/billing/webhookX-Agent-Auth

    Webhook

book

  • GET/api/book/public/{widget}X-Agent-Auth

    Page Data

  • POST/api/book/public/{widget}X-Agent-Auth

    Book

calendar

  • GET/api/calendar/googleX-Agent-Auth

    Status

  • DELETE/api/calendar/googleX-Agent-Auth

    Disconnect

  • GET/api/calendar/google/busyX-Agent-Auth

    Busy Blocks

  • POST/api/calendar/google/exchangeX-Agent-Auth

    Exchange

  • GET/api/calendar/google/urlX-Agent-Auth

    Consent Url

calls

  • GET/api/callsX-Agent-Auth

    List Calls

  • POST/api/calls/{room}/send/chatX-Agent-Auth

    Send To Conversation

  • POST/api/calls/{room}/send/emailX-Agent-Auth

    Send By Email

  • POST/api/calls/{room}/transcribeX-Agent-Auth

    Transcribe

  • GET/api/calls/{room}/transcriptX-Agent-Auth

    Read Transcript

community

  • GET/api/communityX-Agent-Auth

    List Posts

  • POST/api/communityX-Agent-Auth

    Create Post

  • GET/api/community/{post_id}X-Agent-Auth

    Read Post

  • DELETE/api/community/{post_id}X-Agent-Auth

    Delete Post

  • POST/api/community/{post_id}/commentsX-Agent-Auth

    Add Comment

company

  • GET/api/companyX-Agent-Auth

    Get Profile

  • PUT/api/companyX-Agent-Auth

    Put Profile

  • GET/api/company/lookupX-Agent-Auth

    Lookup

contacts

  • GET/api/contactsX-Agent-Auth

    List Contacts

  • PATCH/api/contacts/{visitor_id}X-Agent-Auth

    Update Contact

  • DELETE/api/contacts/{visitor_id}X-Agent-Auth

    Delete Contact

conversations

  • GET/api/conversationsX-Agent-Auth

    List Conversations

  • GET/api/conversations/{conversation_id}X-Agent-Auth

    Get Conversation

  • PATCH/api/conversations/{conversation_id}X-Agent-Auth

    Update Conversation

  • POST/api/conversations/{conversation_id}/assignX-Agent-Auth

    Assign Conversation

  • POST/api/conversations/{conversation_id}/closeX-Agent-Auth

    Close Conversation

  • POST/api/conversations/{conversation_id}/intakeX-Agent-Auth

    Start Intake

  • DELETE/api/conversations/{conversation_id}/intakeX-Agent-Auth

    Stop Intake

  • POST/api/conversations/{conversation_id}/matchX-Agent-Auth

    Match Specialist

  • GET/api/conversations/{conversation_id}/matchesX-Agent-Auth

    List Matches

  • DELETE/api/conversations/{conversation_id}/matches/{match_id}X-Agent-Auth

    Revoke Match

  • GET/api/conversations/{conversation_id}/messagesBearer token

    List Messages

  • POST/api/conversations/{conversation_id}/messagesBearer token

    Send Visitor Message

  • PUT/api/conversations/{conversation_id}/messages/{message_id}/reactionBearer token

    React To Message

  • POST/api/conversations/{conversation_id}/messages/{message_id}/retryBearer token

    Retry Agent Message

  • POST/api/conversations/{conversation_id}/messages/agentBearer token

    Send Agent Message

  • POST/api/conversations/{conversation_id}/messages/agent/uploadBearer token

    Upload Agent Attachment

  • POST/api/conversations/{conversation_id}/messages/forwardBearer token

    Forward Messages

  • POST/api/conversations/{conversation_id}/messages/openerBearer token

    Request Opener

  • POST/api/conversations/{conversation_id}/messages/uploadBearer token

    Upload Visitor Attachment

  • POST/api/conversations/{conversation_id}/readX-Agent-Auth

    Mark Read

  • GET/api/conversations/{conversation_id}/threadX-Agent-Auth

    List Conversation Thread

  • POST/api/conversations/{conversation_id}/ticketX-Agent-Auth

    Convert To Ticket

  • POST/api/conversations/{conversation_id}/typingX-Agent-Auth

    Set Typing

  • POST/api/conversations/{conversation_id}/unreadX-Agent-Auth

    Mark Unread

  • POST/api/conversations/{conversation_id}/visitor-ticketX-Agent-Auth

    Visitor Ticket

  • GET/api/conversations/searchX-Agent-Auth

    Search Conversations

  • GET/api/conversations/sourcesX-Agent-Auth

    List Conversation Sources

  • POST/api/conversations/transcribe-voice-notesX-Agent-Auth

    Transcribe Voice Notes

customer-context

  • GET/api/customer-context/{visitor_id}X-Agent-Auth

    Read Context

  • PUT/api/customer-context/{visitor_id}X-Agent-Auth

    Write Context

  • POST/api/customer-context/{visitor_id}/regenerateX-Agent-Auth

    Regenerate

  • GET/api/customer-context/backfillX-Agent-Auth

    Backfill Status

  • POST/api/customer-context/backfillX-Agent-Auth

    Start Backfill

demo-requests

  • POST/api/demo-requestsX-Agent-Auth

    Submit

email-templates

  • GET/api/email-templatesX-Agent-Auth

    Read Templates

  • PUT/api/email-templatesX-Agent-Auth

    Write Templates

geo

  • GET/api/geo/geocodeX-Agent-Auth

    Geocode

  • GET/api/geo/whereisX-Agent-Auth

    Whereis

health

  • GET/healthPublic

    Health

helpdesk

  • GET/api/helpdeskX-Agent-Auth

    List Connections

  • POST/api/helpdeskX-Agent-Auth

    Create Connection

  • PATCH/api/helpdesk/{connection_id}X-Agent-Auth

    Patch Connection

  • DELETE/api/helpdesk/{connection_id}X-Agent-Auth

    Delete Connection

  • POST/api/helpdesk/{connection_id}/syncX-Agent-Auth

    Sync Now

imports

  • POST/api/imports/helpdeskX-Agent-Auth

    Import Helpdesk

  • POST/api/imports/macrosX-Agent-Auth

    Add Macro

  • GET/api/imports/macrosX-Agent-Auth

    List Macros

  • POST/api/imports/watermelonX-Agent-Auth

    Import Watermelon

inboxes

  • GET/api/inboxesX-Agent-Auth

    List Inboxes

  • POST/api/inboxesX-Agent-Auth

    Create Inbox

  • DELETE/api/inboxes/{inbox_id}X-Agent-Auth

    Delete Inbox

intake

  • GET/api/intake/optionsX-Agent-Auth

    Intake Options

integrations

  • GET/api/integrations/endpointsX-Agent-Auth

    List Endpoints

  • POST/api/integrations/endpointsX-Agent-Auth

    Create Endpoint

  • PUT/api/integrations/endpoints/{endpoint_id}X-Agent-Auth

    Update Endpoint

  • DELETE/api/integrations/endpoints/{endpoint_id}X-Agent-Auth

    Delete Endpoint

  • POST/api/integrations/endpoints/{endpoint_id}/testX-Agent-Auth

    Test Endpoint

  • GET/api/integrations/kantexX-Agent-Auth

    Read Settings

  • PUT/api/integrations/kantexX-Agent-Auth

    Save Settings

  • DELETE/api/integrations/kantexX-Agent-Auth

    Disconnect

  • GET/api/integrations/kantex/conversations/{conversation_id}X-Agent-Auth

    Conversation Tickets

  • POST/api/integrations/kantex/testX-Agent-Auth

    Test Connection

  • GET/api/integrations/keysX-Agent-Auth

    List Keys

  • POST/api/integrations/keysX-Agent-Auth

    Create Key

  • DELETE/api/integrations/keys/{key_id}X-Agent-Auth

    Revoke Key

  • GET/api/integrations/overviewX-Agent-Auth

    Overview

  • GET/api/integrations/webhooksX-Agent-Auth

    List Webhooks

  • POST/api/integrations/webhooksX-Agent-Auth

    Create Webhook

  • PATCH/api/integrations/webhooks/{webhook_id}X-Agent-Auth

    Update Webhook

  • DELETE/api/integrations/webhooks/{webhook_id}X-Agent-Auth

    Delete Webhook

  • GET/api/integrations/webhooks/{webhook_id}/deliveriesX-Agent-Auth

    List Deliveries

  • POST/api/integrations/webhooks/{webhook_id}/pingX-Agent-Auth

    Ping Webhook

  • POST/api/integrations/webhooks/{webhook_id}/rotate-secretX-Agent-Auth

    Rotate Secret

  • GET/api/integrations/zzpwerkvinden/lead-intakeX-Agent-Auth

    Zzp Lead Intake

internal

  • GET/api/internal/lead-feedX-Agent-Auth

    Lead Feed

invites

  • GET/api/invitesX-Agent-Auth

    List Invites

  • POST/api/invitesX-Agent-Auth

    Create Invite

  • DELETE/api/invites/{invite_id}X-Agent-Auth

    Revoke Invite

knowledge

  • POST/api/knowledge/crawlX-Agent-Auth

    Crawl

  • GET/api/knowledge/documentX-Agent-Auth

    Read Document

  • PUT/api/knowledge/documentX-Agent-Auth

    Write Document

  • DELETE/api/knowledge/documentX-Agent-Auth

    Delete Document

  • POST/api/knowledge/document/assistX-Agent-Auth

    Assist Document

  • POST/api/knowledge/optimize-allX-Agent-Auth

    Optimize All

  • GET/api/knowledge/searchX-Agent-Auth

    Search

  • DELETE/api/knowledge/sources/{domain}X-Agent-Auth

    Delete Source

  • GET/api/knowledge/statusX-Agent-Auth

    Status

  • GET/api/knowledge/treeX-Agent-Auth

    Tree

leads

  • GET/api/leadsX-Agent-Auth

    List Leads

  • PATCH/api/leads/{lead_id}X-Agent-Auth

    Patch Lead

  • POST/api/leads/{lead_id}/enrichX-Agent-Auth

    Enrich Lead

license

  • GET/api/license/bundleX-Agent-Auth

    Download Bundle

  • GET/api/license/mineX-Agent-Auth

    My Licenses

  • POST/api/license/validateX-Agent-Auth

    Validate

mail-hosting

  • DELETE/api/mail-hosting/accounts/{account_id}X-Agent-Auth

    Remove Mailbox

  • GET/api/mail-hosting/domainsX-Agent-Auth

    List Domains

  • POST/api/mail-hosting/domainsX-Agent-Auth

    Add Domain

  • GET/api/mail-hosting/domains/{domain_id}/accountsX-Agent-Auth

    List Accounts

  • POST/api/mail-hosting/domains/{domain_id}/accountsX-Agent-Auth

    Create Mailbox

  • GET/api/mail-hosting/domains/{domain_id}/dnsX-Agent-Auth

    Domain Dns

  • GET/api/mail-hosting/statusX-Agent-Auth

    Status

mailboxes

  • GET/api/mailboxesX-Agent-Auth

    List Mailboxes

  • POST/api/mailboxesX-Agent-Auth

    Create Mailbox

  • DELETE/api/mailboxes/{mailbox_id}X-Agent-Auth

    Delete Mailbox

  • POST/api/mailboxes/{mailbox_id}/syncX-Agent-Auth

    Sync Mailbox

  • POST/api/mailboxes/oauth/{provider}/exchangeX-Agent-Auth

    Mailbox Oauth Exchange

  • GET/api/mailboxes/oauth/{provider}/urlX-Agent-Auth

    Mailbox Oauth Url

mcp

  • GET/api/mcpX-Agent-Auth

    No Stream

  • POST/api/mcpX-Agent-Auth

    Rpc

  • GET/api/mcp/skillX-Agent-Auth

    Skill

media

  • GET/api/media/{media_id}X-Agent-Auth

    Get Media

meet

  • POST/api/meetX-Agent-Auth

    Create Meeting

  • GET/api/meetX-Agent-Auth

    List Meetings

  • GET/api/meet/{code}X-Agent-Auth

    Meeting Info

  • POST/api/meet/{code}/audioX-Agent-Auth

    Upload Audio

  • GET/api/meet/{code}/detailX-Agent-Auth

    Meeting Detail

  • POST/api/meet/{code}/endX-Agent-Auth

    End Meeting

  • POST/api/meet/{code}/hostX-Agent-Auth

    Host Ticket

  • POST/api/meet/{code}/joinX-Agent-Auth

    Join Meeting

members

  • GET/api/membersX-Agent-Auth

    List Members

  • DELETE/api/members/{user_id}X-Agent-Auth

    Remove Member

notifications

  • GET/api/notificationsX-Agent-Auth

    List Notifications

  • DELETE/api/notificationsX-Agent-Auth

    Clear Notifications

  • POST/api/notifications/readX-Agent-Auth

    Read Notifications

onboarding

  • POST/api/onboarding/applyX-Agent-Auth

    Apply

  • POST/api/onboarding/autofillX-Agent-Auth

    Autofill

  • GET/api/onboarding/registryX-Agent-Auth

    Registry Hint

  • GET/api/onboarding/sectorsX-Agent-Auth

    Sectors

  • GET/api/onboarding/template/{sector}X-Agent-Auth

    Template

ops

  • GET/api/ops/slaX-Agent-Auth

    Read Sla

  • PUT/api/ops/slaX-Agent-Auth

    Save Sla

  • GET/api/ops/whatsapp-relayX-Agent-Auth

    Read Whatsapp Relay

  • PUT/api/ops/whatsapp-relayX-Agent-Auth

    Save Whatsapp Relay

  • GET/api/ops/workloadX-Agent-Auth

    Read Workload

  • PUT/api/ops/workloadX-Agent-Auth

    Save Workload

outbound

  • GET/api/outbound/{collection}X-Agent-Auth

    List Items

  • POST/api/outbound/{collection}X-Agent-Auth

    Create Item

  • GET/api/outbound/{collection}/{item_id}X-Agent-Auth

    Get Item

  • PATCH/api/outbound/{collection}/{item_id}X-Agent-Auth

    Update Item

  • DELETE/api/outbound/{collection}/{item_id}X-Agent-Auth

    Delete Item

  • POST/api/outbound/audience/email-countX-Agent-Auth

    Email Audience Count

  • POST/api/outbound/public/checklists/{checklist_id}/items/{entry_id}/completeX-Agent-Auth

    Complete Entry

  • GET/api/outbound/public/e/c/{token}X-Agent-Auth

    Mail Clicked

  • GET/api/outbound/public/e/o/{token}X-Agent-Auth

    Mail Opened

  • GET/api/outbound/public/e/u/{token}X-Agent-Auth

    Unsubscribe Form

  • POST/api/outbound/public/e/u/{token}X-Agent-Auth

    Unsubscribe

  • POST/api/outbound/public/eventsX-Agent-Auth

    Event

  • POST/api/outbound/public/feedX-Agent-Auth

    Feed

  • POST/api/outbound/public/surveys/{survey_id}/responsesX-Agent-Auth

    Answer Survey

  • GET/api/outbound/surveys/{item_id}/resultsX-Agent-Auth

    Survey Results

persona

  • GET/api/personaX-Agent-Auth

    Read Persona

  • PATCH/api/personaX-Agent-Auth

    Patch Profile

  • POST/api/persona/correctionsX-Agent-Auth

    Add Correction

  • GET/api/persona/correctionsX-Agent-Auth

    List Corrections

  • GET/api/persona/examplesX-Agent-Auth

    Examples

  • POST/api/persona/importX-Agent-Auth

    Import History

  • POST/api/persona/import-archiveX-Agent-Auth

    Import Archive

  • GET/api/persona/import-statusX-Agent-Auth

    Import Status

  • POST/api/persona/learn-from-historyX-Agent-Auth

    Learn From History

  • POST/api/persona/scoreX-Agent-Auth

    Score

plan

  • GET/api/planX-Agent-Auth

    Read Plan

  • PUT/api/plan/brandingX-Agent-Auth

    Update Branding

  • GET/api/plan/branding/by-hostX-Agent-Auth

    Branding By Host

  • GET/api/plan/branding/domain-checkX-Agent-Auth

    Domain Check

  • GET/api/plan/catalogueX-Agent-Auth

    Catalogue

  • GET/api/plan/usageX-Agent-Auth

    Read Usage

plugins

  • POST/api/plugins/wordpress/claimX-Agent-Auth

    Claim

  • POST/api/plugins/wordpress/connect-codeX-Agent-Auth

    Connect Code

  • POST/api/plugins/wordpress/exchangeX-Agent-Auth

    Exchange

  • POST/api/plugins/wordpress/handoffX-Agent-Auth

    Handoff

  • POST/api/plugins/wordpress/site-keyX-Agent-Auth

    Site Key

  • GET/api/plugins/wordpress/summaryX-Agent-Auth

    Summary

presence

  • GET/api/presence/availabilityX-Agent-Auth

    Availability

  • POST/api/presence/heartbeatX-Agent-Auth

    Heartbeat

  • GET/api/presence/meX-Agent-Auth

    My Workspace Presence

privacy

  • GET/api/privacy/auditX-Agent-Auth

    Get Audit

  • POST/api/privacy/contacts/{visitor_id}/anonymizeX-Agent-Auth

    Anonymize Contact

  • POST/api/privacy/contacts/{visitor_id}/eraseX-Agent-Auth

    Erase Contact

  • GET/api/privacy/contacts/{visitor_id}/exportX-Agent-Auth

    Export Contact

  • POST/api/privacy/conversations/eraseX-Agent-Auth

    Erase Conversations

  • GET/api/privacy/exportX-Agent-Auth

    Export Workspace

  • GET/api/privacy/settingsX-Agent-Auth

    Get Settings

  • PUT/api/privacy/settingsX-Agent-Auth

    Put Settings

  • POST/api/privacy/workspace/deletionX-Agent-Auth

    Schedule Deletion

  • DELETE/api/privacy/workspace/deletionX-Agent-Auth

    Cancel Deletion

private-ai

  • GET/api/private-ai/connectionsX-Agent-Auth

    List Connections

  • POST/api/private-ai/connections/{label}/loginX-Agent-Auth

    Login

  • POST/api/private-ai/connections/{label}/logoutX-Agent-Auth

    Logout

  • POST/api/private-ai/connections/{label}/testX-Agent-Auth

    Test Connection

  • POST/api/private-ai/profilesX-Agent-Auth

    Add Profile

  • GET/api/private-ai/testsX-Agent-Auth

    Recent Tests

provider

  • GET/api/providerX-Agent-Auth

    Read Provider

  • PUT/api/providerX-Agent-Auth

    Write Provider

  • POST/api/provider/testX-Agent-Auth

    Test Provider

push

  • POST/api/push/devicesX-Agent-Auth

    Register Device

  • POST/api/push/devices/unregisterX-Agent-Auth

    Unregister Device

  • POST/api/push/testX-Agent-Auth

    Send Test

push-reply

  • POST/api/push-reply/bixX-Agent-Auth

    Bix

  • POST/api/push-reply/readX-Agent-Auth

    Read

  • POST/api/push-reply/replyX-Agent-Auth

    Reply

reports

  • GET/api/reportsX-Agent-Auth

    Report

reseller

  • POST/api/reseller/clientsX-Agent-Auth

    Create Client

  • GET/api/reseller/clients/{client_id}X-Agent-Auth

    Client Detail

  • PATCH/api/reseller/clients/{client_id}/planX-Agent-Auth

    Set Client Plan

  • POST/api/reseller/clients/{client_id}/usersX-Agent-Auth

    Add Client User

  • GET/api/reseller/overviewX-Agent-Auth

    Overview

rtc

  • POST/api/rtc/roomsPublic

    Create Room

  • POST/api/rtc/rooms/{room_id}/signalPublic

    Post Signal

  • GET/api/rtc/rooms/{room_id}/signalPublic

    Get Signals

seats

  • GET/api/seatsX-Agent-Auth

    Seat Overview

sessions

  • POST/api/sessionsBearer token

    Create Session

  • GET/api/sessions/{conversation_id}Bearer token

    Get Session

  • POST/api/sessions/{conversation_id}/endBearer token

    End Session

  • POST/api/sessions/{conversation_id}/handoverBearer token

    Request Handover

  • POST/api/sessions/{conversation_id}/shop-eventBearer token

    Shop Event

  • PATCH/api/sessions/{conversation_id}/visitorBearer token

    Update Visitor

  • GET/api/sessions/suggestionsBearer token

    Suggestions

share

  • GET/api/share/{token}X-Agent-Auth

    Read Share

  • GET/api/share/{token}/media/{media_id}X-Agent-Auth

    Read Share Media

shop

  • GET/api/shop/categoriesX-Agent-Auth

    Categories

  • DELETE/api/shop/connectX-Agent-Auth

    Disconnect

  • GET/api/shop/conversionX-Agent-Auth

    Conversion

  • PUT/api/shop/settingsX-Agent-Auth

    Settings

  • POST/api/shop/shopify/connectX-Agent-Auth

    Connect Shopify

  • GET/api/shop/statusX-Agent-Auth

    Status

  • PUT/api/shop/stores/{store_id}X-Agent-Auth

    Rename Store

  • DELETE/api/shop/stores/{store_id}X-Agent-Auth

    Remove Store

  • POST/api/shop/syncX-Agent-Auth

    Sync

  • GET/api/shop/webhook-infoX-Agent-Auth

    Webhook Info

  • POST/api/shop/webhook/shopify/{workspace_id}X-Agent-Auth

    Shopify Webhook

  • POST/api/shop/webhook/woocommerce/{workspace_id}X-Agent-Auth

    Webhook

  • POST/api/shop/woocommerce/authorizeX-Agent-Auth

    Authorize

  • POST/api/shop/woocommerce/connectX-Agent-Auth

    Connect

  • POST/api/shop/woocommerce/wc-auth/callbackX-Agent-Auth

    Wc Auth Callback

sso

  • POST/api/sso/callbackX-Agent-Auth

    Callback

  • GET/api/sso/configX-Agent-Auth

    Read Config

  • PUT/api/sso/configX-Agent-Auth

    Save Config

  • POST/api/sso/exchangeX-Agent-Auth

    Exchange

  • POST/api/sso/startX-Agent-Auth

    Start

telegram

  • POST/api/telegram/connectX-Agent-Auth

    Connect

  • DELETE/api/telegram/connectX-Agent-Auth

    Disconnect

  • GET/api/telegram/statusX-Agent-Auth

    Status

  • POST/api/telegram/webhook/{secret}X-Agent-Auth

    Webhook

tickets

  • GET/api/ticketsX-Agent-Auth

    List Tickets

  • POST/api/ticketsX-Agent-Auth

    Create Ticket

  • GET/api/tickets/{ticket_id}X-Agent-Auth

    Get Ticket

  • PATCH/api/tickets/{ticket_id}X-Agent-Auth

    Update Ticket

  • DELETE/api/tickets/{ticket_id}X-Agent-Auth

    Delete Ticket

  • POST/api/tickets/{ticket_id}/cancelX-Agent-Auth

    Cancel Ticket

  • GET/api/tickets/{ticket_id}/commentsX-Agent-Auth

    List Comments

  • POST/api/tickets/{ticket_id}/commentsX-Agent-Auth

    Add Comment

  • POST/api/tickets/{ticket_id}/expediteX-Agent-Auth

    Expedite Ticket

track

  • POST/api/trackX-Agent-Auth

    Track

translate

  • POST/api/translateX-Agent-Auth

    Translate

trial

  • GET/api/trial/admin/pendingX-Agent-Auth

    Pending

  • POST/api/trial/admin/workspaces/{workspace_id}/activateX-Agent-Auth

    Activate

  • POST/api/trial/admin/workspaces/{workspace_id}/overrideX-Agent-Auth

    Override

  • GET/api/trial/agreementX-Agent-Auth

    Get Agreement

  • GET/api/trial/agreement/{signature_id}/pdfX-Agent-Auth

    Agreement Pdf

  • POST/api/trial/agreement/signX-Agent-Auth

    Sign Agreement

  • GET/api/trial/agreementsX-Agent-Auth

    List Agreements

  • POST/api/trial/invoice-requestX-Agent-Auth

    Invoice Request

  • GET/api/trial/statusX-Agent-Auth

    Get Status

v1

  • GET/api/v1/contactsX-Agent-Auth

    List contacts

  • GET/api/v1/conversationsX-Agent-Auth

    List conversations

  • GET/api/v1/conversations/{conversation_id}X-Agent-Auth

    Get one conversation

  • POST/api/v1/conversations/{conversation_id}/assignX-Agent-Auth

    Assign a conversation to a team member

  • GET/api/v1/conversations/{conversation_id}/messagesBearer token

    List messages of a conversation

  • POST/api/v1/conversations/{conversation_id}/messagesBearer token

    Send a message to the contact

  • POST/api/v1/conversations/{conversation_id}/notesX-Agent-Auth

    Add an internal note to a conversation

  • POST/api/v1/conversations/{conversation_id}/pauseX-Agent-Auth

    Pause the AI assistant (BIX) on a conversation

  • POST/api/v1/conversations/{conversation_id}/resumeX-Agent-Auth

    Resume the AI assistant (BIX) on a conversation

  • GET/api/v1/endpointsX-Agent-Auth

    List AI endpoints

  • POST/api/v1/endpoints/{slug}X-Agent-Auth

    Run an AI endpoint on posted input

  • GET/api/v1/endpoints/{slug}X-Agent-Auth

    Run an AI endpoint

  • GET/api/v1/meX-Agent-Auth

    Identify the API key

  • GET/api/v1/membersX-Agent-Auth

    List workspace members

  • POST/api/v1/whatsapp/intakesX-Agent-Auth

    Start a WhatsApp conversation with an AI intake

voice

  • POST/api/voice/brainX-Agent-Auth

    Voice Brain Reply

  • GET/api/voice/callsX-Agent-Auth

    List Calls

  • POST/api/voice/callsX-Agent-Auth

    Create Call

  • DELETE/api/voice/calls/{call_id}X-Agent-Auth

    End Call

  • GET/api/voice/configX-Agent-Auth

    Voice Config

  • GET/api/voice/limitsX-Agent-Auth

    Read Limits

  • PUT/api/voice/limitsX-Agent-Auth

    Write Limits

  • POST/api/voice/tokenX-Agent-Auth

    Browser Token

  • POST/api/voice/web-callX-Agent-Auth

    Start Web Call

webpush

  • GET/api/webpush/audienceX-Agent-Auth

    Audience

  • POST/api/webpush/broadcastX-Agent-Auth

    Broadcast

  • GET/api/webpush/keyX-Agent-Auth

    Public Key

  • POST/api/webpush/subscribeX-Agent-Auth

    Subscribe

  • POST/api/webpush/testX-Agent-Auth

    Send Test

  • POST/api/webpush/unsubscribeX-Agent-Auth

    Unsubscribe

whatsapp

  • GET/api/whatsapp/connectionX-Agent-Auth

    Get Connection

  • DELETE/api/whatsapp/connectionX-Agent-Auth

    Disconnect

  • POST/api/whatsapp/connection/connectX-Agent-Auth

    Connect

  • POST/api/whatsapp/connection/import-groupsX-Agent-Auth

    Import Groups

  • POST/api/whatsapp/controlX-Agent-Auth

    Control

  • POST/api/whatsapp/deletedX-Agent-Auth

    Deleted

  • POST/api/whatsapp/evo/{instance}X-Agent-Auth

    Evo Webhook

  • POST/api/whatsapp/inboundX-Agent-Auth

    Inbound

  • POST/api/whatsapp/media-upgradeX-Agent-Auth

    Media Upgrade

  • POST/api/whatsapp/messages/{message_id}/refetch-mediaBearer token

    Refetch Media

  • POST/api/whatsapp/ownX-Agent-Auth

    Own Message

  • GET/api/whatsapp/qrX-Agent-Auth

    Whatsapp Qr

  • POST/api/whatsapp/readX-Agent-Auth

    Device Read

  • POST/api/whatsapp/repairX-Agent-Auth

    Whatsapp Repair

  • GET/api/whatsapp/statusX-Agent-Auth

    Whatsapp Status

widget

  • POST/api/widget/assetsX-Agent-Auth

    Upload Asset

  • GET/api/widget/assets/{name}X-Agent-Auth

    Serve Asset

  • POST/api/widget/fields/suggestX-Agent-Auth

    Suggest Fields

  • GET/api/widget/settingsPublic

    Get Settings

  • PUT/api/widget/settingsPublic

    Put Settings

  • GET/api/widget/widgetsX-Agent-Auth

    List Widgets

  • POST/api/widget/widgetsX-Agent-Auth

    Create Widget

  • PATCH/api/widget/widgets/{widget_id}X-Agent-Auth

    Rename Widget

  • DELETE/api/widget/widgets/{widget_id}X-Agent-Auth

    Delete Widget

ws

  • POST/api/ws/ticketX-Agent-Auth

    Ws Ticket