DataEyes AI — API Key & Quota Query API Reference

Document Version: v2.0
Last Updated: 2026-06-01
Document Status: Production Verified
Service Region: International

Overview

DataEyesAI Cloud provides a unified AI API gateway service, aggregating 100+ world-leading large models (OpenAI GPT, Anthropic Claude, Google Gemini, DeepSeek, Doubao, etc.) with OpenAI-compatible protocol access. This document provides detailed specifications for all API endpoints related to key status queries, quota management, usage statistics, and account administration.

Service Addresses

Purpose	Address
AI Model Calls & OpenAI-Compatible Endpoints	`https://platform.dataeyes.ai`
Platform Management Endpoints	`https://www.dataeyes.ai/apex`

Important: OpenAI-compatible endpoints prefixed with /v1/ use the platform address; management endpoints prefixed with /api/ use the management proxy address. Do not mix these.

Authentication Methods

Method 1: API Key Authentication

For model calls and self-service quota queries. Pass the API Key via standard HTTP header:

Authorization: Bearer sk-xxxxxxxxxxxxxxxx

API Keys can be created and managed in the platform console under "Token Management".

Method 2: System Access Token Authentication

For administrative operations (user information queries, token management, etc.). Requires both a system access token and the target user's numeric ID:

Authorization: Bearer <system_access_token>
apex-api-user: <user_numeric_id>

The system access token can be found in the console under "Personal Settings > Account Management > Security Settings". The user numeric ID must be obtained from a backend administrator.

Section I: OpenAI-Compatible Endpoints

Fully compatible with OpenAI billing query specifications, supporting seamless integration with any OpenAI SDK or compatible client.

Base Address: https://platform.dataeyes.ai

1.1 Query Account Quota

Retrieve the quota limits for the account associated with the current API Key.

Endpoint

GET /v1/dashboard/billing/subscription

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <API-Key>`

Request Example

Response Example

{
  "object": "billing_subscription",
  "has_payment_method": true,
  "soft_limit_usd": 100000000,
  "hard_limit_usd": 100000000,
  "system_hard_limit_usd": 100000000,
  "access_until": 0
}

Response Fields

Field	Type	Description
`object`	String	Fixed value `"billing_subscription"`
`has_payment_method`	Boolean	Whether a payment method is bound; always `true`
`soft_limit_usd`	Number	Soft quota limit (USD) — triggers a warning notification when reached
`hard_limit_usd`	Number	Hard quota limit (USD) — service is suspended when reached
`system_hard_limit_usd`	Number	System-level hard limit, identical to `hard_limit_usd`
`access_until`	Integer	Subscription expiration time (Unix timestamp); `0` means never expires

Unlimited Quota: When an API Key is configured with unlimited quota, all three limit fields return 100000000 (100 million USD), indicating no quota restrictions.

1.2 Query Cumulative Usage

Retrieve the cumulative spending amount for the current API Key.

Endpoint

GET /v1/dashboard/billing/usage

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <API-Key>`

Request Example

The start_date and end_date query parameters are OpenAI-compatible reserved fields. The current version returns total cumulative usage and does not filter by date range.

Response Example

{
  "object": "list",
  "total_usage": 601.41
}

Response Fields

Field	Type	Description
`object`	String	Fixed value `"list"`
`total_usage`	Number	Cumulative usage in cents (USD × 100). For example, `601.41` represents $6.01 spent

1.3 Query Available Model List

Retrieve all models accessible by the current API Key.

Endpoint

GET /v1/models

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <API-Key>`

Request Example

Response Example

{
  "data": [
    {
      "id": "gpt-4o",
      "object": "model",
      "created": 1626777600,
      "owned_by": "openai",
      "supported_endpoint_types": ["openai"]
    },
    {
      "id": "claude-opus-4-6",
      "object": "model",
      "created": 1626777600,
      "owned_by": "vertex-ai",
      "supported_endpoint_types": ["openai", "anthropic"]
    },
    {
      "id": "gemini-2.5-pro-thinking",
      "object": "model",
      "created": 1626777600,
      "owned_by": "custom",
      "supported_endpoint_types": ["openai", "gemini"]
    }
  ],
  "object": "list",
  "success": true
}

Response Fields

Field	Type	Description
`data`	Array	Model list
`data[].id`	String	Model identifier — use this value when making API calls
`data[].object`	String	Fixed value `"model"`
`data[].created`	Integer	Model creation time (Unix timestamp)
`data[].owned_by`	String	Model provider (e.g., `openai`, `vertex-ai`, `xai`, `custom`)
`data[].supported_endpoint_types`	Array	Supported calling formats: `openai`, `anthropic`, `gemini`, `image-generation`, `embeddings`, `rerank`, etc.
`object`	String	Fixed value `"list"`
`success`	Boolean	Whether the request succeeded

Section II: Platform-Specific Endpoints

DataEyesAI platform-specific high-precision query endpoints that provide exact quota, usage, and permission details for individual API Keys. These endpoints are not restricted by group permissions — any valid API Key can call them.

Base Address: https://www.dataeyes.ai/apex

2.1 API Key Real-Time Status Query

Precisely retrieve the current API Key's quota allocation, consumption, remaining balance, and model permission information.

Endpoint

GET /api/usage/token/

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <API-Key>`

