Documentation

Ship India trade workflows with clear contracts

Start with scoped keys and isolated sandbox records, then move the same versioned contracts into production. Usage weights, retries, errors, and source context stay explicit.

Scoped live and sandbox keys

Published weighted-unit costs

Stable errors and retry guidance

Getting started

Create a workspace, mint an API key, and make your first call.

Authentication

Bearer tokens, key prefixes (ck_live_/ck_sbox_), scopes, rotation.

Sandbox environment

Synthetic records, sandbox keys, weekly limits, and CI-safe calls.

Rate limits

Per-second and per-month quotas per plan. Reading the X-RateLimit headers.

Usage reporting

Four independent meters, reservations, settlement, add-ons, and forecasts.

AI credits

How impact analysis and other source-backed AI workflows consume credits.

Webhooks

Receiving event-stream pushes — HMAC-SHA256 signature verification.

Our data

How sources are collected, normalized, validated, cited, and published.

SDKs

TypeScript, Python, and curl examples for every master-data endpoint.

Errors

Error envelope, retry semantics, and idempotency keys.

Changelog

Stable versioning and deprecation policy.

Quick start

# 1. Mint a key in the dashboard
export CLEARIE_KEY="ck_live_..."

# 2. Call any master-data endpoint
curl -H "Authorization: Bearer $CLEARIE_KEY" \
     https://getway.clearie.ai/v1/master/hsn/exports?code=2710

# 3. Run an AI impact analysis
curl -H "Authorization: Bearer $CLEARIE_KEY" \
     -H "Content-Type: application/json" \
     -d '{"query":"EU CBAM impact on steel exports from India"}' \
     https://getway.clearie.ai/v1/ai/impact-analyze