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

项目

管理组织内的项目包括创建、更新和存档或项目。 Default 项目无法修改或存档。source

列出项目

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

返回项目列表。source

查询参数

限制

整数source

可选

默认为 20

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

后

字符串source

可选

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

include_archived

布尔source

可选

默认为 false

如果true返回所有项目，包括那些已经archived.默认情况下，不包括已存档的项目。source

Project 对象的列表。source

示例请求

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

响应

{
    "object": "list",
    "data": [
        {
            "id": "proj_abc",
            "object": "organization.project",
            "name": "Project example",
            "created_at": 1711471533,
            "archived_at": null,
            "status": "active"
        }
    ],
    "first_id": "proj-abc",
    "last_id": "proj-xyz",
    "has_more": false
}

创建项目

POST https://api.openai.com/v1/organization/projects

在组织中创建新项目。可以创建和存档项目，但不能删除项目。source

请求正文

名字

字符串source

必填

项目的友好名称，此名称显示在报表中。source

创建的 Project 对象。source

示例请求

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

响应

{
    "id": "proj_abc",
    "object": "organization.project",
    "name": "Project ABC",
    "created_at": 1711471533,
    "archived_at": null,
    "status": "active"
}

检索项目

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

检索项目。source

路径参数

project_id

字符串source

必填

项目的 ID。source

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

示例请求

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

响应

{
    "id": "proj_abc",
    "object": "organization.project",
    "name": "Project example",
    "created_at": 1711471533,
    "archived_at": null,
    "status": "active"
}

修改项目

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

修改组织中的项目。source

路径参数

project_id

字符串source

必填

项目的 ID。source

请求正文

名字

字符串source

必填

项目的更新名称，此名称显示在报表中。source

更新的 Project 对象。source

示例请求

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

存档项目

post https://api.openai.com/v1/organization/projects/{project_id}/archive

存档组织中的项目。存档的项目不能使用或更新。source

路径参数

project_id

字符串source

必填

项目的 ID。source

存档的 Project 对象。source

示例请求

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

响应

{
    "id": "proj_abc",
    "object": "organization.project",
    "name": "Project DEF",
    "created_at": 1711471533,
    "archived_at": 1711471533,
    "status": "archived"
}

项目对象

表示单个项目。source

身份证

字符串source

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

对象

字符串source

对象类型，始终为organization.projectsource

名字

字符串source

项目的名称。这将显示在报表中。source

created_at

整数source

创建项目时的 Unix 时间戳（以秒为单位）。source

archived_at

整数或 nullsource

项目存档时的 Unix 时间戳（以秒为单位），或者null.source

地位

字符串source

active或archivedsource

OBJECT 项目对象

1
2
3
4
5
6
7
8
{
    "id": "proj_abc",
    "object": "organization.project",
    "name": "Project example",
    "created_at": 1711471533,
    "archived_at": null,
    "status": "active"
}