Version 0.1.x

camelAI Documentation

Authenticate with API key and get a short-lived JWT token for browser use.

Issue STS Token

Ask Camel a question: always creates a new thread per call. Provide exactly one of `source_id` (an existing connection ID) or `source` (an inline connection configuration with a `type`), and optional `knowledge_base_entries` and `reference_queries`.

Ask Camel

Retrieve all knowledge base entries accessible to the current user.

List knowledge base entries

Create a new knowledge base entry for one or more data sources.

Create knowledge base entry

Get details of a specific knowledge base entry.

Retrieve knowledge base entry

Update knowledge base entry

Delete knowledge base entry

Update specific fields of a knowledge base entry.

Partial update knowledge base entry

Get all knowledge base entries associated with a specific data source.

List knowledge base entries for a specific source

Generate intelligent recommendations for questions and insights based on connected data sources and optional conversation context. If thread_id is provided, recommendations will be contextual to the conversation. Otherwise, general starting point recommendations will be generated.

Generate chat recommendations

Retrieve all reference queries accessible to the current user.

List reference queries

Create a new reference query for one or more data sources. The query will be validated and enriched with a title and description.

Create reference query

Get details of a specific reference query.

Retrieve reference query

Update an entire reference query. This will trigger re-validation and regenerate the title/description.

Update reference query

Delete reference query

Update specific fields of a reference query.

Partial update reference query

Validate that a query is syntactically correct for the associated connections.

Validate a reference query

Get all reference queries associated with a specific data source.

List reference queries for a specific source

Return all available data sources for the current user with pagination support.

List data sources

Create a new connection of any supported type. The type field determines which connection type to create.

Add connection

Retrieve details of a specific data source.

Get data source details

Update a data source connection. Only account_name can be updated via this endpoint.

Update data source

Delete data source

Partially update a data source connection.

Partial update data source

Update configuration for any type of data source. The required fields depend on the connection type.

Update data source configuration

Deprecated alias for the create connection endpoint. Prefer POST /sources/ instead.

Add connection (legacy route)

Create a new Google BigQuery data warehouse connection.

Add BigQuery connection

Create a new ClickHouse data warehouse connection.

Add ClickHouse connection

Create a new MongoDB database connection.

Add MongoDB connection

Create a new MotherDuck data warehouse connection.

Add MotherDuck connection

Create a new Microsoft SQL Server database connection.

Add SQL Server connection

Add MySQL connection

Create a new PostgreSQL database connection.

Add PostgreSQL connection

Create a new SingleStore database connection.

Add SingleStore connection

Create a new Snowflake data warehouse connection. Supports both password and key-pair authentication.

Add Snowflake connection

Return all threads accessible to the current user with pagination support.

List threads

Get thread details

Rename thread

Delete thread

Rename thread (partial)

Retrieve all messages for a specific thread. Messages are returned in chronological order.

Get thread messages

Bring camelAI business intelligence directly into your preferred AI environment with MCP integration.

Introduction

Choose the right integration option for you

Getting Started

Connect camelAI MCP server to Claude for seamless data analysis in your AI conversations

Claude Integration

Chatgpt integration

Connect camelAI MCP server to Cursor for seamless data analysis in your code editor

Cursor Integration

Connect camelAI MCP server to Microsoft Copilot for seamless data analysis in your AI conversations

Microsoft Copilot Integration

Connect camelAI MCP server to Windsurf for seamless data analysis in your AI-powered code editor

Windsurf Integration

Learn about camelAI, your intelligent data analyst that connects to your databases and provides natural language insights.

Learn about camelAI plans so you can choose what's right for you and your team.

Plans

Get started with camelAI in minutes using Docker Compose.

Quickstart Guide

Learn about the system requirements and prerequisites for running camelAI.

Prerequisites

Learn how to set up and configure Docker Compose for camelAI.

Docker Compose Setup

Learn how to configure environment variables for camelAI.

Environment Variables

Learn how to set up Azure OpenAI for camelAI.

Azure OpenAI Setup

Learn how to create a superuser account for camelAI.

Creating a Superuser

Learn how to log in to camelAI and access its features.

Logging In

Learn how to configure initial settings and preferences in camelAI.

Initial Setup

Learn how to manage user permissions, data access, and dashboard sharing in camelAI Enterprise

Updates

​Version 0.1.x

Version 0.1.x