Custom¶

Quick Start¶

Get your agent up and running in three steps.

Step 1 — Create an Agent in Cavuer¶

An agent is an AI profile that manages your channels. You can connect multiple channels to a single agent.

1. Sign up at console.cavuer.com

2. On the main page, click "Create Agent", enter a name and select a language model

   

3. After creating the agent, open its settings and add an instruction — rules for how the agent should interact with customers

You are a polite support assistant for "MyCompany".
Always address the customer by name.
Only answer questions related to our services.
If you don't know the answer — suggest contacting a live operator.

Step 2 — Connect the Custom Channel¶

1. On the main page, click "Add Channel" next to your agent and select Custom

   

2. After creating the channel, copy the Channel Identifier — you will need it to send API requests

Step 3 — Enable the Channel and Start¶

1. Go to the channel settings
2. Toggle the switch in the "Status" section

3. Click "Save"

   

Done! The Custom channel is created and active. You can now send messages via the API — the agent will process them automatically.

API Documentation¶

Authentication¶

Add the following key to the Headers of each request:

x-cavuer-api-key: <your API key>

You can create an API key in your dashboard under Profile. Learn how to create an API key.

Sending Messages¶

Send a POST request to:

https://api.cavuer.com/custom/{{uniqueIdentifier}}/send

The {{uniqueIdentifier}} parameter is your Custom channel identifier, copied in Step 2.

Request Parameters¶

Request Example¶

{
    "chatId": "unique-chat-123",
    "content": {
        "text": "Hello! This is a message from the AI agent."
    },
    "chatType": "user",
    "chatName": "Support Chat"
}

{
    "chatId": "group-789",
    "content": {
        "text": "Please review this document",
        "url": "https://example.com/file.pdf",
        "fileName": "instruction.pdf"
    },
    "chatType": "group",
    "participantId": "user-456"
}

Response Codes¶

Advanced Setup¶

Agent Settings in Cavuer Dashboard¶

Configure the agent's behavior at console.cavuer.com:

Full parameter reference: Agent and Channel Setup

Knowledge Base Setup¶

The Knowledge Base is the agent's source of information. There are two ways to populate it:

1. Uploading individual articles. Go to the Knowledge Base section → click "Upload Data" → on the "File" or "Text" tab, enter a title and add the content (.pdf, .docx, .txt files or plain text).

2. Creating collections. Click "Collections" → "Add Collection" and choose a source type: Website, Yandex Wiki, or Confluence. Cavuer will automatically crawl and index the pages.

Then, in the agent settings under Knowledge Base, click "Link Data", select the required articles or collections, and save your changes. For more details, see Knowledge Base.