OpenAI API (unofficial showcase)
POST/threads/{thread_id}

Modify a thread

Updates the configurable details of a thread. Supply metadata to attach structured key-value pairs, or tool_resources to provide resources for the assistant's tools. The thread identifier selects which thread to update.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
thread_idstringrequired
The ID of the thread to modify.

Thread updates, including tool resources and metadata.

tool_resourcesobjectoptional
Resources made available to the assistant's tools in this thread, such as file IDs for code interpreter or vector store IDs for file search.
metadataobjectoptional
Up to 16 key-value pairs to attach to the thread; keys can be at most 64 characters and values are strings.

2 status codes
200Returns the updated thread object with its ID, creation timestamp, tool resources, and metadata.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always `thread`.
Allowed:thread
created_atintegerrequired
The Unix timestamp (in seconds) for when the thread was created.
tool_resourcesobjectrequired
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.
metadataobjectrequired
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.
429Returned when the request is rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

A 429 is returned when the request exceeds a rate limit. The thread_id path parameter identifies the thread to modify. Metadata keys can be at most 64 characters, and metadata values must be strings.