Optionaladditional_Optionaladditional_Body param: Adds additional messages to the thread before creating the run.
Body param: The ID of the assistant to use to execute this run.
OptionalincludeQuery param: A list of additional fields to include in the response. Currently
the only supported value is
step_details.tool_calls[*].file_search.results[*].content to fetch the file
search result content.
See the file search tool documentation for more information.
OptionalinstructionsBody param: Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.
Optionalmax_Body param: 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.
Optionalmax_Body param: 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.
OptionalmetadataBody param: 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.
OptionalmodelBody param: 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.
Optionalparallel_Body param: Whether to enable parallel function calling during tool use.
Optionalresponse_Body param: 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 guarantees the model will match your supplied JSON schema. Learn
more in the
Structured Outputs guide.
Setting to { "type": "json_object" } enables JSON mode, which guarantees 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.
Body param: 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.
OptionaltemperatureBody param: 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.
Optionaltool_Body param: 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.
OptionaltoolsBody param: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.
Optionaltop_Body param: 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.
Optionaltruncation_Body param: Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.
Body param: Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.