API Documentation

Build with Modelix API

Integrate conversational data analytics into your applications. Our REST API provides programmatic access to all Modelix features — chat sessions, datasets, model deployment, and more.

RESTful Architecture

Clean, predictable REST endpoints with JSON request/response bodies. Easy to integrate with any stack.

Dataset Management

Upload, query, and manage your datasets programmatically. Handle millions of rows with ease.

Enterprise Security

API key authentication, TLS encryption, and rate limiting on every request to keep your data safe.

Quick Start

Get up and running in minutes.

1

Get Your API Key

Generate an API key from your dashboard settings

Visit Dashboard → Settings → API Keys
2

Authenticate Requests

Include your API key in request headers

curl -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ https://api.modelix.world/api/v1/datasets
3

Start Analyzing

Create a session and send your first query

curl -X POST https://api.modelix.world/api/v1/chat/sessions \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"title": "Sales Analysis"}'
99.9%
Uptime SLA
<100ms
Avg Latency
5
API Endpoints
3
Official SDKs

Official SDKs

Use our official libraries to integrate Modelix into your preferred stack in minutes.

🐍

Python

pip install modelix-sdk

from modelix import Client

client = Client(api_key="YOUR_API_KEY")
session = client.chat.create_session()
response = session.send_message("Analyze Q4 sales trends")
⚡

JavaScript

npm install @modelix/sdk

import { ModelixClient } from '@modelix/sdk';

const client = new ModelixClient({
  apiKey: process.env.MODELIX_API_KEY
});

const session = await client.chat.createSession();
const result = await session.sendMessage("Analyze Q4 sales trends");
🔧

cURL

curl -X POST https://api.modelix.world/api/v1/chat/sessions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Analyze Q4 sales trends"}'

API Reference

Full reference for all available endpoints.

POST/api/v1/chat/sessions
Auth Required

Create a new chat session

Request Body

{
  "title": "Optional Dataset Reference",
  "dataset_id": "string (optional)"
}

Response

{
  "session_id": "string",
  "status": "active",
  "created_at": "timestamp"
}
POST/api/v1/chat/sessions/{session_id}/messages
Auth Required

Send a message to analyze data

Request Body

{
  "message": "Analyze customer churn by region",
  "stream": false
}

Response

{
  "message_id": "string",
  "response": "Analysis results...",
  "visualizations": [],
  "execution_time": "number"
}
GET/api/v1/datasets
Auth Required

List all uploaded datasets

Response

{
  "datasets": [
    {
      "id": "string",
      "name": "sales_data.csv",
      "size": 1048576,
      "uploaded_at": "timestamp"
    }
  ]
}
POST/api/v1/datasets/upload
Auth Required

Upload a new dataset

Request Body

{
  "file": "FormData",
  "name": "string (optional)"
}

Response

{
  "dataset_id": "string",
  "message": "Dataset uploaded successfully"
}
POST/api/v1/deploy/models/predict
Auth Required

Make predictions using deployed model

Request Body

{
  "session_id": "string",
  "input_data": {
    "feature1": "value1",
    "feature2": "value2"
  }
}

Response

{
  "predictions": [
    0.85,
    0.15
  ],
  "model_version": "v1.0",
  "execution_time": 123
}

Authentication

All API requests require authentication using a Bearer token. Generate your API key from your dashboard settings and include it in every request header.

Authorization: Bearer YOUR_API_KEY

Rate Limits & Best Practices

Rate Limits by Plan

  • Free Tier100 requests/hour
  • Pro Tier1,000 requests/hour
  • EnterpriseCustom limits

Best Practices

  • StreamingUse for real-time responses
  • CachingCache responses when possible
  • RetriesExponential backoff on failure

Ready to Start Building?

Get your API key, explore the endpoints, and integrate Modelix analytics into your product today.

Get API Key FreeOpen Dashboard