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

Threads (v1)
Legacy

Create threads that assistants can interact with.source

Related guide: Assistants source

Create thread (v1)
Legacy

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

Create a thread.source

Request body

messages

arraysource

Optional

A list of messages to start the thread with.source

metadata

mapsource

Optional

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.source

Returns

A thread object.source

Example request

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();

Response

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

Retrieve thread (v1)
Legacy

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

Retrieves a thread.source

Path parameters

thread_id

stringsource

Required

The ID of the thread to retrieve.source

Returns

The thread object matching the specified ID.source

Example request

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();

Response

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

Modify thread (v1)
Legacy

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

Modifies a thread.source

Path parameters

thread_id

stringsource

Required

The ID of the thread to modify. Only the metadata can be modified.source

Request body

metadata

mapsource

Optional

Returns

The modified thread object matching the specified ID.source

Example request

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();

Response

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

Delete thread (v1)
Legacy

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

Delete a thread.source

Path parameters

thread_id

stringsource

Required

The ID of the thread to delete.source

Returns

Deletion statussource

Example request

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();

Response

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

The thread object (v1)
Legacy

Represents a thread that contains messages.source

stringsource

The identifier, which can be referenced in API endpoints.source

object

stringsource

The object type, which is always thread.source

created_at

integersource

The Unix timestamp (in seconds) for when the thread was created.source

metadata

mapsource

OBJECT The thread object (v1)

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

Threads (v1)Legacy

Create thread (v1)Legacy

Request body

Returns

Retrieve thread (v1)Legacy

Path parameters

Returns

Modify thread (v1)Legacy

Path parameters

Request body

Returns

Delete thread (v1)Legacy

Path parameters

Returns

The thread object (v1)Legacy

Threads (v1)
Legacy

Create thread (v1)
Legacy

Retrieve thread (v1)
Legacy

Modify thread (v1)
Legacy

Delete thread (v1)
Legacy

The thread object (v1)
Legacy