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

Project 服务帐户

管理项目中的服务帐户。服务帐户是未与用户关联的机器人用户。如果用户离开组织，则其密钥和项目中的成员身份将不再有效。服务账户没有此限制。但是，也可以从项目中删除服务帐户。source

列出项目服务帐户

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

返回项目中的服务账户列表。source

路径参数

project_id

字符串source

必填

项目的 ID。source

查询参数

限制

整数source

可选

默认为 20

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

后

字符串source

可选

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

ProjectServiceAccount 对象的列表。source

示例请求

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

响应

{
    "object": "list",
    "data": [
        {
            "object": "organization.project.service_account",
            "id": "svc_acct_abc",
            "name": "Service Account",
            "role": "owner",
            "created_at": 1711471533
        }
    ],
    "first_id": "svc_acct_abc",
    "last_id": "svc_acct_xyz",
    "has_more": false
}

创建 Project Service 帐户

POST https://api.openai.com/v1/organization/projects/{project_id}/service_accounts

在项目中创建新的服务账户。这还会返回服务账户的未编辑 API 密钥。source

路径参数

project_id

字符串source

必填

项目的 ID。source

请求正文

名字

字符串source

必填

正在创建的服务帐户的名称。source

创建的 ProjectServiceAccount 对象。source

示例请求

1
2
3
4
5
6
curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/service_accounts \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "name": "Production App"
  }'

响应

{
    "object": "organization.project.service_account",
    "id": "svc_acct_abc",
    "name": "Production App",
    "role": "member",
    "created_at": 1711471533,
    "api_key": {
        "object": "organization.project.service_account.api_key",
        "value": "sk-abcdefghijklmnop123",
        "name": "Secret Key",
        "created_at": 1711471533,
        "id": "key_abc"
    }
}

检索 Project Service 帐户

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

检索项目中的服务帐户。source

路径参数

project_id

字符串source

必填

项目的 ID。source

service_account_id

字符串source

必填

服务帐户的 ID。source

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

示例请求

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

响应

{
    "object": "organization.project.service_account",
    "id": "svc_acct_abc",
    "name": "Service Account",
    "role": "owner",
    "created_at": 1711471533
}

删除 Project Service 帐户

删除 https://api.openai.com/v1/organization/projects/{project_id}/service_accounts/{service_account_id}

从项目中删除服务帐户。source

路径参数

project_id

字符串source

必填

项目的 ID。source

service_account_id

字符串source

必填

服务帐户的 ID。source

确认服务帐户被删除，或者确认没有服务帐户的存档项目时出现错误source

示例请求

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

响应

{
    "object": "organization.project.service_account.deleted",
    "id": "svc_acct_abc",
    "deleted": true
}

Project Service 帐户对象

表示项目中的单个服务账户。source

对象

字符串source

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

身份证

字符串source

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

名字

字符串source

服务帐户的名称source

角色

字符串source

owner或membersource

created_at

整数source

创建服务账户时的 Unix 时间戳（以秒为单位）source

OBJECT 项目服务帐户对象

1
2
3
4
5
6
7
{
    "object": "organization.project.service_account",
    "id": "svc_acct_abc",
    "name": "Service Account",
    "role": "owner",
    "created_at": 1711471533
}