CYBIX Developers
Back to cybix.app

API reference

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

accounts

  • POST/api/accounts/deletePublic

    Delete Account

  • 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

  • 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

  • POST/api/accounts/registerPublic

    Register

  • GET/api/accounts/workspacePublic

    Read Workspace

  • PATCH/api/accounts/workspacePublic

    Rename Workspace

admin

  • 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/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

  • 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/copilotX-Agent-Auth

    Copilot Suggest

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

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/suggestX-Agent-Auth

    Suggest Settings

billing

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

    Create Checkout

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

    Customer Portal

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

    Webhook

calls

  • 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

connectors

  • GET/api/connectorsX-Agent-Auth

    List Connectors

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

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

    Assign Conversation

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

    Close Conversation

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

    List Messages

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

    Send Visitor Message

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

    Send Agent Message

  • 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}/visitor-ticketX-Agent-Auth

    Visitor Ticket

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

    Search Conversations

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

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

license

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

    Download Bundle

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

    My Licenses

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

    Validate

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

members

  • GET/api/membersX-Agent-Auth

    List Members

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

    Set Member Role

oauth

  • POST/api/oauth/apikeyX-Agent-Auth

    Connect With Api Key

  • POST/api/oauth/authorizeX-Agent-Auth

    Issue Code

  • GET/api/oauth/connectionsX-Agent-Auth

    List Connections

  • DELETE/api/oauth/connections/{integration}X-Agent-Auth

    Disconnect

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

    Exchange Code

ops

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

    Read Sla

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

    Save Sla

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

    Read Workload

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

    Save Workload

plan

  • GET/api/planX-Agent-Auth

    Read Plan

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

    Update Branding

presence

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

    Availability

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

    Heartbeat

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

    My Workspace Presence

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

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

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

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

    Update Visitor

  • GET/api/sessions/suggestionsBearer token

    Suggestions

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

teams

  • GET/api/teamsX-Agent-Auth

    List Teams

  • POST/api/teamsX-Agent-Auth

    Create Team

  • DELETE/api/teams/{team_id}X-Agent-Auth

    Delete Team

  • POST/api/teams/{team_id}/membersX-Agent-Auth

    Add Member

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

    Remove Member

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

voice

  • 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

  • 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

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

    Control

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

    Inbound

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

    Whatsapp Qr

  • 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

  • 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