API Overview

Welcome to the RubikChat API v1. Everything you need to integrate AI Agents, conversations, CRM functionality, knowledge bases, and business automation into your applications.

Introduction

The RubikChat API enables developers to integrate AI Agents, conversational experiences, CRM functionality, knowledge bases, workflows, and business automation directly into their own applications.

Built on modern REST architecture, the API provides a consistent interface for communicating with AI agents, managing conversations, handling knowledge sources, and integrating RubikChat into third-party systems.

Whether you're building an AI-powered customer support platform, restaurant ordering assistant, e-commerce shopping assistant, appointment booking system, or lead generation solution, the RubikChat API provides everything needed to interact with your AI agents programmatically.

API Documentation

The RubikChat API documentation contains detailed information about every available endpoint, authentication method, request format, response structure, error handling, and integration examples.

We recommend starting with the Authentication section before exploring individual API endpoints.

Prerequisites

Before using the API, ensure that:

You have an active RubikChat account.
You have access to a workspace.
You have created at least one AI Agent.
You have generated an API Key.
You have copied the Agent ID for the agent you want to communicate with.

Note

API access may depend on your RubikChat subscription plan.

Base URL

Base URL · text

https://api-proxy-v1.rubikchat.com/api/v1/

All API requests must be made using HTTPS.

Quick Start

Step 1 — Generate an API Key

Sign in to your RubikChat Dashboard.
Navigate to Top Right Corner (Profile area) → Settings → API Access Token.
Click Generate Token.
Copy and securely store the generated API Access Token.

Warning

Never expose your API Access Token in frontend applications or public repositories. Always store it securely on your server.

Step 2 — Get Your Agent ID

Open your RubikChat Dashboard.
Select the AI Agent you want to use.
Navigate to: Settings → General → AI Agent ID
Copy the Agent ID.

The Agent ID uniquely identifies the AI Agent that will receive your API requests.

Step 3 — Send Your First Message

Example request:

POST/api/v1/chat

Request · bash

curl -X POST "https://api-proxy-v1.rubikchat.com/api/v1/chat" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "YOUR_AGENT_ID",
    "message": "Hello! How can I place an order?"
  }'

Tip

The full message format and response structure are covered in the Chat with an Agent section.

Available API Endpoints

Base URL:https://api-proxy-v1.rubikchat.com/api/v1/

Method	Endpoint	Description
POST	/chat	Send a message to an AI Agent

Next: Authentication