切换语言

用法

使用情况 API 提供了有关您在 OpenAI API 中的活动的详细见解。它还包括一个单独的成本终端节点，可让您了解支出，按发票行项目和项目 ID 细分消费。source

虽然 Usage API 提供了精细的使用情况数据，但由于使用情况和支出的记录方式存在细微差异，它可能并不总是与 Costs 完全一致。出于财务目的，我们建议使用 Costs 端点或 Usage Dashboard 中的 Costs 选项卡，这将核对回您的账单发票。source

完成

获取 https://api.openai.com/v1/organization/usage/completions

获取组织的完成项使用情况详细信息。source

查询参数

start_time

整数source

必填

查询时间范围（含）的开始时间（Unix 秒）。source

end_time

整数source

可选

查询时间范围的结束时间（Unix 秒），不包括。source

bucket_width

字符串source

可选
默认为 1d

响应中每个时间桶的宽度。现在1m,1h和1d支持，默认为1d.source

project_ids

数组source

可选

仅返回这些项目的使用情况。source

user_ids

数组source

可选

仅返回这些用户的使用情况。source

api_key_ids

数组source

可选

仅返回这些 API 密钥的用法。source

模型

数组source

可选

仅返回这些模型的使用情况。source

Batch

布尔source

可选

如果true，仅返回批处理作业。如果false，仅返回非批处理作业。默认情况下，同时返回两者。source

group_by

数组source

可选

按指定字段对使用情况数据进行分组。支持字段包括project_id,user_id,api_key_id,model,batch或它们的任意组合。source

限制

整数source

可选

指定要返回的存储桶数。source

  • bucket_width=1d： 默认： 7， 最大： 31
  • bucket_width=1h： 默认： 24， 最大： 168
  • bucket_width=1m： 默认值： 60， 最大值： 1440
页

字符串source

可选

用于分页的游标。对应于next_page字段。source

返回

分页、时间分段的 Completions 使用对象的列表。source

示例请求
1
2
3
curl "https://api.openai.com/v1/organization/usage/completions?start_time=1730419200&limit=1" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.completions.result",
                    "input_tokens": 1000,
                    "output_tokens": 500,
                    "input_cached_tokens": 800,
                    "num_model_requests": 5,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null,
                    "batch": null
                }
            ]
        }
    ],
    "has_more": true,
    "next_page": "AAAAAGdGxdEiJdKOAAAAAGcqsYA="
}

Completions 使用对象

特定时间存储桶的聚合完成使用情况详细信息。source

对象

字符串source

input_tokens

整数source

使用的输入令牌的聚合数量。对于订阅 Scale Tier 的客户，这包括 Scale Tier 令牌。source

input_cached_tokens

整数source

从以前的请求中缓存的输入令牌的聚合数。对于订阅 Scale Tier 的客户，这包括 Scale Tier 令牌。source

output_tokens

整数source

使用的输出令牌的聚合数量。对于订阅 Scale Tier 的客户，这包括 Scale Tier 令牌。source

num_model_requests

整数source

对模型发出的请求计数。source

project_id

string 或 nullsource

什么时候group_by=project_id，此字段提供分组使用结果的项目 ID。source

user_id

string 或 nullsource

什么时候group_by=user_id，此字段提供分组使用结果的用户 ID。source

api_key_id

string 或 nullsource

什么时候group_by=api_key_id，此字段提供分组使用结果的 API 密钥 ID。source

MODEL

string 或 nullsource

什么时候group_by=model，则此字段提供分组使用结果的模型名称。source

Batch

boolean 或 nullsource

什么时候group_by=batch，此字段指示分组的使用结果是否为 batch。source

OBJECT Completions 使用对象
1
2
3
4
5
6
7
8
9
10
11
12
{
    "object": "organization.usage.completions.result",
    "input_tokens": 5000,
    "output_tokens": 1000,
    "input_cached_tokens": 4000,
    "num_model_requests": 5,
    "project_id": "proj_abc",
    "user_id": "user-abc",
    "api_key_id": "key_abc",
    "model": "gpt-4o-mini-2024-07-18",
    "batch": false
}

Embeddings

获取 https://api.openai.com/v1/organization/usage/embeddings

获取组织的嵌入使用情况详细信息。source

查询参数

start_time

整数source

必填

查询时间范围（含）的开始时间（Unix 秒）。source

end_time

整数source

可选

查询时间范围的结束时间（Unix 秒），不包括。source

bucket_width

字符串source

可选
默认为 1d

响应中每个时间桶的宽度。现在1m,1h和1d支持，默认为1d.source

