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

线程（v1）
Legacy

创建助理可以与之交互的线程。source

创建线程（v1）
Legacy

POST https://api.openai.com/v1/threads

创建线程。source

请求正文

消息

数组source

可选

要开始线程的消息列表。source

元数据

地图source

可选

一组 16 个可附加到对象的键值对。这对于以结构化格式存储有关对象的其他信息非常有用。键的最大长度为 64 个字符，值的最大长度为 512 个字符。source

线程对象。source

示例请求

1
2
3
4
5
curl https://api.openai.com/v1/threads \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "OpenAI-Beta: assistants=v1" \
  -d ''

1
2
3
4
5
from openai import OpenAI
client = OpenAI()

empty_thread = client.beta.threads.create()
print(empty_thread)

1
2
3
4
5
6
7
8
9
10
11
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const emptyThread = await openai.beta.threads.create();

  console.log(emptyThread);
}

main();

响应

1
2
3
4
5
6
{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699012949,
  "metadata": {}
}

检索线程（v1）
Legacy

获取 https://api.openai.com/v1/threads/{thread_id}

检索线程。source

路径参数

thread_id

字符串source

必填

要检索的线程的 ID。source

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

示例请求

1
2
3
4
curl https://api.openai.com/v1/threads/thread_abc123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "OpenAI-Beta: assistants=v1"

1
2
3
4
5
from openai import OpenAI
client = OpenAI()

my_thread = client.beta.threads.retrieve("thread_abc123")
print(my_thread)

1
2
3
4
5
6
7
8
9
10
11
12
13
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const myThread = await openai.beta.threads.retrieve(
    "thread_abc123"
  );

  console.log(myThread);
}

main();

响应

1
2
3
4
5
6
{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {}
}

修改线程（v1）
Legacy

POST https://api.openai.com/v1/threads/{thread_id}

修改线程。source

路径参数

thread_id

字符串source

必填

要修改的线程的 ID。只有metadata可以修改。source

请求正文

元数据

地图source

可选

与指定 ID 匹配的修改后的线程对象。source

示例请求

1
2
3
4
5
6
7
8
9
10
curl https://api.openai.com/v1/threads/thread_abc123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "OpenAI-Beta: assistants=v1" \
  -d '{
      "metadata": {
        "modified": "true",
        "user": "abc123"
      }
    }'

1
2
3
4
5
6
7
8
9
10
11
from openai import OpenAI
client = OpenAI()

my_updated_thread = client.beta.threads.update(
  "thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123"
  }
)
print(my_updated_thread)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const updatedThread = await openai.beta.threads.update(
    "thread_abc123",
    {
      metadata: { modified: "true", user: "abc123" },
    }
  );

  console.log(updatedThread);
}

main();

响应

1
2
3
4
5
6
7
8
9
{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {
    "modified": "true",
    "user": "abc123"
  }
}

删除线程（v1）
Legacy

删除 https://api.openai.com/v1/threads/{thread_id}

删除线程。source

路径参数

thread_id

字符串source

必填

要删除的线程的 ID。source

删除状态source

示例请求

1
2
3
4
5
curl https://api.openai.com/v1/threads/thread_abc123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "OpenAI-Beta: assistants=v1" \
  -X DELETE

1
2
3
4
5
from openai import OpenAI
client = OpenAI()

response = client.beta.threads.delete("thread_abc123")
print(response)

1
2
3
4
5
6
7
8
9
10
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const response = await openai.beta.threads.del("thread_abc123");

  console.log(response);
}
main();

响应

1
2
3
4
5
{
  "id": "thread_abc123",
  "object": "thread.deleted",
  "deleted": true
}

thread 对象（v1）
Legacy

表示包含消息的线程。source

身份证

字符串source

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

对象

字符串source

对象类型，始终为thread.source

created_at

整数source

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

元数据

地图source

OBJECT 线程对象（v1）

1
2
3
4
5
6
{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1698107661,
  "metadata": {}
}

线程（v1）
Legacy

创建线程（v1）
Legacy

请求正文

返回

检索线程（v1）
Legacy

路径参数

返回

修改线程（v1）
Legacy

路径参数

请求正文

返回

删除线程（v1）
Legacy

路径参数

返回

thread 对象（v1）
Legacy

线程 （v1）Legacy

创建线程 （v1）Legacy

请求正文

返回

检索线程 （v1）Legacy

路径参数

返回

修改线程 （v1）Legacy

路径参数

请求正文

返回

删除线程 （v1）Legacy

路径参数

返回

thread 对象 （v1）Legacy

线程（v1）
Legacy

创建线程（v1）
Legacy

检索线程（v1）
Legacy

修改线程（v1）
Legacy

删除线程（v1）
Legacy

thread 对象（v1）
Legacy