POST /threads/{thread_id}

Servers

Path parameters

Name Type Required Description
thread_id String Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
metadata Object No

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 Object No

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.

tool_resources.code_interpreter Object No
tool_resources.code_interpreter.file_ids[] Array No

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

tool_resources.file_search Object No
tool_resources.file_search.vector_store_ids[] Array No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.