Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Beta
Threads

Modify thread

$ openai beta:threads update
POST/threads/{thread_id}

Modifies a thread.

ParametersExpand Collapse
--thread-id: string

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

--metadata: optional map[string]

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.

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: map[string]

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.

Modify thread

openai beta:threads update \
  --api-key 'My API Key' \
  --thread-id thread_id
{
  "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": {}
}