Request Example

Response Example (Limited Quota)

{
  "code": true,
  "message": "ok",
  "data": {
    "object": "token_usage",
    "name": "my-production-key",
    "total_granted": 5000000,
    "total_used": 20,
    "total_available": 4999980,
    "unlimited_quota": false,
    "model_limits": {},
    "model_limits_enabled": false,
    "expires_at": 0
  }
}

Response Example (Unlimited Quota)

{
  "code": true,
  "message": "ok",
  "data": {
    "object": "token_usage",
    "name": "default-key",
    "total_granted": 500000,
    "total_used": 3007043,
    "total_available": -2507043,
    "unlimited_quota": true,
    "model_limits": {},
    "model_limits_enabled": false,
    "expires_at": 0
  }
}

Response Fields

Field	Type	Description
`code`	Boolean	Whether the request succeeded; `true` indicates success
`message`	String	Status description; `"ok"` on success
`data.object`	String	Fixed value `"token_usage"`
`data.name`	String	API Key display name
`data.total_granted`	Integer	Total allocated quota (internal units). Conversion: `÷ 500,000 = USD`
`data.total_used`	Integer	Cumulative consumed quota (internal units)
`data.total_available`	Integer	Remaining available quota (`total_granted − total_used`)
`data.unlimited_quota`	Boolean	Whether this is an unlimited quota key. When `true`, quota limits do not apply
`data.model_limits`	Object	Model access restriction rules. Empty object `{}` means no restrictions
`data.model_limits_enabled`	Boolean	Whether model-level access control is enabled
`data.expires_at`	Integer	Key expiration time (Unix timestamp); `0` means never expires

Quota Conversion Formula

USD Amount = Internal Quota Value ÷ 500,000

Internal Quota Value	Equivalent USD	Calculation
`5,000,000`	$10.00	5000000 ÷ 500000 = 10
`3,007,043`	$6.01	3007043 ÷ 500000 ≈ 6.01
`500,000`	$1.00	500000 ÷ 500000 = 1

Unlimited Quota Note: When unlimited_quota = true, total_available may be negative, reflecting only that cumulative consumption exceeds the initial allocation — this does not affect service availability.

Section III: Console Management Endpoints

The following endpoints serve platform administration scenarios, supporting programmatic management of user accounts, API Key lifecycle, and subscription information.

Base Address: https://www.dataeyes.ai/apex

Authentication: System Access Token + User Numeric ID (see "Method 2" above)

3.1 Get User Information

Retrieve account details for a specified user.

Endpoint

GET /api/user/self

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <system_access_token>`
`apex-api-user`	Yes	Target user's numeric ID

Request Example

Response Example

{
  "success": true,
  "message": "",
  "data": {
    "id": 669,
    "username": "example_user",
    "display_name": "example_user",
    "email": "user@example.com",
    "role": 1,
    "status": 1,
    "group": "pro",
    "quota": 4084864,
    "used_quota": 269527941,
    "request_count": 9412,
    "aff_code": "xxxx",
    "aff_count": 0,
    "aff_quota": 0,
    "aff_history_quota": 0,
    "inviter_id": 0
  }
}

Response Fields (data object)

Field	Type	Description
`id`	Integer	User numeric ID
`username`	String	Login username
`display_name`	String	Display name
`email`	String	Registered email address
`role`	Integer	User role. `1` = Regular user, `10` = Administrator, `100` = Super administrator
`status`	Integer	Account status. `1` = Active, `2` = Disabled
`group`	String	User's billing group
`quota`	Integer	Account-level remaining quota (internal units, ÷500000 = USD)
`used_quota`	Integer	Account-level total consumed quota
`request_count`	Integer	Cumulative API request count
`aff_code`	String	Referral code
`aff_count`	Integer	Number of referred users
`aff_quota`	Integer	Pending referral reward quota
`aff_history_quota`	Integer	Historical cumulative referral rewards
`inviter_id`	Integer	Inviter's user ID; `0` means no inviter

3.2 Get API Key List

Retrieve all API Keys for a specified user, with pagination support.

Endpoint

GET /api/token/

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <system_access_token>`
`apex-api-user`	Yes	Target user's numeric ID