project_ids

数组source

可选

仅返回这些项目的使用情况。source

user_ids

数组source

可选

仅返回这些用户的使用情况。source

api_key_ids

数组source

可选

仅返回这些 API 密钥的用法。source

模型

数组source

可选

仅返回这些模型的使用情况。source

group_by

数组source

可选

按指定字段对使用情况数据进行分组。支持字段包括project_id,user_id,api_key_id,model或它们的任意组合。source

限制

整数source

可选

指定要返回的存储桶数。source

  • bucket_width=1d： 默认： 7， 最大： 31
  • bucket_width=1h： 默认： 24， 最大： 168
  • bucket_width=1m： 默认值： 60， 最大值： 1440
页

字符串source

可选

用于分页的游标。对应于next_page字段。source

返回

分页、时间分段的 Embeddings 使用对象的列表。source

示例请求
1
2
3
curl "https://api.openai.com/v1/organization/usage/embeddings?start_time=1730419200&limit=1" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.embeddings.result",
                    "input_tokens": 16,
                    "num_model_requests": 2,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

Embeddings 使用对象

聚合的嵌入使用时间 Bucket 的使用情况详细信息。source

对象

字符串source

input_tokens

整数source

使用的输入令牌的聚合数量。source

num_model_requests

整数source

对模型发出的请求计数。source

project_id

string 或 nullsource

什么时候group_by=project_id，此字段提供分组使用结果的项目 ID。source

user_id

string 或 nullsource

什么时候group_by=user_id，此字段提供分组使用结果的用户 ID。source

api_key_id

string 或 nullsource

什么时候group_by=api_key_id，此字段提供分组使用结果的 API 密钥 ID。source

MODEL

string 或 nullsource

什么时候group_by=model，则此字段提供分组使用结果的模型名称。source

OBJECT 嵌入使用对象
1
2
3
4
5
6
7
8
9
{
    "object": "organization.usage.embeddings.result",
    "input_tokens": 20,
    "num_model_requests": 2,
    "project_id": "proj_abc",
    "user_id": "user-abc",
    "api_key_id": "key_abc",
    "model": "text-embedding-ada-002-v2"
}

审核

获取 https://api.openai.com/v1/organization/usage/moderations

获取组织的审核使用情况详细信息。source

查询参数

start_time

整数source

必填

查询时间范围（含）的开始时间（Unix 秒）。source

end_time

整数source

可选

查询时间范围的结束时间（Unix 秒），不包括。source

bucket_width

字符串source

可选
默认为 1d

响应中每个时间桶的宽度。现在1m,1h和1d支持，默认为1d.source

project_ids

数组source

可选

仅返回这些项目的使用情况。source

user_ids

数组source

可选

仅返回这些用户的使用情况。source

api_key_ids

数组source

可选

仅返回这些 API 密钥的用法。source

模型

数组source

可选

仅返回这些模型的使用情况。source

group_by

数组source

可选

按指定字段对使用情况数据进行分组。支持字段包括project_id,user_id,api_key_id,model或它们的任意组合。source

限制

整数source

可选

指定要返回的存储桶数。source

  • bucket_width=1d： 默认： 7， 最大： 31
  • bucket_width=1h： 默认： 24， 最大： 168
  • bucket_width=1m： 默认值： 60， 最大值： 1440
页

字符串source

可选

用于分页的游标。对应于next_page字段。source

返回

分页、时间分段的 Moderations 使用对象列表。source

示例请求
1
2
3
curl "https://api.openai.com/v1/organization/usage/moderations?start_time=1730419200&limit=1" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.moderations.result",
                    "input_tokens": 16,
                    "num_model_requests": 2,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

Moderations usage 对象

特定时间存储桶的聚合审核使用情况详细信息。source

对象

字符串source

input_tokens

整数source

使用的输入令牌的聚合数量。source

num_model_requests

整数source

对模型发出的请求计数。source

project_id

string 或 nullsource

什么时候group_by=project_id，此字段提供分组使用结果的项目 ID。source

user_id

string 或 nullsource

什么时候group_by=user_id，此字段提供分组使用结果的用户 ID。source

api_key_id

string 或 nullsource

什么时候group_by=api_key_id，此字段提供分组使用结果的 API 密钥 ID。source

MODEL

string 或 nullsource

什么时候group_by=model，则此字段提供分组使用结果的模型名称。source

OBJECT Moderations 使用对象
1
2
3
4
5
6
7
8
9
{
    "object": "organization.usage.moderations.result",
    "input_tokens": 20,
    "num_model_requests": 2,
    "project_id": "proj_abc",
    "user_id": "user-abc",
    "api_key_id": "key_abc",
    "model": "text-moderation"
}

