CLEARIE™ GETWAYEX-IM Intelligence & APIs

Docs

AI credits

Understand AI depth, independent usage meters, and settlement for completed work.

AI depth gating

Each plan allows a maximum AI depth: Developer (none) · Starter (basic) · Growth (advanced) · Scale (deep) · Business (all available searches) · Enterprise (dedicated capacity).

Requesting a deeper depth than your plan returns 402 ai_depth_required.

Cost table

POST /v1/ai/impact-analyze uses 20 weighted API units after a successful response. Its AI depth is metered separately: basic uses 5 AI credits, advanced uses 10, and deep or dedicated uses 50.

AI-assisted product intake consumes reconciled AI credits for completed extraction and cloud document pages only when the managed parser runs. Product intake does not consume API units.

Trade Copilot uses the published 20-unit AI endpoint weight plus AI credits reconciled to completed reasoning work.

When a reservation becomes usage

Capacity is reserved before provider work starts. A successful grounded answer commits the applicable weighted API units and actual AI credits. Provider failures and requests refused before provider work release their reservations.

Insufficient-evidence AI Trade Impact results do not consume AI credits. If managed parsing already completed before Copilot reasoning is refused or fails, Getway retains only the parser AI credits and cloud pages and releases the Copilot API units and model credits.

Use the read:usage endpoint for the current used, reserved, remaining, effective-limit, and forecast values. See Usage reporting for the complete response contract.

Soft and hard caps

At 80% of monthly credits we send a notification. At 100% AI endpoints return 402 payment_required. Master-data endpoints continue to work; only AI is gated.

Buy add-on AI credit packs from Billing → Top-ups (Growth, Scale, and Business plans).