Query Parameters

Response

Agent

Datastore

Flux CRM

Integrations

Widgets

Developers API

Others

Terms & Privacy

support@chatvolt.ai

Chatvolt AI - Connect custom data to large language models

Sign In

Home

Chat

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

List Meta Templates

bearerAuth

List Meta templates

Introduction

Revolutionize Customer Interaction with Advanced Artificial Intelligence

Platform

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 Api 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

Make

Google drive

Zapper Api

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

Authentication

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 (identified by email) with a specific conversation. If the conversation is already assigned to another user, the assignment is updated.

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

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

Send Message by Channel

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

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

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

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

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

Create Meta Template

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.

Send Contact

Retrieves a list of products from Mercado Livre, with optional fuzzy search filtering.

Get Mercado Livre Products

Retrieves a list of CRM conversation logs, with optional filtering and pagination.

List CRM Conversation Logs

Retrieves a specific CRM conversation log by its unique identifier.

Get CRM Conversation Log by ID

Updates the status of a specific CRM conversation log. NOTE: Currently, PUT and PATCH are functionally identical as only 'status' is updatable. Consider expanding 'UpdateCrmConversationLogPayload' for PATCH if more fields become updatable.


Update CRM Conversation Log

Partially updates the status of a specific CRM conversation log. NOTE: Currently, PUT and PATCH are functionally identical as only 'status' is updatable. Consider expanding 'UpdateCrmConversationLogPayload' for PATCH if more fields become updatable.


Partially Update CRM Conversation Log

Deletes a specific CRM conversation log by its unique identifier.

Delete CRM Conversation Log

Retrieves a list of CRM scenarios, optionally filtered by agentId.

List CRM Scenarios

Create CRM Scenario

Updates an existing CRM scenario. The scenario ID must be provided in the request body. NOTE: This deviates from standard RESTful conventions where the ID is typically a path parameter.


Update CRM Scenario

Deletes an existing CRM scenario. The scenario ID must be provided in the request body. NOTE: This deviates from standard RESTful conventions where the ID is typically a path parameter.


Delete CRM Scenario

Retrieves a list of conversations associated with a specific CRM scenario.
Can also be used to get conversation counts by using the `isCount` parameter.


List Scenario Conversations

Removes an existing conversation from a specific CRM scenario.

Remove Conversation from CRM Scenario

Retrieves a list of CRM steps for a given scenario, optionally filtered by agentId.

List CRM Steps

Creates a new CRM step within a scenario.

Create CRM Step

Updates an existing CRM step. The step ID must be provided in the request body, along with at least one other field to update. NOTE: This deviates from standard RESTful conventions where the ID is typically a path parameter.


Update CRM Step

Deletes an existing CRM step. The step ID must be provided in the request body. NOTE: This deviates from standard RESTful conventions where the ID is typically a path parameter.


Delete CRM Step

Adds an existing conversation to a specific CRM step within a scenario.
The step can be identified by `stepId`, or by `scenarioId` and `stepIndex`.
If only `scenarioId` is provided, the conversation is added to the first step of that scenario.
This action also creates an initial `CrmConversationLog` with 'active' status.
If the conversation is already part of other scenarios, those associations will be marked as unavailable.


Add Conversation to CRM Step

Moves a conversation to a specified destination step within a CRM scenario.
The destination step can be identified by `destStepId` or by `scenarioId` and `destStepIndex`.
Optionally, an initial message for the destination step can be sent.


Chatvolt API

Endpoints

List Meta Templates

Query Parameters

Response

Authorizations

Query Parameters

Response

Chatvolt API

Endpoints

​Query Parameters

​Response

Authorizations

Query Parameters

Response

Query Parameters

Response