Skip to content

6. Token Management (Token) ​

6.1 List All Tokens ​

Endpoint: GET /api/token/

Auth: User (returns only the caller's own tokens)

Query parameters:

ParameterTypeDescription
pintPage number, default 0
orderstringSort field

Response:

json
{
  "success": true,
  "message": "",
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "key": "sk-xxxxxxxx",
      "status": 1,
      "name": "my-token",
      "created_time": 1718000000,
      "accessed_time": 1718000000,
      "expired_time": -1,
      "remain_quota": 500000,
      "unlimited_quota": false,
      "used_quota": 100000,
      "models": null,
      "subnet": null,
      "updated_at": 1718000000
    }
  ]
}

Response fields:

FieldTypeDescription
idintToken ID
user_idintOwner user ID
keystringToken key
statusintStatus: 1=enabled, 2=disabled, 3=expired, 4=exhausted
namestringToken name
created_timeint64Created time
accessed_timeint64Last access time
expired_timeint64Expiration time, -1=never
remain_quotaint64Remaining quota
unlimited_quotaboolWhether quota is unlimited
used_quotaint64Quota consumed
modelsstring/nullAllowed models (comma separated), null=all
subnetstring/nullAllowed subnet

6.2 Search Tokens ​

Endpoint: GET /api/token/search

Auth: User

Query parameters:

ParameterTypeDescription
keywordstringSearch keyword

6.3 Get a Single Token ​

Endpoint: GET /api/token/:id

Auth: User

6.4 Create a Token ​

Endpoint: POST /api/token/

Auth: User

Request body:

json
{
  "name": "my-token",
  "remain_quota": 500000,
  "expired_time": -1,
  "unlimited_quota": false,
  "models": null,
  "subnet": null
}

6.5 Update a Token ​

Endpoint: PUT /api/token/

Auth: User

Same shape as create, plus the id field. When the query parameter status_only=1 is set, only the status field is updated.

6.6 Delete a Token ​

Endpoint: DELETE /api/token/:id

Auth: User