Core concepts

The eight nouns that everything else in OyeChats is built from. Worth five minutes before you configure anything.

On this page

Vocabulary
A note on naming
How the objects relate

Vocabulary

Workspace (account): Your organisation on OyeChats. It owns the subscription, the credit balance, the chatbots, the team, and every conversation. One login can belong to more than one workspace.
Chatbot: One configured assistant: its own knowledge base, personality, appearance, live-chat settings and analytics. Most customers run one chatbot per website.
Bot key: The public identifier for a chatbot, shaped like bot-6a427d4529b9. It goes in the embed snippet and is visible to anyone who views your page source. That is by design. It can only start conversations, never read your account. Protect your site with the domain allowlist, not by hiding the key.
API key: The private credential for your workspace, sent as the X-API-Key header. It can read and change everything in the workspace. Never put it in front-end code. See API authentication.
Knowledge base: Everything a chatbot has been trained on. Crawled pages and uploaded files. After extraction and indexing. See Training your chatbot.
Conversation: One visitor's chat session, from the first message to the moment it closes. A conversation can move between AI mode, waiting for an operator, and live with an operator.
Lead: A conversation with contact details attached. Leads carry a qualification score and tier. See Lead capture.
Operator: A human teammate who can take over live chats. Operators have their own login and occupy a seat on your plan. See Operators and seats.
Credits: The single unit that meters usage. One per AI reply, five per crawled page, and so on. Your plan grants a monthly allowance. See Credits.

A note on naming

The product calls the AI an AI Chatbot and a human teammate an Operator. Older material and some API field names still use "agent" for both, which is why you will occasionally see agent in a URL or a legacy header. They mean the same objects described above.

How the objects relate

Object hierarchy

Workspace
├── Subscription ── Credit balance ── Invoices
├── Team
│   ├── Members (dashboard access)
│   └── Operators (live chat seats) ── Departments
└── Chatbot
    ├── Knowledge base (crawled pages + uploaded files)
    ├── Conversations
    │   ├── Messages
    │   └── Lead  ── Qualification score & tier
    ├── Widget configuration (appearance, copy, behaviour)
    └── Webhook endpoints

Something here wrong or missing? Tell us and name this page. We will fix it.