POST /threads/runs

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
`stream`	Boolean	No	If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.
`max_completion_tokens`	Integer	No	The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.
`temperature`	Number	No	What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Default value: 1
`tools[]`	Array	No	Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.
`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.
`max_prompt_tokens`	Integer	No	The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.
`parallel_tool_calls`	Boolean	No	Whether to enable parallel function calling during tool use. Default value: true
`tool_resources`	Object	No	A set of resources that are used by the assistant's tools. 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 ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.
`tool_choice`		No	Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
`response_format`		No	Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide. Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.
`model`		No	The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.
`top_p`	Number	No	An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. Default value: 1
`assistant_id`	String	Yes	The ID of the assistant to use to execute this run.
`thread`	Object	No	Options to create a new thread. If no thread is provided when running a request, an empty thread will be created.
`thread.messages[]`	Array	No	A list of messages to start the thread with.
`thread.messages[].attachments[]`	Array	No	A list of files attached to the message, and the tools they should be added to.
`thread.messages[].attachments[].tools[]`	Array	No	The tools to add this file to.
`thread.messages[].attachments[].file_id`	String	No	The ID of the file to attach to the message.
`thread.messages[].content`		Yes
`thread.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.
`thread.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"`
`thread.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.
`thread.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.
`thread.tool_resources.code_interpreter`	Object	No
`thread.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.
`thread.tool_resources.file_search`	Object	No
`thread.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.
`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.
`thread.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.
`thread.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.
`thread.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.
`instructions`	String	No	Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.

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.