Introduction

Welcome to Arcane AI documentation. Learn how to unlock hidden intelligence in your data using our powerful analytics platform.

What is Arcane AI?

Arcane AI is a next-generation analytics platform that uses advanced machine learning to discover patterns and insights that traditional analytics tools miss. Our platform processes your data through multiple AI models to surface actionable intelligence.

Key Features

  • Automated Pattern Discovery: Our AI automatically identifies correlations and patterns without manual query building
  • Predictive Analytics: Forecast future trends and behaviors with high accuracy
  • Real-time Processing: Process millions of data points in seconds
  • Visual Dashboards: Beautiful, interactive visualizations that tell your data's story
  • Enterprise Security: SOC2 Type II compliant with end-to-end encryption

Quick Start

Get up and running with Arcane AI in under 5 minutes.

Step 1: Create an Account

Sign up at app.arcaneai.site to create your free account. No credit card required.

Step 2: Create Your First Project

Once logged in, click "New Project" and give it a name. Projects organize your data sources and analytics.

Step 3: Connect a Data Source

Python 
from arcaneai import ArcaneAI

client = ArcaneAI(api_key="your-api-key")

client.sources.create(
    name="my-database",
    type="postgresql",
    connection_string="postgresql://user:pass@host:5432/db"
)

Step 4: Run Your First Analysis

Python 
analysis = client.analyses.create(
    source_id="my-database",
    analysis_type="pattern_discovery"
)

print(analysis.insights)

Authentication

Arcane AI uses API keys to authenticate requests. You can manage your API keys in the Dashboard.

Creating an API Key

  1. Navigate to Settings → API Keys
  2. Click "Create New Key"
  3. Give your key a descriptive name
  4. Copy the key immediately (it won't be shown again)
Security Note: Never commit API keys to version control. Use environment variables instead.

Using Your API Key

Include your API key in the Authorization header:

cURL 
curl -X POST https://api.arcaneai.site/v1/analyses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source_id": "my-database", "type": "pattern_discovery"}'

API Endpoints

Base URL

https://api.arcaneai.site/v1

Endpoints Overview

Method Endpoint Description
GET /sources List all data sources
POST /sources Create a new data source
GET /sources/:id Get a specific data source
DELETE /sources/:id Delete a data source
POST /analyses Create a new analysis
GET /analyses/:id Get analysis results
POST /predictions Create a prediction model

Python SDK

Our Python SDK provides a convenient way to interact with Arcane AI from Python applications.

Installation

bash 
pip install arcaneai

Basic Usage

Python 
from arcaneai import ArcaneAI

client = ArcaneAI()

# Create a data source
source = client.sources.create(
    name="sales-data",
    type="postgresql",
    host="db.example.com",
    port=5432,
    database="sales",
    username="readonly_user",
    password="secure_password"
)

# Run pattern discovery
patterns = client.analyses.discover_patterns(
    source_id=source.id,
    tables=["orders", "customers", "products"]
)

# Get predictions
predictions = client.predictions.create(
    model_type="time_series",
    target_column="revenue",
    horizon=30  # days
)

JavaScript SDK

Use our JavaScript SDK for Node.js and browser applications.

Installation

bash 
npm install @arcaneai/sdk

Basic Usage

JavaScript 
import { ArcaneAI } from '@arcaneai/sdk';

const client = new ArcaneAI(process.env.ARCANE_API_KEY);

// Create a data source
const source = await client.sources.create({
    name: 'analytics-data',
    type: 'bigquery',
    projectId: 'my-gcp-project',
    datasetId: 'analytics'
});

// Run analysis
const analysis = await client.analyses.create({
    sourceId: source.id,
    type: 'pattern_discovery'
});

console.log(analysis.insights);

CLI Tool

The Arcane AI CLI provides command-line access to all platform features.

Installation

bash 
curl -sSL https://get.arcaneai.site/cli | sh

Authentication

bash 
arcane auth login

Common Commands

bash 
# List data sources
arcane sources list

# Create a new source
arcane sources create --name "my-db" --type postgresql

# Run analysis
arcane analyze --source "my-db" --type pattern_discovery

# View results
arcane analyses show <analysis-id>