Modify Thread | Portkey Docs

Modifies a thread.

post

Authorizations

Path parameters

thread_idstringRequired

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

Body

tool_resourcesobject | nullableOptional

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.

metadataobject | nullableOptional

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

Responses

application/json

objectOptional

Represents a thread that contains messages.

200

{
  "id": "text",
  "object": "thread",
  "created_at": 1,
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "text"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "text"
      ]
    }
  },
  "metadata": {}
}