Agent

Datastore

Flux CRM

Artifacts

VoltAPI

Integrations

Widgets

Developers API

Others

Terms & Privacy

support@chatvolt.ai

Chatvolt AI - Connect custom data to large language models

Sign In

Home

Chat

Allows an agent to send a message to a conversation, identified by ID, phone, or email.

Send Message by Channel

Custom ID associated with the chunk (if any).

ID of the datasource to which the chunk belongs.

Name of the datasource to which the chunk belongs.

Similarity score of the chunk with the query.

URL or identifier of the original source of the chunk.

bearerAuth

Allows an agent to send a message to any conversation, following the rules of its parameters.

Introduction

Revolutionize Customer Interaction with Advanced Artificial Intelligence

Platform

Extend Chatvolt capabilities with internal JavaScript functions running in a secure sandbox.

Custom ChatGPT AI Chatbot trained on your data

Get started

Quick start

Datastore tool

HTTP Tool (API)

Request human tool

Mark as resolved tool

Delayed responses tool

Follow up messages tool

Human handoff

Fine tuning

Conversation file upload

Answer sources

Message suggestions

Optimize ai answers

Rate limit

Debug

Prompt variables

Whitelist

ElevenLabs audios

Transcriptions with groq

A guide to configuring and using webhooks with ChatVolt Agents to fetch external data and send real-time notifications.

Agent Webhooks

Conversation Variables

Raw mode

Flux CRM Integration

Learn how to use the Dispatch feature to send automated campaigns to your contacts.

Dispatch

High-level overview of the Zapper integration for sending messages.

Zapper HUB Integration

Make your data ready for large language models

A comprehensive guide to the step configuration options in Flux CRM, including how to create and configure steps.

Step Configuration

Whatsapp

Telegram

Instagram

Twilio

Make

Google drive

Mercadolivre

Slack

Youtube

Zapper HUB

This demonstes how to authenticate a request to the chatvolt API.

Authentication

Understand the hierarchy of Categories, Subcategories, and Media.

How to organize Artifacts

User Permissions

Bubble

Standard

Reference

This endpoint processes a query (Ask something) through the specified agent.

Agent Query

Get Agent

Create a new agent with the provided settings.

Create Agent

Partially updates an existing agent based on the ID. Allows updating one or more fields of a specific agent. Only the fields provided in the request body will be updated.

Update Agent

Permanently deletes a specific agent by its ID. Permanently removes an agent and its associated data (including service providers and permissions).

Delete Agent

This endpoint allows controlling the webhook status for different service providers associated with an agent.
For the `instagram` type, enabling/disabling the webhook also controls the `answerDms` and `answerComments` settings

Enable/Disable Agent Integration

Get Tools

Create Tool

Update Tool

Delete Tool

Obtain the whitelist entries (WhatsApp numbers) for the specified agent.


Get Whitelist Numbers

Add Number to Whitelist

Update the WhatsApp number in the agent's whitelist by replacing the old number with a new one.


Update Number in Whitelist

Remove a WhatsApp number from the agent's whitelist.


 Delete Number from Whitelist

Get All Blacklist Entries

Add to Agent Blacklist

Get Agent Blacklist by Agent ID

Deletes a specific blacklist entry using its unique ID from the query.

Delete Agent Blacklist Entry

Retrieves the last 'N' messages from a conversation, along with some conversation metadata.

Get Messages

Get one Message

Allows searching for conversations by agent ID, creation date (greater than or equal to), and status.

List Conversations by Date

Get Conversation By Id

Permanently deletes a conversation and all associated data, including messages and uploaded files from storage.

Delete Conversation

Enable/Disable AI for Conversation

Associates a user with a specific conversation. If the conversation is already assigned to another user, the request will fail with a 409 Conflict, unless the 'force' parameter is set to true.

Assign to User

Set Priority

Update Status

This endpoint is useful for registering events or messages from external triggers within the context of a specific conversation, without the message being effectively sent to the final participant.

Register Message in Context

Get All Custom Variables

Get One Custom Variable

Creates a new conversation variable if the combination of `conversationId` and `varName` does not exist, or updates the `varValue` if it already exists.

Create/Update Custom Variable

Delete Custom Variable

Get Notes

Create Note

Update Note

Delete Note

Returns a timeline of assignee periods (who was assigned/unassigned, dates, actor, and source) as well as legacy participants if no history exists yet.

Get Assignment History

Retrieves a list of contacts with filtering and pagination.

List Contacts

Creates a new contact, or updates an existing one if an ID is provided in the body.

