API Reference

Complete REST API documentation for the Akili Climate Intelligence Platform. Explore endpoints, test requests, and integrate with your applications.

Interactive Docs

Explore and test API endpoints interactively

Open Swagger UI

ReDoc

Beautiful, responsive API documentation

Open ReDoc

OpenAPI Spec

Download the OpenAPI JSON specification

Interactive API Documentation

Browse endpoints, view schemas, and test API calls directly from your browser

Quick Start

Get started with the Akili API using these code examples. Replace your-api-key-here with your actual API key.

python

import requests

# Set your API key
API_KEY = "your-api-key-here"
BASE_URL = "http://localhost:8000/api/v1/api/v1"

# Example: Get datasets
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

response = requests.get(f"{BASE_URL}/flow/datasets", headers=headers)
datasets = response.json()
print(datasets)

Authentication

All API requests require authentication using an API key

Getting Your API Key

Log in to your Akili dashboard
Navigate to Settings → API Keys
Click Generate New Key
Copy and securely store your API key

Using Your API Key

Include your API key in the Authorization header of every request:

Authorization: Bearer your-api-key-here

API Endpoints

FLOW

Dataset management and data pipelines

GET /api/v1/flow/datasets - List datasets
POST /api/v1/flow/datasets - Create dataset
GET /api/v1/flow/datasets/{id} - Get dataset

MODELE

AI/ML model inference and training

GET /api/v1/modele/models - List models
POST /api/v1/modele/models/{id}/predict - Run inference

CLIMA

Climate intelligence and analytics

GET /api/v1/clima/climate/indicators - Get indicators
GET /api/v1/clima/climate/hazards - Get hazards

Authentication

User authentication and authorization

POST /api/v1/auth/login - Login
POST /api/v1/auth/register - Register
GET /api/v1/auth/me - Get current user

Rate Limits

API usage limits and best practices

Current Limits

Free Tier: 1,000 requests per day
Pro Tier: 10,000 requests per day
Enterprise: Custom limits

Rate Limit Headers

Every API response includes rate limit information:

X-RateLimit-Limit: 1000

X-RateLimit-Remaining: 999

X-RateLimit-Reset: 1640995200

Next Steps

Read Quick Start Guide Authentication Guide Open Interactive Docs

Quick Start

Get started with the Akili API using these code examples. Replace your-api-key-here with your actual API key.

python

import requests

# Set your API key
API_KEY = "your-api-key-here"
BASE_URL = "http://localhost:8000/api/v1/api/v1"

# Example: Get datasets
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

response = requests.get(f"{BASE_URL}/flow/datasets", headers=headers)
datasets = response.json()
print(datasets)

API Endpoints

FLOW

Dataset management and data pipelines

GET /api/v1/flow/datasets - List datasets
POST /api/v1/flow/datasets - Create dataset
GET /api/v1/flow/datasets/{id} - Get dataset

MODELE

AI/ML model inference and training

GET /api/v1/modele/models - List models
POST /api/v1/modele/models/{id}/predict - Run inference

CLIMA

Climate intelligence and analytics

GET /api/v1/clima/climate/indicators - Get indicators
GET /api/v1/clima/climate/hazards - Get hazards

Authentication

User authentication and authorization

POST /api/v1/auth/login - Login
POST /api/v1/auth/register - Register
GET /api/v1/auth/me - Get current user