DataEyes AI — API Key & Quota Query API Reference

Document Version: v2.1
Last Updated: 2026-09-29
Document Status: Draft — authenticated API testing pending
Service Region: International

Overview

This reference covers API key retrieval, quota and usage queries, available models, user information, and subscriptions.

To retrieve a full API key, start with Section 3.2.

Service Addresses

Purpose	Address
Model calls and OpenAI-compatible queries	`https://platform.dataeyes.ai`
Key quota, user information, and subscription queries	`https://www.dataeyes.ai/apex`
Login and full key retrieval (Section 3.2)	`https://www.dataeyes.ai/api`

Each cURL example includes the full request URL.

Authentication Methods

Method 1: API Key Authentication

Use an API key for Sections I and II and for the SDK examples in Section VI:

Authorization: Bearer sk-xxxxxxxxxxxxxxxx

API keys are managed on the Tokens page.

Method 2: System Access Token Authentication

The user information and subscription queries in Sections 3.1 and 3.3 use a system access token and a numeric user 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 3.2 uses the login token returned by the account login request:

Authorization: Bearer <login_token>

The key retrieval examples do not require a numeric user ID or the apex-api-user header. Follow the three steps in Section 3.2 to obtain the login token and find the key ID.

Section I: OpenAI-Compatible Endpoints

These endpoints return billing and model data in OpenAI-compatible response formats.

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

1.1 Query Quota Limits

Retrieve quota limits using an 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	Compatibility field; returns `true`
`soft_limit_usd`	Number	Reported soft quota limit in USD
`hard_limit_usd`	Number	Reported hard quota limit in USD
`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

For an unlimited-quota key, the three limit fields return 100000000. This value represents an unlimited key quota, not an account balance of USD 100 million.

1.2 Query Cumulative Usage

Retrieve cumulative usage charges.

Endpoint

GET /v1/dashboard/billing/usage

Request Headers

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

Request Example

The start_date and end_date parameters do not filter the results. This endpoint returns cumulative usage.

Response Example

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

Response Fields

Field	Type	Description
`object`	String	Fixed value `"list"`
`total_usage`	Number	Cumulative usage charges in US cents. Divide by `100` to convert to USD: `601.41` cents = 6.01

1.3 List Available Models

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	Creation timestamp reported by the API, in Unix seconds
`data[].owned_by`	String	Owner or provider label reported by the API, such as `openai`, `vertex-ai`, or `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

Use this endpoint to query an API key's quota, usage, and model restrictions.

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

2.1 Query API Key Quota and Usage

Retrieve quota allocation, usage, remaining balance, and model restrictions for the API key used to authenticate the request.

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 the key's quota limit is disabled. This does not indicate an unlimited account balance
`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

When unlimited_quota is true, total_available may be negative. This means recorded usage exceeds the allocation; it does not by itself indicate that the key has reached a quota limit.

Section III: Account and API Key Queries

This section covers user information, full API key retrieval, and subscriptions. Use the address and authentication headers shown for each request.

3.1 Get User Information

Retrieve user account details using a system access token and user ID.

Endpoint

GET /api/user/self

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <system_access_token>`
`apex-api-user`	Yes	Numeric user ID associated with the system access token

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 Retrieve a Full API Key

Have your account, login password, and key name ready.

Replace the placeholders in angle brackets with your own values. Do not include the brackets.

Step	Request	Value to use next
1. Log in	`POST /api/client/login`	`data.token`: login token
2. Find the key ID	`GET /api/apex/api/token/search`	`data.items[].id`: key ID
3. Retrieve the full key	`POST /api/apex/api/token/{id}/reveal`	Full key returned by the reveal request

Full key viewing is a one-time operation in the current international console. Save the key when it is returned. Logging in again does not restore a used viewing opportunity.

If your account has no login password, set one through the website's account settings or password recovery before using the password login example.

Step 1: Log In

Endpoint

POST https://www.dataeyes.ai/api/client/login

Request Headers

Header	Required	Description
`Content-Type`	Yes	`application/json`

Request Body

Parameter	Type	Required	Description
`account`	String	Yes	Email address or phone number used to log in to the international website. For a phone number, use the same country code as on the login page and omit spaces
`password`	String	Yes	Current login password

cURL Example

Success Response Example (Excerpt)

