CanalAPI
User GuideDeveloper GuideExamples

User Guide

Overview of CanalAPI's console features for end users.

The User Guide covers everything you need to manage your CanalAPI account from the console.

  • Account — sign up, sign in, email verification, profile, OAuth providers, account deletion and export.
  • Security — two-factor authentication (TOTP), backup codes, active sessions, trusted devices.
  • API Keys — create, rotate, revoke; per-key IP allowlist, model allowlist, quota, expiration.
  • Billing — top up (Stripe / Alipay / WeChat Pay), auto-recharge, balance breakdown, invoices.
  • Subscriptions — monthly quota bundles, enterprise subscriptions, Stripe Checkout, overage policies.
  • Usage Logs — per-request token and cost, CSV export, dashboard analytics.
  • Referrals — referral code, commission settlement, withdrawal to balance.

If you are integrating CanalAPI into an application, see the Developer Guide.