API Client Management
API Clients provide interfaces for external applications or users to call models on the Gendial platform. By creating an API client, you can generate API keys, control which models are accessible, and set usage quotas.
Overview
The API Client management entry is located in the Model API page under admin mode. This page contains two tabs:
- Aggregate Models: Manage exposed models (see Aggregate Models)
- API Clients: Manage calling credentials and quotas
Creating an API Client
In the API Clients tab, click the Create Client button.
Basic Information
- Client Name: Identifier for the client
- Description: Purpose of the client
- Type: Client category — Personal, Department, or Project
Model Scope
- All Aggregate Models: The client can access all created aggregate models
- Custom: Manually select which models the client can access
API Key
After creating a client, the system automatically generates an API Key. This key is used as a Bearer Token when calling APIs for authentication and usage tracking.
To regenerate the key, click the Reset Key button. Note that the old key becomes invalid immediately upon reset.
Setting Quotas
Setting a quota for a client limits its usage to prevent excessive consumption.
- Time Window: Quota reset cycle, e.g., every 24 hours
- Window Limit: Maximum token consumption within a single time window
- Allow Accumulation: Whether unused quota carries over to the next window
- Total Limit: Lifetime maximum token consumption for the client
- Validity Period: Start and end dates for the quota
Managing Clients
In the API Client list, you can view all clients' names, types, and model scopes. Tenant administrators can delete clients that are no longer needed.
Using the API Key
After obtaining an API key, external applications can call via the standard OpenAI-compatible interface by including the key in the request header:
Authorization: Bearer <API Key>For detailed API calling instructions, refer to OpenAI Compatible API.