如何查看您的 OpenAI API 密钥的余额和 Token 使用情况

如何查看您的 OpenAI API 密钥的余额和 Token 使用情况

引言

当您使用 OpenAI 提供的 API（例如 GPT-3、DALL-E 等）时，了解如何查看您的 API 密钥的余额和剩余的 Token 是非常重要的。这不仅有助于您监控当前的使用情况，还能帮助您有效地规划未来的开发和使用成本。本文将指导您如何查看 OpenAI API 密钥的余额和 Token 使用情况。

开始之前

在开始之前，您需要确保已经拥有一个有效的 OpenAI 账户，并已获得 API 密钥。此密钥是您访问 OpenAI 服务时必需的身份验证凭证。

查看 API 密钥的余额和 Token 使用情况

OpenAI 为开发者提供了多种方式来监控 API 使用情况，包括通过官方网站的用户仪表盘和编程方式查询。以下是步骤和方法：

1. 使用 OpenAI 控制台（官方网站）：

   • 登录账户：首先，登录到 OpenAI 的官方网站 (https://platform.openai.com)。
   • 访问仪表盘：登录后，点击导航栏上的“Usage”（使用情况），这里您可以看到所有 API 密钥的详细使用情况报告。
   • 查看余额和 Token 使用情况：在“Usage”页面，您可以找到关于您的 API 调用次数、消耗的 Token 数量以及费用的详细信息。这些信息通常按月统计，并且可以查看历史使用数据。

2. 通过 API 编程查询：

   • 设置 API 请求：您可以通过编程方式直接从 OpenAI 获取使用情况信息。这需要您使用已授权的 API 密钥发起 HTTP 请求。
   • 示例代码（使用 Python）：

   import requests
   
   # 设置你的API密钥
   api_key = "YOUR_CORRECT_API_KEY"  # 替换为正确的 API 密钥
   headers = {
       "Authorization": f"Bearer {api_key}"
   }
   
   # 指定日期
   date = "2024-05-07"  # 示例日期，应替换为需要查询的具体日期
   
   # 发送带有日期参数的请求
   response = requests.get(f"https://api.openai.com/v1/usage?date={date}", headers=headers)
   
   # 打印响应
   print(response.json())
   

未使用接口的返回

{'object': 'list', 'data': [], 'ft_data': [], 'dalle_api_data': [], 'whisper_api_data': [], 'tts_api_data': [], 'assistant_code_interpreter_data': [], 'retrieval_storage_data': []}

使用后的返回

这份报告包含了有关某个组织或个人账户的 API 使用详细信息。下面是对各个字段的解释，以及哪些信息可能敏感或不应随意共享：

1. organization_id: 组织的唯一标识符。这是一个敏感信息，可能不应公开，因为它可以与特定的账户或服务关联。
2. organization_name: 组织的名称，在这里是“Personal”，表示这可能是个人账户。这通常不是特别敏感的信息。
3. aggregation_timestamp: 数据聚合的时间戳。这通常是一个 UNIX 时间戳，显示数据统计的具体时间。这个信息一般不敏感。
4. n_requests: 在给定的时间段内对 API 的调用次数。这个信息一般不敏感。
5. operation: 执行的操作类型，这里是“completion”。这表示调用的是生成文本的操作，这个信息一般不敏感。
6. snapshot_id: 使用的模型的快照 ID，这里是“gpt-3.5-turbo-0125”。这通常不是敏感信息，但它显示了使用的具体模型版本。
7. n_context_tokens_total: 请求中的上下文令牌总数。这表示输入给模型的令牌数量，一般不敏感。
8. n_generated_tokens_total: 模型生成的令牌总数。这表示模型响应的令牌数量，一般不敏感。
9. email, api_key_id, api_key_name, api_key_redacted, api_key_type, project_id, project_name: 这些字段都为 None，意味着相关信息未被包含或公开。如果这些字段包含具体信息，如电子邮件地址、API 密钥详情等，则属于敏感信息，不应公开。

管理您的 API 使用

了解如何查看和管理您的 API 使用情况对于避免意外的高费用和确保服务的持续运行至关重要。OpenAI 提供了设置使用警告和限制的功能，这可以通过用户仪表盘进行配置。

总结

通过有效地监控和管理您的 OpenAI API 密钥的使用情况，您可以更好地控制成本并优化应用的性能。无论是通过 OpenAI 的用户仪表盘还是通过编程方式查询，了解您的当前使用状态都是确保您能够持续并有效利用 OpenAI 服务的关键。希望这篇指南能帮助您更好地理解和管理您的 API 资源。