Create or Update Contact

Returns all custom variables stored for a contact.

The `id` parameter is flexible — it can be a **contact ID** or a **conversation ID**
(the first participant contact will be resolved automatically). If omitted or unresolvable,
the executor falls back to the `conversationid` request header injected by the AI HTTP-tool
runner.


Get Contact Variables

Creates a new variable for a contact, or updates its value if the key already exists (upsert).

The operation is **atomic** — uses a PostgreSQL JSONB merge so concurrent writes to different
keys never overwrite each other.

The `id` field is optional when the request is made by the AI via HTTP tools and the
`conversationid` header is present.


Create or Update a Contact Variable

Updates an existing contact variable. Functionally identical to `POST` (atomic upsert),
provided as a separate verb for semantic clarity when the intent is to update.


Update a Contact Variable

Removes a specific variable key from a contact, or all variables if `key` is omitted.

- **With `key`**: atomically removes that key and its `_sources` entry. Returns `404` if the key does not exist.
- **Without `key`**: deletes the entire `contact_variables` record for the contact.


Delete a Contact Variable

Dispatches

Retrieves a list of dispatches with filtering and pagination.

List Dispatches

Creates a new dispatch, or updates an existing one if an ID is provided in the body.

Create or Update Dispatch

Delete Scheduled Dispatch

Populates the dispatch queue for a given dispatch, taking into account inclusion and exclusion lists.

Populate Dispatch Queue

Search for artifacts with advanced filters.
**Logic Notes:**
- If `ids` is provided, `q` is ignored.
- `categoryIds` searches recursively (includes children categories).
- Arrays (`ids`, `categoryIds`, `mediaTypes`) accept comma-separated strings.


Search Artifacts

List all artifacts for the organization with basic filtering.

List Artifacts

Create Artifact

Get Artifact

Update Artifact

Delete/Toggle Artifact

Bulk Delete Artifacts

Retrieves a paginated list of all datastores belonging to the organization.

List Datastores

Query Datastore

Get Datastore

Creates a new datastore with the provided configurations.

Create Datastore

Partially updates an existing datastore based on its ID.

Update Datastore

Permanently deletes a specific datastore by its ID.

Delete Datastore

Retrieves a paginated list of all datasources belonging to a specific datastore.

List Datasources

Retrieves a specific data source by its ID.

Get Datasource

Create Datasource

Deletes a specific data source by its ID.

Delete Datasource

This endpoint allows sending a text message and/or attachments to a destination WhatsApp number, using a configured Z-API instance.
The message is also registered in the conversation associated with the agent and contact.

Send WhatsApp Message

This endpoint allows sending a text message and/or attachments to a destination number, using a configured Zapper instance.
The message is also registered in the conversation associated with the agent and contact.

Send a message through the Zapper integration

Send a pre-approved WhatsApp template message with optional dynamic variables to a contact

WhatsApp Template Message

Fetches all message templates from the associated WhatsApp Business Account (WABA).

List Meta Templates

Creates a new message template in the associated WhatsApp Business Account (WABA).

Create Meta Template

Tracks a conversion event in the Meta Conversions API (CAPI) for Click-to-WhatsApp (CTWA) ads.

This endpoint triggers conversion events (e.g., LeadSubmitted, Purchase, Contact) attributed to Meta WhatsApp campaigns.
Pass `conversationId` either as a query parameter or in the JSON request body. Alternatively, lookup can be performed via `phoneNumber`, `contactId`, or `ctwa_clid`.
When parameters (`eventName`, `value`, `currency`, `ctwa_clid`, `datasetId`, `accessToken`) are omitted, they are automatically resolved from the conversation's variables, metadata, stored CTWA click attribution records (checked against the 7-day Meta Ads window), or channel credentials.

Conversion Tracking (Meta CAPI)

Sends a message with up to 3 reply buttons. Supported on WhatsApp, Z-API, and ZapperAPI.

Send Buttons

Sends a message with a list of options (menu). Supported on WhatsApp, Z-API, and ZapperAPI.

Send List

Sends a message with a URL button. Supported on WhatsApp and Z-API.

Send CTA

Sends a specific location on a map. Supported on WhatsApp, Z-API, and ZapperAPI.

Send Location

Sends a message asking the user to share their current location. Supported on WhatsApp only.

Location Request

Sends one or more contact cards. Supported on WhatsApp, Z-API, and ZapperAPI.

Chatvolt API

Endpoints

Send Message by Channel

Authorizations

Path Parameters

Body

Response