图像

获取 https://api.openai.com/v1/organization/usage/images

获取组织的映像使用情况详细信息。source

查询参数

start_time

整数source

必填

查询时间范围（含）的开始时间（Unix 秒）。source

end_time

整数source

可选

查询时间范围的结束时间（Unix 秒），不包括。source

bucket_width

字符串source

可选
默认为 1d

响应中每个时间桶的宽度。现在1m,1h和1d支持，默认为1d.source

来源

数组source

可选

仅返回这些源的用法。可能的值为image.generation,image.edit,image.variation或它们的任意组合。source

大小

数组source

可选

仅返回这些图像大小的用法。可能的值为256x256,512x512,1024x1024,1792x1792,1024x1792或它们的任意组合。source

project_ids

数组source

可选

仅返回这些项目的使用情况。source

user_ids

数组source

可选

仅返回这些用户的使用情况。source

api_key_ids

数组source

可选

仅返回这些 API 密钥的用法。source

模型

数组source

可选

仅返回这些模型的使用情况。source

group_by

数组source

可选

按指定字段对使用情况数据进行分组。支持字段包括project_id,user_id,api_key_id,model,size,source或它们的任意组合。source

限制

整数source

可选

指定要返回的存储桶数。source

  • bucket_width=1d： 默认： 7， 最大： 31
  • bucket_width=1h： 默认： 24， 最大： 168
  • bucket_width=1m： 默认值： 60， 最大值： 1440
页

字符串source

可选

用于分页的游标。对应于next_page字段。source

返回

分页、时间分段的 Images 使用对象列表。source

示例请求
1
2
3
curl "https://api.openai.com/v1/organization/usage/images?start_time=1730419200&limit=1" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.images.result",
                    "images": 2,
                    "num_model_requests": 2,
                    "size": null,
                    "source": null,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

Images usage 对象

特定时间桶的聚合图像使用详情。source

对象

字符串source

图像

整数source

处理的图像数量。source

num_model_requests

整数source

对模型发出的请求计数。source

源

string 或 nullsource

什么时候group_by=source，此字段提供分组使用结果的来源，可能的值为image.generation,image.edit,image.variation.source

大小

string 或 nullsource

什么时候group_by=size，此字段提供分组使用结果的图像大小。source

project_id

string 或 nullsource

什么时候group_by=project_id，此字段提供分组使用结果的项目 ID。source

user_id

string 或 nullsource

什么时候group_by=user_id，此字段提供分组使用结果的用户 ID。source

api_key_id

string 或 nullsource

什么时候group_by=api_key_id，此字段提供分组使用结果的 API 密钥 ID。source

MODEL

string 或 nullsource

什么时候group_by=model，则此字段提供分组使用结果的模型名称。source

OBJECT 图像使用对象
1
2
3
4
5
6
7
8
9
10
11
{
    "object": "organization.usage.images.result",
    "images": 2,
    "num_model_requests": 2,
    "size": "1024x1024",
    "source": "image.generation",
    "project_id": "proj_abc",
    "user_id": "user-abc",
    "api_key_id": "key_abc",
    "model": "dall-e-3"
}

音频演讲

获取 https://api.openai.com/v1/organization/usage/audio_speeches

获取组织的音频语音使用详细信息。source

查询参数

start_time

整数source

必填

查询时间范围（含）的开始时间（Unix 秒）。source

end_time

整数source

可选

查询时间范围的结束时间（Unix 秒），不包括。source

bucket_width

字符串source

可选
默认为 1d

响应中每个时间桶的宽度。现在1m,1h和1d支持，默认为1d.source

project_ids

数组source

可选

仅返回这些项目的使用情况。source

user_ids

数组source

可选

仅返回这些用户的使用情况。source

api_key_ids

数组source

可选

仅返回这些 API 密钥的用法。source

模型

数组source

可选

仅返回这些模型的使用情况。source

group_by

数组source

可选

按指定字段对使用情况数据进行分组。支持字段包括project_id,user_id,api_key_id,model或它们的任意组合。source

限制

整数source

可选

指定要返回的存储桶数。source

  • bucket_width=1d： 默认： 7， 最大： 31
  • bucket_width=1h： 默认： 24， 最大： 168
  • bucket_width=1m： 默认值： 60， 最大值： 1440
页

字符串source

可选

用于分页的游标。对应于next_page字段。source

返回

分页、时间分段的 Audio speeches 使用对象列表。source