Query Parameters

Parameter	Type	Default	Description
`p`	Integer	`1`	Page number
`size`	Integer	`10`	Items per page

Request Example

Response Example

{
  "success": true,
  "message": "",
  "data": {
    "page": 1,
    "page_size": 10,
    "total": 56,
    "items": [
      {
        "id": 11848,
        "user_id": 669,
        "key": "0jCu7MEFsd6jzr...",
        "status": 1,
        "name": "openai-vip-pro",
        "created_time": 1778838568,
        "accessed_time": 1779028792,
        "expired_time": -1,
        "remain_quota": -1279,
        "unlimited_quota": true,
        "model_limits_enabled": false,
        "model_limits": "",
        "allow_ips": "",
        "used_quota": 1279,
        "group": "gpt-vip-pro",
        "cross_group_retry": false
      }
    ]
  }
}

Response Fields (data.items[])

Field	Type	Description
`id`	Integer	API Key numeric ID
`user_id`	Integer	Owner's user ID
`key`	String	Key value (without `sk-` prefix)
`status`	Integer	Key status. `1` = Active, `2` = Disabled, `3` = Expired
`name`	String	Key display name
`created_time`	Integer	Creation time (Unix timestamp)
`accessed_time`	Integer	Last access time (Unix timestamp)
`expired_time`	Integer	Expiration time (Unix timestamp); `-1` = Never expires
`remain_quota`	Integer	Remaining quota (internal units)
`unlimited_quota`	Boolean	Whether quota is unlimited
`model_limits_enabled`	Boolean	Whether model access control is enabled
`model_limits`	String	Model restriction rules (JSON string; empty = no restrictions)
`allow_ips`	String	IP whitelist (comma-separated; empty = no restrictions)
`used_quota`	Integer	Consumed quota (internal units)
`group`	String	Key's billing group
`cross_group_retry`	Boolean	Whether cross-group retry is enabled

Pagination Fields

Field	Type	Description
`data.page`	Integer	Current page number
`data.page_size`	Integer	Items per page
`data.total`	Integer	Total count

3.3 Get Specific API Key Details

Retrieve complete details for an API Key by its numeric ID.

Endpoint

GET /api/token/{id}

Path Parameters

Parameter	Type	Description
`id`	Integer	API Key's numeric ID

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <system_access_token>`
`apex-api-user`	Yes	Target user's numeric ID

Request Example

Response Example

{
  "success": true,
  "message": "",
  "data": {
    "id": 11527,
    "user_id": 669,
    "key": "2UWqFGoE2AM2FY...",
    "status": 1,
    "name": "cl-of",
    "created_time": 1778739907,
    "accessed_time": 1779454195,
    "expired_time": -1,
    "remain_quota": -36107,
    "unlimited_quota": true,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": "",
    "used_quota": 36107,
    "group": "cl-of-pro",
    "cross_group_retry": false
  }
}

Response fields are identical to Section 3.2 items[].

3.4 Search API Keys

Search for API Keys by exact name match.

Endpoint

GET /api/token/search

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <system_access_token>`
`apex-api-user`	Yes	Target user's numeric ID

Query Parameters

Parameter	Type	Required	Description
`keyword`	String	Yes	Search keyword. Must exactly match the Key's display name

Request Example

Response Example

{
  "success": true,
  "message": "",
  "data": {
    "page": 1,
    "page_size": 10,
    "total": 1,
    "items": [
      {
        "id": 11848,
        "user_id": 669,
        "key": "0jCu7MEFsd6jzr...",
        "status": 1,
        "name": "openai-vip-pro",
        "unlimited_quota": true,
        "used_quota": 1279,
        "group": "gpt-vip-pro"
      }
    ]
  }
}

Important: This endpoint performs exact full-name matching and does not support fuzzy search. The keyword parameter must exactly match the Key's complete display name.

3.5 Get Subscription Information

Retrieve subscription details for a specified user.

Endpoint

