# Botsify

- [Botsify: AI Chatbot & Multi-Channel Agent Platform](https://botsify.mintlify.app/introduction.md): Botsify lets you build and deploy AI chatbots and agents on web, Messenger, and WhatsApp. Learn what's possible and how the platform is organized.
- [Botsify Quickstart: Build and Send Your First Bot Message](https://botsify.mintlify.app/quickstart.md): Follow this step-by-step guide to sign up, authenticate, create a bot, and send your first conversation message with the Botsify API.
- [Botsify API Authentication: Bearer Token, OAuth2, API Key](https://botsify.mintlify.app/authentication.md): Learn how to authenticate Botsify API requests using a Bearer token from the login endpoint, the OAuth2 password grant, or a bot-scoped API key.
- [Botsify Bots and Agents: Types, Keys, and Lifecycle](https://botsify.mintlify.app/concepts/bots-and-agents.md): Understand the difference between chatbots, AI agents, and voice bots, and learn how bot_id, bot_key, and apikey work in your Botsify workspace.
- [Agent Versions: Iterate Safely on AI Configurations](https://botsify.mintlify.app/concepts/agent-versions.md): Botsify supports named, versioned agent configurations so you can iterate safely and roll back changes without affecting live users.
- [How Botsify Conversations, Context, and Messaging Work](https://botsify.mintlify.app/concepts/conversations.md): Learn how Botsify tracks conversation history using fbId, manages per-user context, and supports both synchronous and streaming message responses.
- [User Attributes: Personalize Botsify Conversations](https://botsify.mintlify.app/concepts/user-attributes.md): Store custom key-value data on individual bot users to power personalized conversations, conditional chat flows, and targeted outbound messaging.
- [Create Your First Botsify Bot or AI Agent with API](https://botsify.mintlify.app/guides/bots/create-your-first-bot.md): Step-by-step guide to creating a chatbot, AI agent, or voice bot in your Botsify workspace using the REST API. Covers all agent types.
- [Deploy a Botsify AI Agent with Versioned Configurations](https://botsify.mintlify.app/guides/agent-versions/deploy-an-agent.md): Learn how to configure agent instructions, save a named version, set it as active, and deploy your Botsify AI agent to production.
- [Send Messages to Bot Users Across Channels with Botsify](https://botsify.mintlify.app/guides/messaging/send-messages.md): Use the Botsify API to proactively send text and rich media messages to your bot users on Messenger, WhatsApp, and the Converse inbox.
- [Integrate and Broadcast on WhatsApp with Botsify API](https://botsify.mintlify.app/guides/whatsapp/whatsapp-integration.md): Connect your Botsify bot to WhatsApp, create and manage message templates, send broadcasts, and retrieve detailed delivery reports via the API.
- [Measure Botsify Bot Performance with Dashboard Analytics](https://botsify.mintlify.app/guides/analytics/analytics.md): Retrieve dashboard statistics for your Botsify bots — including message counts and user engagement metrics — over any custom date range.
- [Login — Authenticate with Botsify and Get API Keys](https://botsify.mintlify.app/api-reference/authorization/login.md): Authenticate with your Botsify email and password to receive your OAuth client_id, client_secret, and an optional Bearer access token.
- [OAuth Token — Exchange Credentials for a Bearer Token](https://botsify.mintlify.app/api-reference/authorization/oauth-token.md): Exchange Botsify credentials for an OAuth2 Bearer token using the password grant flow. Use client_id and client_secret from login.
- [Create Bot — Add a New Chatbot or AI Agent in Botsify](https://botsify.mintlify.app/api-reference/bots/create-bot.md): Create a new chatbot, AI agent, or voice bot in your Botsify workspace. Provide a name, agent type, and optional template to get started.
- [Get Bots — Retrieve All Bots for a Botsify API Key](https://botsify.mintlify.app/api-reference/bots/get-bots.md): Retrieve all bots linked to a specific API key in your Botsify workspace. Use this to discover available bots before routing queries or managing them.
- [List Botsify Agents — Search and Filter Your Workspace](https://botsify.mintlify.app/api-reference/bots/list-agents.md): List all agents in your Botsify workspace with pagination, name search, and ownership filtering. Supports my and shared agent tabs for easy discovery.
- [Get Bot Data — Fetch Full Config for Authenticated Bot](https://botsify.mintlify.app/api-reference/bots/get-bot-data.md): Fetch the complete configuration and metadata for the bot linked to your Bearer token. Returns bot settings, API key, agent type, and current status.
- [Rename Agent — Update a Bot Display Name in Botsify](https://botsify.mintlify.app/api-reference/bots/rename-agent.md): Update the display name of an existing Botsify bot or AI agent. Supply the numeric bot ID and the new name; the change takes effect immediately.
- [Delete Botsify Agent — Permanently Remove by Agent ID](https://botsify.mintlify.app/api-reference/bots/delete-agent.md): Permanently delete a Botsify agent by its ID. All associated data, including conversation history, flows, and settings, is removed and cannot be recovered.
- [Clone Agent — Duplicate a Botsify Agent with All Data](https://botsify.mintlify.app/api-reference/bots/clone-agent.md): Create an exact duplicate of an existing Botsify agent, including all configuration, flows, and versions. The clone gets a new unique bot ID and API key.
- [Get Query Response — POST /api/v1/get-query-response](https://botsify.mintlify.app/api-reference/bots/get-query-response.md): Send a user message to a Botsify bot and receive an AI-generated response. Identify the bot with your API key and the user session with a unique fbId.
- [Bot Activation Status — Enable or Disable for a User](https://botsify.mintlify.app/api-reference/bots/change-activation-status.md): Enable or disable your Botsify bot for a specific end-user identified by fbId. Useful for handing conversations to live agents or resuming automation.
- [List Agent Versions — GET /api/v1/bot/agent-versions](https://botsify.mintlify.app/api-reference/agent-versions/list-versions.md): Retrieve all saved versions for a Botsify agent, including version IDs, names, configuration fields, and which version is currently active.
- [Save a New Agent Version — POST /api/v1/update-agent](https://botsify.mintlify.app/api-reference/agent-versions/save-version.md): Create a new named snapshot of your agent configuration or update an existing version with instructions, chat flow, memory, soul, identity, and user info.
- [Patch Instruction Section — POST /api/v1/update-instruction](https://botsify.mintlify.app/api-reference/agent-versions/patch-instruction.md): Update a single instruction field (agent, memory, soul, identity, or user_info) on an existing agent version without replacing the whole version.
- [Set Active Agent Version — POST /api/v1/set-active-version](https://botsify.mintlify.app/api-reference/agent-versions/set-active-version.md): Designate which saved version of your Botsify agent is served in live conversations. The switch takes effect immediately with no restart required.
- [Delete Agent Versions — DELETE /api/v1/delete-version](https://botsify.mintlify.app/api-reference/agent-versions/delete-versions.md): Permanently remove one or more saved agent versions by passing an array of version IDs. The currently active version is protected and cannot be deleted.
- [Deploy Botsify AI Agent — POST /api/v1/deploy-ai-agent](https://botsify.mintlify.app/api-reference/agent-versions/deploy-agent.md): Push your Botsify AI agent to production. Deploy the active version, a specific saved version, or create a new named snapshot in one request.
- [Converse with a Botsify Agent — POST /api/v1/converse](https://botsify.mintlify.app/api-reference/messaging/converse.md): Send a message to a Botsify AI agent and get a complete synchronous reply. Identify the session with fbId and optionally include prior message history.
- [Agent Converse Stream — POST /api/v1/converse/stream](https://botsify.mintlify.app/api-reference/messaging/converse-stream.md): Send a message to a Botsify AI agent and receive the reply as a server-sent event stream, delivering tokens in real time for a responsive chat experience.
- [Converse Chat Stream — POST /api/v1/converse/chat/stream](https://botsify.mintlify.app/api-reference/messaging/converse-chat-stream.md): Stream messages to a Botsify agent and get the reply in OpenAI-compatible chat completion format, ideal for existing streaming client libraries.
- [Stop Converse Stream — POST /api/v1/converse/stop-stream](https://botsify.mintlify.app/api-reference/messaging/stop-converse-stream.md): Cancel an in-progress Botsify agent streaming response by supplying the stream ID. Immediately halts token generation so no further output is produced.
- [Get Conversation — POST /api/v1/converse/get-conversation](https://botsify.mintlify.app/api-reference/messaging/get-conversation.md): Retrieve the full conversation history between a Botsify agent and a specific user identified by their fbId, returned in chronological order.
- [Send Message to User — POST /api/v1/send-message-to-user](https://botsify.mintlify.app/api-reference/messaging/send-message-to-user.md): Proactively push a message to a bot user on Messenger or other connected channels. Supports text, rich cards, and Messenger policy tags.
- [Send Text Message — /api/v1/converse/send-message-to-user](https://botsify.mintlify.app/api-reference/messaging/send-text-message.md): Send a plain text message to a user via Botsify Converse channel. Supply your API key, recipient ID, message type, and the text content.
- [Send Inbox Thread Message — POST /api/v1/send-message](https://botsify.mintlify.app/api-reference/messaging/send-inbox-message.md): Post a message into a user inbox conversation thread in Botsify. Provide the bot ID, user session fbId, and message text to insert into the thread.
- [Get Conversations — POST /api/v1/get-conversations](https://botsify.mintlify.app/api-reference/users/get-conversations.md): Retrieve a paginated list of all conversation threads for your Botsify bot, filtered by channel source such as Messenger or web chat.
- [Retrieve User Chat History — POST /api/v1/get-chat](https://botsify.mintlify.app/api-reference/users/get-chat.md): Fetch the complete message history for a specific Botsify bot user identified by their fbId, useful for auditing sessions and live agent handoffs.
- [Get Bot Messenger Users — POST /api/v1/get-bot-users](https://botsify.mintlify.app/api-reference/users/get-bot-users.md): Retrieve all Messenger users subscribed to your Botsify bot with support for offset-based pagination using the limit and skip parameters.
- [List Botsify Account Users — GET /api/v1/get-users](https://botsify.mintlify.app/api-reference/users/get-users.md): List all users registered in your Botsify account with support for pagination. Use the page query parameter to iterate through large result sets.
- [Change User Status — POST /api/v1/user/change-status](https://botsify.mintlify.app/api-reference/users/change-user-status.md): Bulk-update the status of one or more Botsify users by supplying their IDs in the request body, with optional scoping to a specific user segment.
- [Set User Attribute — POST /api/v1/add-user-attribute](https://botsify.mintlify.app/api-reference/users/set-user-attribute.md): Store a custom key-value attribute on a Botsify bot user to enable personalized conversation flows, targeted segments, and dynamic content delivery.
- [Bot Dashboard Stats — POST /api/v1/bot-dashboard-stats](https://botsify.mintlify.app/api-reference/analytics/bot-dashboard-stats.md): Fetch aggregated performance statistics for your Botsify bot over a custom date range, including message counts, unique users, and engagement metrics.
- [Get WhatsApp Templates — GET /api/v1/media-block/fetch](https://botsify.mintlify.app/api-reference/whatsapp/get-templates.md): Retrieve all WhatsApp message templates saved in your Botsify account, including approval status and body content, for use in broadcast campaigns.
- [Create WhatsApp Template — POST /api/v1/media-block/create](https://botsify.mintlify.app/api-reference/whatsapp/create-template.md): Create a new WhatsApp message template in Botsify for Meta review and approval. Optionally specify a template type using the typed endpoint variant.
- [Send WhatsApp Broadcast — POST /api/v1/whatsapp/send](https://botsify.mintlify.app/api-reference/whatsapp/single-broadcast.md): Send a WhatsApp broadcast using an approved Botsify template to one or more recipients, with dynamic variable substitution via the template_data object.
- [WhatsApp Broadcast Report — POST /api/v1/broadcast-report](https://botsify.mintlify.app/api-reference/whatsapp/broadcast-report.md): Retrieve delivery and engagement stats for WhatsApp broadcasts sent via Botsify within a date range, covering sent, delivered, read, and failed counts.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.