API Reference

Beta

Threads

Copy Markdown

Open in ChatGPT

---

Copy Markdown

View as Markdown

Modify thread

Deprecated

POST/threads/{thread_id}

Modifies a thread.

Path ParametersExpand Collapse

thread_id: string

Body ParametersJSONExpand Collapse

metadata: optional Metadata

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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

tool_resources: optional object { code_interpreter, file_search }

A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

code_interpreter: optional object { file_ids }

file_ids: optional array of string

A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool.

file_search: optional object { vector_store_ids }

vector_store_ids: optional array of string

The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.

ReturnsExpand Collapse

Thread = object { id, created_at, metadata, 2 more }

Represents a thread that contains messages.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

metadata: Metadata

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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

object: "thread"

The object type, which is always thread.

tool_resources: object { code_interpreter, file_search }

A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

code_interpreter: optional object { file_ids }

file_ids: optional array of string

A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool.

file_search: optional object { vector_store_ids }

vector_store_ids: optional array of string

The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.

Modify thread

HTTP

HTTP

TypeScript

Python

Java

Go

Ruby

curl https://api.openai.com/v1/threads/thread_abc123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "OpenAI-Beta: assistants=v2" \
  -d '{
      "metadata": {
        "modified": "true",
        "user": "abc123"
      }
    }'

{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {
    "modified": "true",
    "user": "abc123"
  },
  "tool_resources": {}
}

Returns Examples

{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {
    "modified": "true",
    "user": "abc123"
  },
  "tool_resources": {}
}