Developer Resources

Documentation

Everything you need to integrate CLADAL into your applications. Generate deep research reports programmatically with our REST API.

Quick Start

Getting Started

Go from zero to your first research report in three steps.

1

Create your account

Sign up at cladal.com/signup. All new accounts include a free trial with 3 reports so you can evaluate the platform before committing to a plan.

2

Get your API key

Navigate to Account Settings → Security and generate a new API key. Copy it immediately — it will only be shown once. Store it securely as an environment variable.

bash
export CLADAL_API_KEY="ck_live_...your_key_here"
3

Make your first request

Use the following curl command to create your first deep research report. The API returns a report ID that you can poll for status and results.

curl
curl -X POST https://api.cladal.com/api/v1/research \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "AI adoption trends in healthcare 2025-2026",
    "depth": "standard",
    "format": "pdf"
  }'

Reference

API Reference

RESTful endpoints for creating, retrieving, and managing research reports.

MethodEndpointDescription
POST/api/v1/researchCreate a new deep research report. Returns a report ID for polling.
GET/api/v1/reports/:idRetrieve a report by ID, including status, content, and citations.
GET/api/v1/reportsList all reports for your account. Supports pagination and filtering.
DELETE/api/v1/reports/:idPermanently delete a report and its associated data.

Request Body

json
{
  "query": "string (required)",
  "depth": "quick | standard | deep",
  "format": "pdf | html | markdown",
  "webhook_url": "string (optional)",
  "metadata": { }
}

Response

json
{
  "id": "rpt_a1b2c3d4",
  "status": "processing",
  "query": "AI adoption trends in healthcare",
  "depth": "standard",
  "created_at": "2026-03-04T12:00:00Z",
  "estimated_completion": "2026-03-04T12:15:00Z"
}

Security

Authentication

All API requests must include a valid API key in the Authorization header.

Bearer Token Authentication

Include your API key as a Bearer token in the Authorization header of every request. API keys are prefixed with ck_live_ for production and ck_test_ for sandbox environments.

http
Authorization: Bearer ck_live_...your_key_here

Security note: Never expose your API key in client-side code or public repositories. Always make API calls from your server or a secure backend.

Integration

Code Examples

Copy-paste examples in your preferred language to start generating reports.

JSJavaScript / TypeScript

javascript
const response = await fetch("https://api.cladal.com/api/v1/research", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    query: "AI adoption trends in healthcare 2025-2026",
    depth: "standard",
    format: "pdf",
  }),
});

const { id, status } = await response.json();

// Poll for completion
const report = await fetch(
  `https://api.cladal.com/api/v1/reports/${id}`,
  { headers: { "Authorization": "Bearer YOUR_API_KEY" } }
).then(r => r.json());

console.log(report.title, report.status);

PYPython

python
import requests

API_KEY = "YOUR_API_KEY"
BASE_URL = "https://api.cladal.com/api/v1"

# Create a research report
response = requests.post(
    f"{BASE_URL}/research",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json",
    },
    json={
        "query": "AI adoption trends in healthcare 2025-2026",
        "depth": "standard",
        "format": "pdf",
    },
)

data = response.json()
report_id = data["id"]

# Poll for completion
report = requests.get(
    f"{BASE_URL}/reports/{report_id}",
    headers={"Authorization": f"Bearer {API_KEY}"},
).json()

print(report["title"], report["status"])

Limits

Rate Limits

Rate limits are applied per API key. Exceeding limits returns a 429 status code with a Retry-After header.

PlanRate LimitBurst LimitDaily Limit
Starter10 req/min15 req/min500 req/day
Professional60 req/min90 req/min5,000 req/day
Business200 req/min300 req/min20,000 req/day

Need higher limits?

Enterprise plans include custom rate limits tailored to your workload. Contact sales to discuss your requirements.

Help

Support

We are here to help you build with CLADAL.