API Reference
List usage logs
List usage logs. Fields and permissions follow this gateway implementation.
Preview guide
Paste into an AI assistant to help with integration. Documentation and examples only; no real credentials.
Updated · Reviewed
Endpoint and authentication
GET https://api.tu-zi.com/api/log/self
Transport: json
- Use an account system token and New-Api-User (account ID), or a valid site login session.
- Manage system tokens in account settings. Inference API keys are not substitutes; keep system tokens out of frontend code.
Authorization: Bearer YOUR_SYSTEM_TOKEN
New-Api-User: YOUR_USER_ID
Before calling
- Examples use this site's address. For another gateway, replace only the site address and keep the full endpoint path.
- Python / JavaScript read
SYSTEM_TOKEN(account system token) andUSER_ID(account ID) from the environment. In cURL, replaceYOUR_SYSTEM_TOKENandYOUR_USER_ID.
Constraints
- The legacy GET /api/log/self/search always fails and is retired.
- Use the filters on this endpoint for log searches.
Confirming success
Check HTTP status, the business status in the body and the required result fields. Do not rely only on HTTP 200 or the script exit code.
- Require success=true and inspect data. Read configuration back through its retrieval endpoint after changing it.
- Empty lists may be valid but do not prove a specific resource exists.
Query parameters
| Field | Type | Required | Description / constraints |
|---|---|---|---|
| p | integer | No | Page number starting at 1. Example: 1 |
| page_size | integer | No | Page size up to 100; omitted uses the site setting. Example: 10 |
| type | integer | No | 0 all; 1 top-up, 2 usage, 3 management, 4 system, 5 referral, 6 error, 7 refund. |
| start_timestamp | integer | No | Start Unix timestamp in seconds. |
| end_timestamp | integer | No | End Unix timestamp in seconds. |
| token_name | string | No | Token-name filter. |
| model_name | string | No | Model-name filter. |
| group | string | No | Group filter. |
| request_id | string | No | Gateway request ID. |
| upstream_request_id | string | No | Upstream request ID. |
| request_path | string | No | Endpoint path; requires a bounded time range. Supply both bounds, no more than 90 days apart. |
| error_keyword | string | No | Error keyword; requires a bounded time range. Supply both bounds, no more than 90 days apart. |
Response fields
| Field | Type | Description / constraints |
|---|---|---|
| success | boolean | Business success; do not rely only on HTTP status. |
| message | string | Result or error message. |
| data.page | integer | Current page. |
| data.page_size | integer | Effective page size. |
| data.total | integer | Total records. |
| data.items | array | Records in the current page. |
| data.items[].id | integer | Log ID. |
| data.items[].created_at | integer | Unix seconds. |
| data.items[].model_name | string | Model name. |
| data.items[].quota | integer | Consumed quota in site units. |
| data.items[].prompt_tokens | integer | Input tokens. |
| data.items[].completion_tokens | integer | Output tokens. |
| data.items[].is_stream | boolean | Whether streaming. |
| data.items[].request_id | string | Request ID. |
| data.items[].other | string | JSON-encoded extra metadata; inspect fields before use. |
Illustrative response; some endpoints show essential fields only. Optional fields may be absent.
{
"success": true,
"message": "",
"data": {
"page": 1,
"page_size": 10,
"total": 0,
"items": []
}
}
Errors and retries
Check HTTP status and success. HTTP 200 alone does not guarantee success.
- Business validation: errors may return HTTP 200 with
{"success":false,"message":"..."}; some includeerror.code. - Authentication failures: may return 401/403.
- Rate limiting: may return 429.
- Use bounded exponential backoff for reads encountering transient errors; fix parameter, authentication, quota, or configuration failures first.
- Do not blindly retry task creation, generation, or key mutations, to avoid duplicate billing or execution.
兔子API