{
  "code": 0,
  "data": {
    "token": "<login_token>"
  },
  "msg": ""
}

Response Fields

Field	Type	Description
`code`	Integer	`0` indicates a successful login
`data.token`	String	Login token for the following requests
`msg`	String	Response message

When code is 0, copy the complete data.token value without the surrounding quotation marks. You do not need to copy the other account information.

Step 2: Find the Key ID

Search using the key's name. You do not need to know its numeric ID in advance.

Endpoint

GET https://www.dataeyes.ai/api/apex/api/token/search

Request Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <login_token>`, using `data.token` from Step 1

Query Parameters

Parameter	Type	Required	Description
`keyword`	String	Yes, for this name-search example	Name of the key to retrieve
`p`	Integer	No	Page number, starting at `1`; this example uses `1`
`size`	Integer	No	Items per page; this example uses `20`

cURL Example

Replace <key_name> with your key's name, for example default.

If you do not know the name, list the keys first:

Success Response Example (Excerpt)

{
  "success": true,
  "message": "",
  "data": {
    "page": 1,
    "page_size": 20,
    "total": 1,
    "items": [
      {
        "id": 12345,
        "name": "default"
      }
    ]
  }
}

Response Fields

Field	Type	Description
`success`	Boolean	`true` indicates a successful query
`message`	String	Response message
`data.page`	Integer	Current page number
`data.page_size`	Integer	Items per page
`data.total`	Integer	Number of matching keys
`data.items[].id`	Integer	Key ID to include in the URL in Step 3
`data.items[].name`	String	Key name

Find the matching record and use its id in Step 3. In this example, default has ID 12345; replace it with the ID returned for your own key.

If more than one record has the same name, check its creation time and configuration before proceeding. Increase p to read another page. An empty data.items array means there are no records on that page.

The key value in a list or search result is not the full key. Use Step 3 to retrieve the full value.

Additional Key Fields

The list and search responses may also contain the following fields. They are not required for the Step 3 request.

Field in `data.items[]`	Type	Description
`user_id`	Integer	Key owner's numeric user ID
`key`	String	Masked key value; do not use it for model calls
`viewed`	Boolean	Whether the one-time viewing opportunity has been used
`status`	Integer	`1` = enabled, `2` = disabled, `3` = expired, `4` = quota exhausted
`created_time`	Integer	Creation time, as a Unix timestamp in seconds
`accessed_time`	Integer	Last access time, as a Unix timestamp in seconds
`expired_time`	Integer	Expiration time, as a Unix timestamp in seconds; `-1` means no expiration
`remain_quota`	Integer	Remaining key quota in internal units
`unlimited_quota`	Boolean	Whether the key's quota limit is disabled
`used_quota`	Integer	Consumed quota in internal units
`model_limits_enabled`	Boolean	Whether the key's model restrictions are enabled
`model_limits`	String	Configured model restrictions
`allow_ips`	String	Configured allowed IP addresses; empty means no key-level IP restriction
`group`	String	Key's configured group
`cross_group_retry`	Boolean	Whether cross-group retry is enabled

Step 3: Retrieve the Full Key

This request uses the login token from Step 1 and the key ID from Step 2. It does not submit the login password again.

Endpoint

POST https://www.dataeyes.ai/api/apex/api/token/{id}/reveal

Path Parameters

Parameter	Type	Required	Description
`id`	Integer	Yes	Key ID returned in Step 2

Request Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <login_token>`, using `data.token` from Step 1

No request body is required.

cURL Example

Replace 12345 in the URL with the key ID from Step 2. Call this endpoint only when you are ready to save the returned key.

Response Fields

Field	Type	Description
`success`	Boolean	`true` indicates a successful reveal
`message`	String	Response message; `token.already_viewed` indicates that the viewing opportunity has already been used
`data`	To be verified	Full key response; its exact structure must be confirmed by an authenticated test

Before publication: Verify the successful response structure and whether the returned key includes sk-, then add the response example and the exact field to copy.

If the response indicates that the key has already been viewed, use the full key you previously saved. Key rotation creates a replacement credential; it is not a way to retrieve the same key again.

Do not retry a reveal request automatically after a timeout: the server may have completed the one-time operation even if the response did not reach you. Do not write passwords, login tokens, or full keys to logs or source control.