示例请求
1
2
3
curl "https://api.openai.com/v1/organization/usage/audio_speeches?start_time=1730419200&limit=1" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.audio_speeches.result",
                    "characters": 45,
                    "num_model_requests": 1,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

Audio speeches 使用对象

特定时间桶的聚合音频语音使用详细信息。source

对象

字符串source

字符

整数source

处理的字符数。source

num_model_requests

整数source

对模型发出的请求计数。source

project_id

string 或 nullsource

什么时候group_by=project_id，此字段提供分组使用结果的项目 ID。source

user_id

string 或 nullsource

什么时候group_by=user_id，此字段提供分组使用结果的用户 ID。source

api_key_id

string 或 nullsource

什么时候group_by=api_key_id，此字段提供分组使用结果的 API 密钥 ID。source

MODEL

string 或 nullsource

什么时候group_by=model，则此字段提供分组使用结果的模型名称。source

OBJECT Audio speeches usage 对象
1
2
3
4
5
6
7
8
9
{
    "object": "organization.usage.audio_speeches.result",
    "characters": 45,
    "num_model_requests": 1,
    "project_id": "proj_abc",
    "user_id": "user-abc",
    "api_key_id": "key_abc",
    "model": "tts-1"
}

音频转录

获取 https://api.openai.com/v1/organization/usage/audio_transcriptions

获取组织的音频转录使用情况详细信息。source

查询参数

start_time

整数source

必填

查询时间范围（含）的开始时间（Unix 秒）。source

end_time

整数source

可选

查询时间范围的结束时间（Unix 秒），不包括。source

bucket_width

字符串source

可选
默认为 1d

响应中每个时间桶的宽度。现在1m,1h和1d支持，默认为1d.source

project_ids

数组source

可选

仅返回这些项目的使用情况。source

user_ids

数组source

可选

仅返回这些用户的使用情况。source

api_key_ids

数组source

可选

仅返回这些 API 密钥的用法。source

模型

数组source

可选

仅返回这些模型的使用情况。source

group_by

数组source

可选

按指定字段对使用情况数据进行分组。支持字段包括project_id,user_id,api_key_id,model或它们的任意组合。source

限制

整数source

可选

指定要返回的存储桶数。source

  • bucket_width=1d： 默认： 7， 最大： 31
  • bucket_width=1h： 默认： 24， 最大： 168
  • bucket_width=1m： 默认值： 60， 最大值： 1440
页

字符串source

可选

用于分页的游标。对应于next_page字段。source

返回

分页、时间分段的音频转录使用对象列表。source

示例请求
1
2
3
curl "https://api.openai.com/v1/organization/usage/audio_transcriptions?start_time=1730419200&limit=1" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.audio_transcriptions.result",
                    "seconds": 20,
                    "num_model_requests": 1,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

Audio transcriptions usage 对象

特定时间存储桶的聚合音频转录使用情况详细信息。source

对象

字符串source

秒

整数source

处理的秒数。source

num_model_requests

整数source

对模型发出的请求计数。source

project_id

string 或 nullsource

什么时候group_by=project_id，此字段提供分组使用结果的项目 ID。source

user_id

string 或 nullsource

什么时候group_by=user_id，此字段提供分组使用结果的用户 ID。source

api_key_id

string 或 nullsource

什么时候group_by=api_key_id，此字段提供分组使用结果的 API 密钥 ID。source

MODEL

string 或 nullsource

什么时候group_by=model，则此字段提供分组使用结果的模型名称。source

OBJECT 音频转录使用对象
1
2
3
4
5
6
7
8
9
{
    "object": "organization.usage.audio_transcriptions.result",
    "seconds": 10,
    "num_model_requests": 1,
    "project_id": "proj_abc",
    "user_id": "user-abc",
    "api_key_id": "key_abc",
    "model": "tts-1"
}

矢量存储

获取 https://api.openai.com/v1/organization/usage/vector_stores

获取 vector 存储组织的使用情况详细信息。source

查询参数

start_time

整数source

必填

查询时间范围（含）的开始时间（Unix 秒）。source

end_time

整数source

可选

查询时间范围的结束时间（Unix 秒），不包括。source

bucket_width

字符串source

可选
默认为 1d

响应中每个时间桶的宽度。现在1m,1h和1d支持，默认为1d.source

project_ids

数组source

可选

仅返回这些项目的使用情况。source

group_by

数组source

可选

按指定字段对使用情况数据进行分组。支持字段包括project_id.source

限制

整数source

可选

