Welcome to the Robofy API reference. This page provides an overview of Robofy API’s core concepts and structure, helping you understand the basics before you start working with individual endpoints.Robofy APIs allow you to access and manage AI agent-related data such as inbox sessions, conversation messages, leads, analytics, integrations, and other account-level resources.
Base URL#
All production API requests should be directed to:For security, Robofy’s production API strictly uses HTTPS.
Authentication#
All requests to the Robofy API must be authenticated.Header: Authorization: Bearer YOUR_API_KEY
YOUR_API_KEY with your actual Robofy API key.Keep your API key secure and do not expose it in frontend code, public repositories, browser-side scripts, or client-side applications.
Core Resources#
Below are the primary resource categories you will find in the API documentation. Each category may have dedicated endpoints depending on the feature and account permissions.AI Agents#
Access and manage AI agent-related information. These APIs can help you work with agent configuration, agent identifiers, and related account-level data.Inbox Sessions#
Retrieve AI agent inbox sessions and view customer conversations grouped by session.Common use cases include:Viewing active or completed conversations
Fetching customer interaction history
Connecting Robofy conversation data with your CRM or internal system
Conversation Messages#
Fetch the messages exchanged between users and AI agents for a specific session.These APIs are useful for:Reviewing full conversation history
Building custom inbox views
Exporting conversation data
Performing internal analysis on customer queries
Leads#
Access lead-related data captured by Robofy AI agents.This can include information submitted by users during conversations, such as name, email, phone number, company details, requirements, or other custom fields based on your agent setup.Knowledge Base / Training#
Robofy agents can be trained using website pages, files, FAQs, custom text, and business instructions.Knowledge base APIs may be used to manage or retrieve training-related resources depending on the available endpoints.API Keys#
API keys are used to securely authenticate requests to Robofy APIs.You can manage your API key from the Robofy dashboard.
All API requests and responses use the application/json content type unless mentioned otherwise in a specific endpoint.Ensure your request bodies are valid JSON.
Example API Request#
Below is a basic example of calling a Robofy API endpoint using JavaScript and Axios.Replace the following values:YOUR_API_KEY with your Robofy API key.
<CHATBOT_ID> with your encrypted chatbot or AI agent ID.
Errors#
The Robofy API provides clear error responses to help you debug failed requests.Client Errors: 4xx HTTP status codes indicate issues with your request, such as invalid parameters, missing authentication, invalid agent ID, or insufficient access.
Server Errors: 5xx HTTP status codes indicate an issue on the Robofy server.
{
"error": {
"code": "unauthorized",
"message": "The request is missing a valid bearer token.",
"details": {
"field": "Authorization"
}
}
}
Invalid chatbot or agent ID
Requesting data that does not belong to your account
Invalid JSON request body
Missing required request parameters
Support#
Robofy provides support to help you with API usage, integration setup, and troubleshooting. Modified at 2026-04-28 06:45:50
