OpenAI API参考文档 | OpenAI开发文档|OpenAI中文官方文档|ChatGPT中文版|ChatGPT教程

项目 API 密钥

管理给定项目的 API 密钥。支持为用户列出和删除密钥。该接口不允许为用户发放密钥，因为用户需要自行授权才能生成密钥。source

列出项目 API 密钥

获取 https://api.openai.com/v1/organization/projects/{project_id}/api_keys

返回项目中的 API 密钥列表。source

路径参数

project_id

字符串source

必填

项目的 ID。source

查询参数

限制

整数source

可选

默认为 20

要返回的对象数量限制。Limit 的范围可以介于 1 和 100 之间，默认值为 20。source

后

字符串source

可选

用于分页的游标。after是定义您在列表中的位置的对象 ID。例如，如果您发出列表请求并收到 100 个对象，以 obj_foo 结尾，则您的后续调用可以包含 after=obj_foo 以便获取列表的下一页。source

ProjectApiKey 对象的列表。source

示例请求

1
2
3
curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20 \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json"

响应

{
    "object": "list",
    "data": [
        {
            "object": "organization.project.api_key",
            "redacted_value": "sk-abc...def",
            "name": "My API Key",
            "created_at": 1711471533,
            "id": "key_abc",
            "owner": {
                "type": "user",
                "user": {
                    "object": "organization.project.user",
                    "id": "user_abc",
                    "name": "First Last",
                    "email": "user@example.com",
                    "role": "owner",
                    "added_at": 1711471533
                }
            }
        }
    ],
    "first_id": "key_abc",
    "last_id": "key_xyz",
    "has_more": false
}

检索项目 API 密钥

获取 https://api.openai.com/v1/organization/projects/{project_id}/api_keys/{key_id}

检索项目中的 API 密钥。source

路径参数

project_id

字符串source

必填

项目的 ID。source

key_id

字符串source

必填

API 密钥的 ID。source

与指定 ID 匹配的 ProjectApiKey 对象。source

示例请求

1
2
3
curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys/key_abc \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json"

响应

{
    "object": "organization.project.api_key",
    "redacted_value": "sk-abc...def",
    "name": "My API Key",
    "created_at": 1711471533,
    "id": "key_abc",
    "owner": {
        "type": "user",
        "user": {
            "object": "organization.project.user",
            "id": "user_abc",
            "name": "First Last",
            "email": "user@example.com",
            "role": "owner",
            "added_at": 1711471533
        }
    }
}

删除项目 API 密钥

删除 https://api.openai.com/v1/organization/projects/{project_id}/api_keys/{key_id}

从项目中删除 API 密钥。source

路径参数

project_id

字符串source

必填

项目的 ID。source

key_id

字符串source

必填

API 密钥的 ID。source

确认密钥已删除，如果密钥属于服务账户，则显示错误source

示例请求

1
2
3
curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/api_keys/key_abc \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json"

响应

{
    "object": "organization.project.api_key.deleted",
    "id": "key_abc",
    "deleted": true
}

项目 API 密钥对象

表示项目中的单个 API 密钥。source

对象

字符串source

对象类型，始终为organization.project.api_keysource

redacted_value

字符串source

API 密钥的隐去值source

名字

字符串source

API 密钥的名称source

created_at

整数source

创建 API 密钥时的 Unix 时间戳（以秒为单位）source

身份证

字符串source

标识符，可在 API 端点中引用source

所有者

对象source

OBJECT 项目 API 密钥对象

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    "object": "organization.project.api_key",
    "redacted_value": "sk-abc...def",
    "name": "My API Key",
    "created_at": 1711471533,
    "id": "key_abc",
    "owner": {
        "type": "user",
        "user": {
            "object": "organization.project.user",
            "id": "user_abc",
            "name": "First Last",
            "email": "user@example.com",
            "role": "owner",
            "created_at": 1711471533
        }
    }
}