指定要返回的存储桶数。source

  • bucket_width=1d： 默认： 7， 最大： 31
  • bucket_width=1h： 默认： 24， 最大： 168
  • bucket_width=1m： 默认值： 60， 最大值： 1440
页

字符串source

可选

用于分页的游标。对应于next_page字段。source

返回

分页、时间分段的 Vector 列表存储使用对象。source

示例请求
1
2
3
curl "https://api.openai.com/v1/organization/usage/vector_stores?start_time=1730419200&limit=1" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.vector_stores.result",
                    "usage_bytes": 1024,
                    "project_id": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

Vector 存储使用对象

聚合向量存储特定时间桶的使用情况详细信息。source

对象

字符串source

usage_bytes

整数source

向量以字节为单位存储使用情况。source

project_id

string 或 nullsource

什么时候group_by=project_id，此字段提供分组使用结果的项目 ID。source

OBJECT Vector 存储使用对象
1
2
3
4
5
{
    "object": "organization.usage.vector_stores.result",
    "usage_bytes": 1024,
    "project_id": "proj_abc"
}

代码解释器会话

获取 https://api.openai.com/v1/organization/usage/code_interpreter_sessions

获取组织的 Code Interpreter 会话使用详细信息。source

查询参数

start_time

整数source

必填

查询时间范围（含）的开始时间（Unix 秒）。source

end_time

整数source

可选

查询时间范围的结束时间（Unix 秒），不包括。source

bucket_width

字符串source

可选
默认为 1d

响应中每个时间桶的宽度。现在1m,1h和1d支持，默认为1d.source

project_ids

数组source

可选

仅返回这些项目的使用情况。source

group_by

数组source

可选

按指定字段对使用情况数据进行分组。支持字段包括project_id.source

限制

整数source

可选

指定要返回的存储桶数。source

  • bucket_width=1d： 默认： 7， 最大： 31
  • bucket_width=1h： 默认： 24， 最大： 168
  • bucket_width=1m： 默认值： 60， 最大值： 1440
页

字符串source

可选

用于分页的游标。对应于next_page字段。source

返回

分页、时间分段的 Code 解释器会话使用对象的列表。source

示例请求
1
2
3
curl "https://api.openai.com/v1/organization/usage/code_interpreter_sessions?start_time=1730419200&limit=1" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.code_interpreter_sessions.result",
                    "sessions": 1,
                    "project_id": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

代码解释器会话使用对象

特定时间存储桶的聚合代码解释器会话使用情况详细信息。source

对象

字符串source

会话

整数source

代码解释器会话数。source

project_id

string 或 nullsource

什么时候group_by=project_id，此字段提供分组使用结果的项目 ID。source

OBJECT 代码解释器会话使用对象
1
2
3
4
5
{
    "object": "organization.usage.code_interpreter_sessions.result",
    "sessions": 1,
    "project_id": "proj_abc"
}

成本

获取 https://api.openai.com/v1/organization/costs

获取组织的成本详细信息。source

查询参数

start_time

整数source

必填

查询时间范围（含）的开始时间（Unix 秒）。source

end_time

整数source

可选

查询时间范围的结束时间（Unix 秒），不包括。source

bucket_width

字符串source

可选
默认为 1d

响应中每个时间桶的宽度。目前仅1d支持，默认为1d.source

project_ids

数组source

可选

仅返回这些项目的成本。source

group_by

数组source

可选

按指定字段对成本进行分组。支持字段包括project_id,line_item以及它们的任意组合。source

限制

整数source

可选
默认为 7

要返回的存储桶数量限制。Limit 的范围可以介于 1 和 180 之间，默认值为 7。source

页

字符串source

可选

用于分页的游标。对应于next_page字段。source

返回

分页、时间分段的 Costs 对象列表。source

示例请求
1
2
3
curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.costs.result",
                    "amount": {
                        "value": 0.06,
                        "currency": "usd"
                    },
                    "line_item": null,
                    "project_id": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

costs 对象

特定时间桶的聚合成本详细信息。source

对象

字符串source

量

对象source

以关联货币表示的货币价值。source

line_item

string 或 nullsource

什么时候group_by=line_item中，此字段提供 grouped costs 结果的行项目。source

project_id

string 或 nullsource

什么时候group_by=project_id，则此字段提供已分组成本结果的项目 ID。source

OBJECT Costs 对象
1
2
3
4
5
6
7
8
9
{
    "object": "organization.costs.result",
    "amount": {
      "value": 0.06,
      "currency": "usd"
    },
    "line_item": "Image models",
    "project_id": "proj_abc"
}