Sample - OpenAI API
POST/threads/{thread_id}

Modify a thread

Updates the configurable resources or metadata associated with a thread. Use thread_id to select the thread and provide the thread properties you want to change.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

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

Thread properties to update, including tool resources and metadata.

tool_resourcesobjectoptional
Resources made available to the assistant's tools in this thread, such as file IDs for code interpretation or vector store IDs for file search.
metadataobjectoptional
String key-value pairs attached to the thread; keys can be up to 64 characters, with up to 16 pairs.

2 status codes
200Returns the updated thread object with its identifier, object type, 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 was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

A 429 is returned when the request exceeds the rate limit. tool_resources may contain resources for assistant tools, and metadata accepts string key-value pairs with keys up to 64 characters.