POST /threads

Servers

https://api.openai.com/v1

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
`messages[]`	Array	No	A list of messages to start the thread with.
`messages[].attachments[]`	Array	No	A list of files attached to the message, and the tools they should be added to.
`messages[].attachments[].tools[]`	Array	No	The tools to add this file to.
`messages[].attachments[].file_id`	String	No	The ID of the file to attach to the message.
`messages[].content`		Yes
`messages[].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.
`messages[].role`	String	Yes	The role of the entity that is creating the message. Allowed values include: `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. Possible values: `"assistant"` `"user"`
`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_stores[]`	Array	No	A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.
`tool_resources.file_search.vector_stores[].file_ids[]`	Array	No	A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.
`tool_resources.file_search.vector_stores[].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.file_search.vector_stores[].chunking_strategy`	Object	No	The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.
`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

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.