GET /api/subscription/self

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <system_access_token>`
`apex-api-user`	Yes	Target user's numeric ID

Request Example

Response Example

{
  "success": true,
  "message": "",
  "data": {
    "subscriptions": [],
    "all_subscriptions": [],
    "billing_preference": "subscription_first"
  }
}

Response Fields

Field	Type	Description
`data.subscriptions`	Array	Currently active subscription plans
`data.all_subscriptions`	Array	All subscription plans (including expired)
`data.billing_preference`	String	Billing priority. `"subscription_first"` = prioritize subscription quota

Section IV: Endpoint Selection Guide

Endpoint	Authentication	Use Case	Data Granularity
`/v1/dashboard/billing/subscription`	API Key	Third-party client integration — view account quota	Account-level
`/v1/dashboard/billing/usage`	API Key	Third-party client integration — view cumulative spending	Account-level
`/v1/models`	API Key	Query models accessible by the Key	Account-level
`/api/usage/token/`	API Key	Production real-time validation of per-Key quota and model permissions	Key-level
`/api/user/self`	System Token	Admin console — user information management	User-level
`/api/token/`	System Token	Admin console — Key listing and lifecycle management	Key-level
`/api/token/{id}`	System Token	Admin console — individual Key detail view	Key-level
`/api/token/search`	System Token	Admin console — Key name search	Key-level
`/api/subscription/self`	System Token	Admin console — subscription management	User-level

Recommended Approaches:

User Self-Service Queries: Use /v1/dashboard/billing/subscription + /v1/dashboard/billing/usage — OpenAI-compatible with zero integration effort

Production Quota Monitoring: Use /api/usage/token/ — highest precision, not restricted by group permissions

Backend Management System Integration: Use system token-authenticated management endpoints for programmatic operations

Section V: Error Code Reference

Scenario	Response Content	Cause	Resolution
Invalid API Key	HTTP 401 `Unauthorized`	Key is invalid, expired, or disabled	Verify Key status in the console or create a new one
Invalid System Token	`{"code":401,"msg":"Not logged in or session expired"}`	System access token is incorrect or expired	Re-obtain from "Personal Settings > Account Management > Security Settings"
Invalid User ID	`{"code":401,"msg":"Not logged in or session expired"}`	`apex-api-user` value does not match a valid user	Use the correct user numeric ID
Incorrect Path	HTTP 404 `page not found`	Platform and management proxy addresses were mixed	Use `platform.dataeyes.ai` for `/v1` endpoints, `www.dataeyes.ai/apex` for `/api` endpoints
Group Permission Denied	`No permission to access xxx group`	API Key's group is not authorized	Contact administrator to adjust group configuration, or use `/api/usage/token/` instead
Search Failed	`{"success":false,"message":"Token search failed"}`	`keyword` parameter contains special characters or encoding issues	Use ASCII characters and ensure exact match with Key name

Section VI: SDK Integration Examples

Python (OpenAI SDK)

JavaScript / TypeScript (OpenAI SDK)

cURL Quick Verification

Section VII: Best Practices

Cache Results: Quota query results can be cached for 30–60 seconds to reduce API load

Polling Frequency: Production monitoring should not exceed 1 query per minute

Error Retry: Implement exponential backoff retry for transient failures

Key Isolation: Use separate Keys for different business functions to enable independent consumption monitoring

Quota Alerts: Trigger alert notifications when total_available falls below a threshold

Search Limitations: /api/token/search only supports exact full-name matching; for fuzzy search, use the list endpoint with pagination

API Key & Quota Query API

DataEyes AI — API Key & Quota Query API Reference#

Overview#

Service Addresses#

Authentication Methods#

Method 1: API Key Authentication#

Method 2: System Access Token Authentication#

Section I: OpenAI-Compatible Endpoints#

1.1 Query Account Quota#

1.2 Query Cumulative Usage#

1.3 Query Available Model List#

Section II: Platform-Specific Endpoints#

2.1 API Key Real-Time Status Query#

Section III: Console Management Endpoints#

3.1 Get User Information#

3.2 Get API Key List#

3.3 Get Specific API Key Details#

3.4 Search API Keys#

3.5 Get Subscription Information#

Section IV: Endpoint Selection Guide#

Section V: Error Code Reference#

Section VI: SDK Integration Examples#

Python (OpenAI SDK)#

JavaScript / TypeScript (OpenAI SDK)#

cURL Quick Verification#

Section VII: Best Practices#

DataEyes AI — API Key & Quota Query API Reference

Overview

Service Addresses

Authentication Methods

Method 1: API Key Authentication

Method 2: System Access Token Authentication

Section I: OpenAI-Compatible Endpoints

1.1 Query Account Quota

1.2 Query Cumulative Usage

1.3 Query Available Model List

Section II: Platform-Specific Endpoints

2.1 API Key Real-Time Status Query

Section III: Console Management Endpoints

3.1 Get User Information

3.2 Get API Key List

3.3 Get Specific API Key Details

3.4 Search API Keys

3.5 Get Subscription Information

Section IV: Endpoint Selection Guide

Section V: Error Code Reference

Section VI: SDK Integration Examples

Python (OpenAI SDK)

JavaScript / TypeScript (OpenAI SDK)

cURL Quick Verification

Section VII: Best Practices