Skip to content
Lucero

Modifies a thread.

POST
/threads/{thread_id}

Authorizations

Parameters

Path Parameters

thread_id
required
string

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

Request Body required

object
tool_resources

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.

object
code_interpreter
object
file_ids

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

Array<string>
default: <= 20 items
file_search
object
vector_store_ids

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

Array<string>
<= 1 items
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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

object

Responses

200

OK

Represents a thread that contains messages.

object
id
required

The identifier, which can be referenced in API endpoints.

string
object
required

The object type, which is always thread.

string
Allowed values: thread
created_at
required

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

integer
tool_resources
required

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.

object
code_interpreter
object
file_ids

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

Array<string>
default: <= 20 items
file_search
object
vector_store_ids

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

Array<string>
<= 1 items
metadata
required

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 maximum of 512 characters long.

object