Feature guide overview

The EasyAPI feature guide, organized by role into a user guide and an admin guide

EasyAPI is an AI API gateway and usage management system for legitimately authorized use cases. It aggregates multiple LLM providers behind an OpenAI-compatible API. This guide is split by role into a user guide and an admin guide so you can quickly find the features that apply to you.

Roles

The platform has three roles based on account permissions, each with a different scope of features.

Standard user

The default role after sign-up. Users can create API keys, call model APIs, view their own usage, and top up or redeem quota in the wallet.

Administrator (Admin)

A management role granted by a super admin. On top of user permissions, admins can manage operations such as channels, users, redeem codes, models, and logs.

Super admin (Root)

The highest-privilege role. On top of admin permissions, Root can manage global system settings, custom OAuth, performance monitoring, and docs configuration.

User guide

For all signed-in users, covering everything from sign-up to day-to-day use.

Profile settings

Manage your profile, security options, and sidebar module preferences.

Change nickname and password
Bind an email address
Two-factor authentication (2FA)
Passwordless login with passkeys
Sidebar module toggles

API keys

Create and manage API credentials with quota, model, and IP restrictions.

Create and copy an API key
Set a quota limit
Restrict allowed models
Configure an IP allowlist
View key usage

Using the API

Call LLMs through the OpenAI-compatible API and debug requests online in the Playground.

Get the API base URL
Test online in the Playground
Python and cURL examples
Streaming and non-streaming calls

Chat app integration

Import your EasyAPI configuration into popular AI clients and connect chat apps in one click.

One-click configuration import links
Lobe Chat integration
OpenCat and other client setup
Custom base URL and key

Usage records

See the model, token consumption, and quota deduction for every API call.

Usage log list
Filter by time or model
Token and quota statistics
Export and troubleshooting

Quota and top-up

Get quota for API calls through wallet top-ups, redeem codes, and more.

Top up your wallet balance
Redeem a code
Check-in rewards (if enabled)
View top-up and spending history

Pricing

View model prices and how billing ratios work.

Model price list
Search for a specific model
Ratios and billing rules

Task management

Check the status and results of asynchronous generation tasks such as images and music.

Task list and status
View task details
Retrying and troubleshooting failures

Admin guide

For Admin and Root roles, covering platform operations and system configuration.

Channels

Configure upstream AI provider channels with multiple keys, priorities, and automatic disabling policies.

Add and edit channels
Test channel connectivity
Multi-key round-robin
Bulk enable or disable

Users

View and manage platform users, and adjust their roles, groups, and quota.

User list and search
Change role and group
Adjust quota balance
Enable or disable accounts

Redeem codes

Generate and manage quota redeem codes in bulk.

Generate redeem codes in bulk
Set value and quantity
Export redeem codes
View redemption status

Models

Configure model pricing, ratios, and availability.

Set model ratios
Enable or disable models
Sync the upstream model list
Update pricing in bulk

Groups

Use groups to isolate channel access and billing ratios.

Create user groups
Configure group ratios
Bind channels to groups
Key group policies

System settings (Root only)

Root-only global configuration, including site information, billing, payments, and sign-up and login.

Basic site information
Billing and ratio rules
Payment methods
Sign-up and login policies

Advanced system settings (Root only)

Advanced parameters for operations, rate limiting, chat, drawing, and more.

Operations and cache ratios
Rate limits
Chat and drawing settings
Dashboard configuration

Custom OAuth (Root only)

Configure custom OAuth login providers.

Add an OAuth provider
Configure the client ID and secret
Test the OAuth callback

Performance monitoring (Root only)

View system performance metrics and runtime status.

System load overview
Channel response times
Setting up pprof and Pyroscope

Docs and About page (Root only)

Configure what the docs site and the About page display.

Custom docs links
About page information