查询生成用量日志

    查询当前 API Key 关联的生成用量记录。

    GET/api/v1/generations/logs
    字段
    Base URLhttps://api.gate.ai
    认证Authorization: Bearer <API_KEY>
    格式Gate.AI REST JSON
    限流每个 API Key 每秒 1 次请求

    支持按 trace_id 查询该 Trace 下的全部记录,或查询当前 API Key 最近 100 条记录。

    • 按 Trace 查询: 请求体包含合法 trace_id ,返回全部属于当前 API Key 且 Trace 精确匹配的记录,按 id DESC 排序。
    • 查询最近记录: 不发送请求体、发送空请求体或发送 {} ,返回当前 API Key 最近 100 条记录,按 created_at DESC, id DESC 排序。
    • Trace 不存在、日志尚未生成或不属于当前 API Key 时,返回 HTTP 200 和空数组。

    请求参数

    名称位置类型必选说明
    AuthorizationheaderstringAPI Key 鉴权,格式:Bearer <API_KEY>
    Content-Typeheaderstring固定为 application/json

    请求体

    名称类型必选说明
    trace_idstring精确查询指定 Trace,区分大小写,长度为 1~128 字符。

    示例:按 Trace 查询

    bash
    1curl -X POST 'https://api.gate.ai/api/v1/generations/logs' \2  -H 'Authorization: Bearer <API_KEY>' \3  -H 'Content-Type: application/json' \4  -d '{"trace_id":"Trace-AbC-123"}'

    示例:查询最近 100 条

    bash
    1curl -X POST 'https://api.gate.ai/api/v1/generations/logs' \2  -H 'Authorization: Bearer <API_KEY>' \3  -H 'Content-Type: application/json' \4  -d '{}'

    返回字段说明

    名称类型说明
    codeinteger业务状态码,成功固定为 200。
    msgstring状态描述,成功固定为 success。
    timestampstring服务端当前 Unix 秒时间戳。
    dataarray用量日志数组;无匹配记录时为[]。
    data[].idinteger用量记录 ID。
    data[].trace_idstring请求 Trace ID。
    data[].span_idstring请求 Span ID。
    data[].session_idstring会话 ID。
    data[].api_key_idstring产生该记录的 API Key ID。
    data[].user_idstring用户 ID。
    data[].appstring调用应用标识。
    data[].standard_modelstring标准模型名称。
    data[].usage_modelstring实际用于计量的模型名称。
    data[].streamboolean原请求是否使用流式响应。
    data[].response_statusinteger原请求 HTTP 响应状态码。
    data[].latencyinteger原请求耗时,单位为毫秒。
    data[].input_tokensinteger输入 Token 数。
    data[].output_tokensinteger输出 Token 数。
    data[].total_tokensintegerToken 总数。
    data[].cache_read_tokensinteger缓存读取 Token 数。
    data[].cache_write_tokensinteger缓存写入 Token 数。
    data[].input_tokens_detailsstring输入 Token 明细,保留存储时的字符串格式。
    data[].output_tokens_detailsstring输出 Token 明细,保留存储时的字符串格式。
    data[].input_coststring输入费用,十进制字符串。
    data[].output_coststring输出费用,十进制字符串。
    data[].cache_read_coststring缓存读取费用,十进制字符串。
    data[].cache_write_coststring缓存写入费用,十进制字符串。
    data[].total_coststring总费用,十进制字符串。
    data[].is_freeboolean本次调用是否由免费额度覆盖。
    data[].timestampstring用量发生时间,ISO 8601 UTC。
    data[].created_atstring记录创建时间,ISO 8601 UTC。
    data[].metadatastring调用扩展信息,保留存储时的字符串格式。

    返回示例

    json
    1{2  "code": 200,3  "msg": "success",4  "timestamp": "1784633852",5  "data": [6    {7      "id": 42,8      "trace_id": "Trace-AbC-123",9      "span_id": "span-001",10      "session_id": "session-001",11      "api_key_id": "1001",12      "user_id": "2002",13      "app": "example-client",14      "standard_model": "openai/gpt-5",15      "usage_model": "gpt-5",16      "stream": false,17      "response_status": 200,18      "latency": 842,19      "input_tokens": 120,20      "output_tokens": 80,21      "total_tokens": 200,22      "cache_read_tokens": 20,23      "cache_write_tokens": 0,24      "input_tokens_details": "{"cached_tokens":20}",25      "output_tokens_details": "{"reasoning_tokens":10}",26      "input_cost": "0.00120000",27      "output_cost": "0.00160000",28      "cache_read_cost": "0.00002000",29      "cache_write_cost": "0.00000000",30      "total_cost": "0.00282000",31      "is_free": false,32      "timestamp": "2026-07-21T08:30:00Z",33      "created_at": "2026-07-21T08:30:01Z",34      "metadata": "{"request_type":"audio"}"35    }36  ]37}

    无匹配记录

    json
    1{2  "code": 200,3  "msg": "success",4  "timestamp": "1784633852",5  "data": []6}

    返回结果

    状态码状态码含义说明数据模型
    200OK查询成功;无匹配记录时 data 为空数组。UsageLogResponse
    400Bad RequestJSON 请求体非法,或 trace_id 类型、长度不合法。ErrorResponse
    401UnauthorizedAPI Key 缺失、无效、过期、撤销、禁用或未激活。ErrorResponse
    403Forbidden预留给未来 API Key 权限策略。ErrorResponse
    429Too Many Requests同一 API Key 超过每秒 1 次请求;响应包含 Retry-After。ErrorResponse
    500Internal Server Error数据库查询失败或网关内部错误。ErrorResponse

    错误返回示例

    json
    1{2  "error": {3    "type": "invalid_request_error",4    "message": "invalid API key"5  }6}