Query API Key Details

Endpoint Path

GET /api/open/token/:id

Quota Calculation

Quota fields are internal units. Convert to CNY as follows:

Amount (¥) = quota ÷ quota_per_unit × usd_exchange_rate

Where:

• quota: from data.remain_quota (remaining) or data.used_quota (used); for monthly limits use data.monthly_quota_limit / data.current_month_used
• quota_per_unit, usd_exchange_rate, quota_display_type: from Query Conversion Parameters (GET /api/open/status)

If quota_display_type = USD, omit × usd_exchange_rate.

When unlimited_quota = true, token quota is unlimited; do not convert remain_quota as remaining balance.

Request Parameters

Field	Type	Required	Description	Constraints	Example
id	int	Yes	Token record ID	Positive integer	5001

Request Example

GET 'https://neolink.com/backend/api/open/token/5001'
GET 'https://neolink.com/backend/api/open/token/5002'

Return Information

Field	Type	Required	Description	Remarks
success	bool	Yes	Request success indicator	Fixed value
message	string	Yes	Error message (empty if successful)	Fixed value
data	Token	Yes	Single token object	See fields below

Token Object

Field	Type	Required	Description	Remarks
id	int	Yes	Token record ID	Database unique identifier
name	string	Yes	Token name	Custom name
key	string	Yes	Key display value	Only shows last 4 characters
status	int	Yes	Token status	1=Normal; 2=Disabled; 3=Expired; 4=Insufficient quota
created_time	int64	Yes	Creation time	Unix second timestamp
accessed_time	int64	No	Last access time	Unix second timestamp; 0 if never accessed
expired_time	int64	Yes	Expiration time	Unix second timestamp; -1=Never expires
remain_quota	int64	Yes	Remaining quota	Current available quota; see Quota Calculation above
used_quota	int64	Yes	Used quota	Consumed quota; see Quota Calculation above
unlimited_quota	bool	Yes	Unlimited quota flag	true=Unlimited; false=Limited
user_id	int	Yes	Owner user ID	Creator user ID
enterprise_id	int	Yes	Enterprise ID	Belonging enterprise
organization_id	int	Yes	Organization ID	Belonging department
busi_type	int	Yes	Business type	1=API; 2=Other
group	string	Yes	Primary group	Default group name
groups	[]string	Yes	Group array	All belonging groups
model_limits	string	Yes	Model restrictions	Comma-separated model list
model_limits_enabled	bool	Yes	Model limits enabled	true=Enabled; false=Disabled
allow_ips	string	Yes	IP whitelist	Comma-separated IPs or CIDR
monthly_quota_limit	int64	Yes	Monthly quota limit	Maximum monthly quota limit
current_month	int	Yes	Current month	Format YYYYMM
current_month_used	int64	Yes	Month used	Current month consumption
cross_group_retry	bool	Yes	Cross-group retry	true=Enabled; false=Disabled
created_by_member_id	int	Yes	Creator member ID	Enterprise creator member ID
member_display_name	string	Yes	Creator display name	Real name or nickname
member_username	string	Yes	Creator username	Login username
member_mobile_masked	string	Yes	Creator mobile (masked)	Only shows last 4 digits
creator_deleted	bool	Yes	Creator deleted flag	true=Deleted; false=Normal

Response Example

{
  "success": true,
  "message": "",
  "data": {
    "id": 5001,
    "name": "api-key-prod-1",
    "key": "sk-****a5b0",
    "status": 1,
    "created_time": 1711468800,
    "accessed_time": 1711584000,
    "expired_time": -1,
    "remain_quota": 1000000,
    "used_quota": 500000,
    "unlimited_quota": false
  }
}

Error response:

{
  "success": false,
  "message": "Token not found or deleted"
}