3.3 Get Subscription Information

Retrieve subscription details using a system access token and user ID.

Endpoint

GET /api/subscription/self

Request Headers

Name	Required	Description
`Authorization`	Yes	`Bearer <system_access_token>`
`apex-api-user`	Yes	Numeric user ID associated with the system access token

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

Task	Section	Authentication
Query quota limits	1.1	API key
Query cumulative usage charges	1.2	API key
List available models	1.3	API key
Query a key's quota and usage in internal units	2.1	API key
Query user information	3.1	System access token and numeric user ID
Retrieve a full API key	3.2	Account password for login, then login token
Query subscriptions	3.3	System access token and numeric user ID

Section V: Error Code Reference

HTTP 200 does not always mean the request succeeded. Check the response body as well:

Request	Success condition
Login	`code` is the integer `0` and `data.token` is present
Key quota and usage (Section 2.1)	`code` is the boolean `true`
User information, key search/list/reveal, and subscriptions	`success` is `true`; also check the returned data
OpenAI-compatible queries	HTTP 2xx, the expected response fields, and no `error` object

Error messages may be localized. Use the status fields to detect failures and read msg, message, or error.message for details.

Scenario	Response	What to check
Missing API key	HTTP 401	Include `Authorization: Bearer <API-Key>`
Login parameters rejected	Nonzero `code`, with details in `msg`	Check the account format and current login password
Login requires browser verification	Login response requests additional verification	Complete verification on the website; do not repeatedly submit the same cURL request
Login token missing or expired	`code: 401`, with details in `msg`	Log in again and use the new `data.token` in the request header
System-token authentication failed	`code: 401`, with details in `msg`	Check the system access token and its associated numeric user ID
Search returns no records	`success: true` and an empty result	Check the key name and page number, or use the list request in Step 2
Key has already been viewed	`message: "token.already_viewed"`	Use the full key you previously saved; logging in again does not reset the viewing opportunity
Key retrieval failed	Failure status and a message	Check the login token, key ID, and error message before taking further action
Request URL or method is incorrect	HTTP 404	Compare the method and full URL with the cURL example
Group permission denied	Message identifies a group permission problem	Check the key's configured group and available models

Section VI: SDK Integration Examples

Replace the sample API key with your full key. Set model to an ID returned by /v1/models for that key.

Python (OpenAI SDK)

JavaScript / TypeScript (OpenAI SDK)

Section VII: Best Practices

Cache quota query results for 30–60 seconds when that delay is acceptable for your application.

Retry read-only queries with a delay after temporary network failures. Do not automatically retry the one-time key reveal request.

Use separate keys for applications that need separate usage tracking.

For keys with unlimited_quota set to false, trigger an alert when total_available falls below your threshold.

Store API keys securely. Do not include passwords, login tokens, or full keys in application logs or source control.

Change History

Version	Date	Changes
v2.1 draft	2026-09-29	Reorganized full key retrieval; updated authentication, error handling, and wording. Authenticated API testing is pending

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#

Method 3: Login Token Authentication#

Section I: OpenAI-Compatible Endpoints#

1.1 Query Quota Limits#

1.2 Query Cumulative Usage#

1.3 List Available Models#

Section II: Platform-Specific Endpoints#

2.1 Query API Key Quota and Usage#

Section III: Account and API Key Queries#

3.1 Get User Information#

3.2 Retrieve a Full API Key#

Step 1: Log In#

Step 2: Find the Key ID#

Step 3: Retrieve the Full Key#

3.3 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)#

Section VII: Best Practices#

Change History#

DataEyes AI — API Key & Quota Query API Reference

Overview

Service Addresses

Authentication Methods

Method 1: API Key Authentication

Method 2: System Access Token Authentication

Method 3: Login Token Authentication

Section I: OpenAI-Compatible Endpoints

1.1 Query Quota Limits

1.2 Query Cumulative Usage

1.3 List Available Models

Section II: Platform-Specific Endpoints

2.1 Query API Key Quota and Usage

Section III: Account and API Key Queries

3.1 Get User Information

3.2 Retrieve a Full API Key

Step 1: Log In

Step 2: Find the Key ID

Step 3: Retrieve the Full Key

3.3 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)

Section VII: Best Practices

Change History