Getting Started

Introduction

Welcome to Robofy, an AI agent platform for websites, WhatsApp, lead capture, customer support, and business automation. This guide provides a step-by-step walkthrough to help you create your account, get your API key, and start using Robofy APIs in a few minutes.

By the end of this guide, you will have:

Created a Robofy account and obtained your API key.

Understood how to authenticate Robofy API requests.

Learned how to access agent, inbox, conversation, and integration-related data using APIs.

Understood basic error handling and security best practices.

Learned the next steps to take your Robofy integration further.

Robofy is designed to help businesses build AI agents that can answer customer questions, capture leads, support users, and connect with external systems.

Prerequisites

Before you begin, ensure you have the following:

A Robofy account. If you don't have one, you can create one for free.

At least one AI agent created in your Robofy account.

Your Robofy API key, which can be found inside your Robofy dashboard.

The required agent or chatbot ID for the API you want to use.

API Fundamentals

Base URL

All API requests should be made to the following base URL:

https://agents.robofy.ai

Authentication

To authenticate your requests, include your API key in the Authorization header of every request.

Header name: Authorization: Bearer <YOUR_API_KEY>

Example:

Replace <YOUR_API_KEY> with your actual Robofy API key.

Keep your API key secure and do not expose it in frontend code, public repositories, or client-side applications. If you believe your API key has been compromised, generate a new key from your Robofy dashboard.

Making Your First API Request

You can make your first API request by calling one of the Robofy endpoints.

For example, the following request retrieves inbox sessions for an AI agent.

Replace the following values:

<YOUR_API_KEY> with your Robofy API key.

<CHATBOT_ID> with the encrypted chatbot or agent ID from your Robofy account.

Example Response

A successful response may look like this:

{
  "message": "sessions found successfully.",
  "data": {
    "sessions": [
      {
        "sessionId": "6017409f-51b6-4c87-97c3-fc812dc2febe",
        "createdOn": "2026-04-23T10:30:00",
        "lastMessage": "I want to know more about your pricing.",
        "status": "active"
      }
    ]
  }
}

The actual response structure may vary based on the API endpoint you are using.

Reading Conversation Messages

After retrieving a session ID, you can fetch the conversation messages for that session.

Replace the following values:

<CHATBOT_ID> with your encrypted chatbot or agent ID.

<SESSION_ID> with the session ID received from the inbox sessions API.

<YOUR_API_KEY> with your Robofy API key.

Error Handling

The Robofy API uses standard HTTP status codes to indicate whether a request was successful or failed.

2xx status codes indicate a successful request.

4xx status codes indicate a client-side error, such as invalid request, missing API key, or invalid chatbot ID.

5xx status codes indicate a server-side error.

When an error occurs, the response body will usually contain a human-readable message to help you debug the issue.

Example error response:

{
  "message": "The request is missing a valid API key.",
  "error": {
    "code": "Unauthorized",
    "details": "Authentication credentials were not provided."
  }
}

Common causes of API errors include:

Missing or invalid API key.

Invalid chatbot or agent ID.

Invalid session ID.

Requesting data that does not belong to your account.

Incorrect endpoint URL.

Missing required request parameters.

Security Best Practices

To keep your Robofy integration secure, we recommend the following:

Use HTTPS for all API requests.

Keep your API key private and never expose it in browser-side code.

Store API keys in a secure environment variable or secret manager.

Rotate your API key if you suspect it has been leaked.

Only share API access with trusted team members.

Validate incoming webhook requests if you are using webhooks.

Do not store sensitive customer data unless it is required for your business use case.

Next Steps

Now that you understand the basics of Robofy API authentication and usage, you can continue with the next steps:

Explore Inbox APIs: Retrieve sessions, messages, and customer conversations.

Connect External Systems: Use Robofy APIs to connect your AI agent with your CRM, helpdesk, booking system, or internal tools.

Set up Webhooks: Receive real-time events from Robofy when supported.

Review Conversation Data: Use conversation history to improve support, lead qualification, and customer experience.

Train Your AI Agent: Add website pages, files, FAQs, and custom instructions to improve response quality.

Use Robofy Dashboard: Manage agents, API keys, integrations, analytics, and settings from one place.

For more help, visit the Robofy dashboard or contact the Robofy support team.


I kept authentication as `api-key` because your Robofy examples use that header, while SendZen uses `Authorization: Bearer <token>`.

Introduction#

Prerequisites#

API Fundamentals#

Base URL#

Authentication#

Making Your First API Request#

Example Response#

Reading Conversation Messages#

Error Handling#

Security Best Practices#

Next Steps#