CYBIX DevelopersBack to cybix.app

REST · JSON · no SDK required

Build on CYBIX

One API behind the messenger, the inbox and BIX. Everything the dashboard does, you can do over HTTP with the same endpoints.

API referenceInstall the messenger

Quickstart

Step 1

Create a workspace

Register an account. The response carries a token scoped to that workspace — every other call needs it.

curl -X POST https://cybix.app/api/accounts/register \
  -H "Content-Type: application/json" \
  -d '{"email":"you@acme.com","password":"<your-password>","workspace_name":"Acme"}'

Step 2

Authenticate

Send the token as X-Agent-Auth on agent endpoints. Visitor endpoints use a Bearer token instead — the two are not interchangeable.

curl https://cybix.app/api/conversations \
  -H "X-Agent-Auth: <token>"

Step 3

Teach BIX your content

Point the crawler at your site. Pages are stored per workspace and searched on every question.

curl -X POST https://cybix.app/api/knowledge/crawl \
  -H "X-Agent-Auth: <token>" -H "Content-Type: application/json" \
  -d '{"url":"https://acme.com","max_pages":50}'

What you should know first

  • Workspaces

    Every account owns a workspace. Knowledge, settings and conversations are scoped to it, so one client's content is never searched for another.

  • Two kinds of token

    Agent tokens (X-Agent-Auth) act for your team. Visitor tokens (Authorization: Bearer) act for one end customer in one conversation, and can read nothing else.

  • Outcomes, not deflections

    BIX answers only from your knowledge base. When nothing matches it says so and hands to a person rather than guessing.