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

邀请

邀请和管理组织的邀请。受邀用户将自动添加到 Default 项目中。source

列出邀请

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

返回组织中的邀请列表。source

查询参数

限制

整数source

可选

默认为 20

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

后

字符串source

可选

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

Invite 对象的列表。source

示例请求

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

响应

{
  "object": "list",
  "data": [
    {
      "object": "organization.invite",
      "id": "invite-abc",
      "email": "user@example.com",
      "role": "owner",
      "status": "accepted",
      "invited_at": 1711471533,
      "expires_at": 1711471533,
      "accepted_at": 1711471533
    }
  ],
  "first_id": "invite-abc",
  "last_id": "invite-abc",
  "has_more": false
}

创建邀请

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

为用户创建组织邀请。用户必须先接受邀请，然后才能访问组织。source

请求正文

电子邮件

字符串source

必填

向此地址发送电子邮件source

角色

字符串source

必填

owner或readersource

创建的 Invite 对象。source

示例请求

1
2
3
4
5
6
7
curl -X POST https://api.openai.com/v1/organization/invites \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "email": "user@example.com",
      "role": "owner"
  }'

响应

{
    "object": "organization.invite",
    "id": "invite-abc",
    "email": "user@example.com",
    "role": "owner",
    "invited_at": 1711471533,
    "expires_at": 1711471533,
    "accepted_at": null
}

检索邀请

获取 https://api.openai.com/v1/organization/invites/{invite_id}

检索邀请。source

路径参数

invite_id

字符串source

必填

要检索的邀请的 ID。source

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

示例请求

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

响应

{
    "object": "organization.invite",
    "id": "invite-abc",
    "email": "user@example.com",
    "role": "owner",
    "status": "accepted",
    "invited_at": 1711471533,
    "expires_at": 1711471533,
    "accepted_at": 1711471533
}

删除邀请

删除 https://api.openai.com/v1/organization/invites/{invite_id}

删除邀请。如果邀请已被接受，则无法删除。source

路径参数

invite_id

字符串source

必填

要删除的邀请的 ID。source

确认邀请已被删除source

示例请求

1
2
3
curl -X DELETE https://api.openai.com/v1/organization/invites/invite-abc \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json"

响应

{
    "object": "organization.invite.deleted",
    "id": "invite-abc",
    "deleted": true
}

invite 对象

代表个人invite到组织。source

对象

字符串source

对象类型，始终为organization.invitesource

身份证

字符串source

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

电子邮件

字符串source

接收邀请的个人的电子邮件地址source

角色

字符串source

owner或readersource

地位

字符串source

accepted,expired或pendingsource

invited_at

整数source

发送邀请时的 Unix 时间戳（以秒为单位）。source

expires_at

整数source

邀请过期的 Unix 时间戳（以秒为单位）。source

accepted_at

整数source

接受邀请时的 Unix 时间戳（以秒为单位）。source

OBJECT 邀请对象

1
2
3
4
5
6
7
8
9
10
{
  "object": "organization.invite",
  "id": "invite-abc",
  "email": "user@example.com",
  "role": "owner",
  "status": "accepted",
  "invited_at": 1711471533,
  "expires_at": 1711471533,
  "accepted_at": 1711471533
}