Runs
Build Assistants that can call models and use tools.
Create run
Retrieve run
Modify run
Submit tool outputs to run
Cancel a run
ModelsExpand Collapse
class RequiredActionFunctionToolCall: …Tool call objects
Tool call objects
The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the Submit tool outputs to run endpoint.
class Run: …Represents an execution run on a thread.
Represents an execution run on a thread.
The ID of the assistant used for execution of this run.
incomplete_details: Optional[IncompleteDetails]Details on why the run is incomplete. Will be null if the run is not incomplete.
Details on why the run is incomplete. Will be null if the run is not incomplete.
The instructions that the assistant used for this run.
last_error: Optional[LastError]The last error associated with this run. Will be null if there are no errors.
The last error associated with this run. Will be null if there are no errors.
The maximum number of completion tokens specified to have been used over the course of the run.
The maximum number of prompt tokens specified to have been used over the course of the run.
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.
The model that the assistant used for this run.
Whether to enable parallel function calling during tool use.
required_action: Optional[RequiredAction]Details on the action required to continue the run. Will be null if no action is required.
Details on the action required to continue the run. Will be null if no action is required.
submit_tool_outputs: RequiredActionSubmitToolOutputsDetails on the tool outputs needed for this run to continue.
Details on the tool outputs needed for this run to continue.
A list of the relevant tool calls.
A list of the relevant tool calls.
The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the Submit tool outputs to run endpoint.
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.
The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.
The ID of the thread that was executed on as a part of this run.
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.
The list of tools that the assistant used for this run.
The list of tools that the assistant used for this run.
class FileSearchTool: …
file_search: Optional[FileSearch]Overrides for the file search tool.
Overrides for the file search tool.
The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.
Note that the file search tool may output fewer than max_num_results results. See the file search tool documentation for more information.
ranking_options: Optional[FileSearchRankingOptions]The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0.
See the file search tool documentation for more information.
The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0.
See the file search tool documentation for more information.
truncation_strategy: Optional[TruncationStrategy]Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.
Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.
type: Literal["auto", "last_messages"]The truncation strategy to use for the thread. The default is auto. If set to last_messages, the thread will be truncated to the n most recent messages in the thread. When set to auto, messages in the middle of the thread will be dropped to fit the context length of the model, max_prompt_tokens.
The truncation strategy to use for the thread. The default is auto. If set to last_messages, the thread will be truncated to the n most recent messages in the thread. When set to auto, messages in the middle of the thread will be dropped to fit the context length of the model, max_prompt_tokens.
RunsSteps
Build Assistants that can call models and use tools.
List run steps
Retrieve run step
ModelsExpand Collapse
class CodeInterpreterOutputImage: …
image: Optional[Image]
The file ID of the image.
class CodeInterpreterToolCall: …Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
code_interpreter: CodeInterpreterThe Code Interpreter tool call definition.
The Code Interpreter tool call definition.
outputs: List[CodeInterpreterOutput]The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
class CodeInterpreterOutputLogs: …Text output from the Code Interpreter tool call as part of a run step.
Text output from the Code Interpreter tool call as part of a run step.
class CodeInterpreterOutputImage: …
image: CodeInterpreterOutputImageImage
The file ID of the image.
class CodeInterpreterToolCallDelta: …Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
The type of tool call. This is always going to be code_interpreter for this type of tool call.
code_interpreter: Optional[CodeInterpreter]The Code Interpreter tool call definition.
The Code Interpreter tool call definition.
outputs: Optional[List[CodeInterpreterOutput]]The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
class CodeInterpreterOutputImage: …
image: Optional[Image]
The file ID of the image.
class FileSearchToolCall: …
file_search: FileSearchFor now, this is always going to be an empty object.
For now, this is always going to be an empty object.
ranking_options: Optional[FileSearchRankingOptions]The ranking options for the file search.
The ranking options for the file search.
class FunctionToolCall: …
function: FunctionThe definition of the function that was called.
The definition of the function that was called.
The output of the function. This will be null if the outputs have not been submitted yet.
class FunctionToolCallDelta: …
The type of tool call. This is always going to be function for this type of tool call.
function: Optional[Function]The definition of the function that was called.
The definition of the function that was called.
The output of the function. This will be null if the outputs have not been submitted yet.
class RunStep: …Represents a step in execution of a run.
Represents a step in execution of a run.
The ID of the assistant associated with the run step.
The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.
last_error: Optional[LastError]The last error associated with this run step. Will be null if there are no errors.
The last error associated with this run step. Will be null if there are no errors.
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.
The ID of the run that this run step is a part of.
status: Literal["in_progress", "cancelled", "failed", 2 more]The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
step_details: StepDetailsThe details of the run step.
The details of the run step.
class ToolCallsStepDetails: …Details of the tool call.
Details of the tool call.
An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.
An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.
class CodeInterpreterToolCall: …Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
code_interpreter: CodeInterpreterThe Code Interpreter tool call definition.
The Code Interpreter tool call definition.
outputs: List[CodeInterpreterOutput]The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
class CodeInterpreterOutputLogs: …Text output from the Code Interpreter tool call as part of a run step.
Text output from the Code Interpreter tool call as part of a run step.
class CodeInterpreterOutputImage: …
image: CodeInterpreterOutputImageImage
The file ID of the image.
class FileSearchToolCall: …
file_search: FileSearchFor now, this is always going to be an empty object.
For now, this is always going to be an empty object.
ranking_options: Optional[FileSearchRankingOptions]The ranking options for the file search.
The ranking options for the file search.
class FunctionToolCall: …
function: FunctionThe definition of the function that was called.
The definition of the function that was called.
The output of the function. This will be null if the outputs have not been submitted yet.
The ID of the thread that was run.
type: Literal["message_creation", "tool_calls"]The type of run step, which can be either message_creation or tool_calls.
The type of run step, which can be either message_creation or tool_calls.
class RunStepDelta: …The delta containing the fields that have changed on the run step.
The delta containing the fields that have changed on the run step.
step_details: Optional[StepDetails]The details of the run step.
The details of the run step.
class ToolCallDeltaObject: …Details of the tool call.
Details of the tool call.
An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.
An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.
class CodeInterpreterToolCallDelta: …Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
The type of tool call. This is always going to be code_interpreter for this type of tool call.
code_interpreter: Optional[CodeInterpreter]The Code Interpreter tool call definition.
The Code Interpreter tool call definition.
outputs: Optional[List[CodeInterpreterOutput]]The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
class CodeInterpreterOutputImage: …
image: Optional[Image]
The file ID of the image.
class FileSearchToolCallDelta: …
class FunctionToolCallDelta: …
The type of tool call. This is always going to be function for this type of tool call.
function: Optional[Function]The definition of the function that was called.
The definition of the function that was called.
The output of the function. This will be null if the outputs have not been submitted yet.
Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
class CodeInterpreterToolCall: …Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
code_interpreter: CodeInterpreterThe Code Interpreter tool call definition.
The Code Interpreter tool call definition.
outputs: List[CodeInterpreterOutput]The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
class CodeInterpreterOutputLogs: …Text output from the Code Interpreter tool call as part of a run step.
Text output from the Code Interpreter tool call as part of a run step.
class CodeInterpreterOutputImage: …
image: CodeInterpreterOutputImageImage
The file ID of the image.
class FileSearchToolCall: …
file_search: FileSearchFor now, this is always going to be an empty object.
For now, this is always going to be an empty object.
ranking_options: Optional[FileSearchRankingOptions]The ranking options for the file search.
The ranking options for the file search.
class FunctionToolCall: …
function: FunctionThe definition of the function that was called.
The definition of the function that was called.
The output of the function. This will be null if the outputs have not been submitted yet.
Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
class CodeInterpreterToolCallDelta: …Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
The type of tool call. This is always going to be code_interpreter for this type of tool call.
code_interpreter: Optional[CodeInterpreter]The Code Interpreter tool call definition.
The Code Interpreter tool call definition.
outputs: Optional[List[CodeInterpreterOutput]]The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
class CodeInterpreterOutputImage: …
image: Optional[Image]
The file ID of the image.
class FileSearchToolCallDelta: …
class FunctionToolCallDelta: …
The type of tool call. This is always going to be function for this type of tool call.
function: Optional[Function]The definition of the function that was called.
The definition of the function that was called.
The output of the function. This will be null if the outputs have not been submitted yet.
class ToolCallDeltaObject: …Details of the tool call.
Details of the tool call.
An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.
An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.
class CodeInterpreterToolCallDelta: …Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
The type of tool call. This is always going to be code_interpreter for this type of tool call.
code_interpreter: Optional[CodeInterpreter]The Code Interpreter tool call definition.
The Code Interpreter tool call definition.
outputs: Optional[List[CodeInterpreterOutput]]The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
class CodeInterpreterOutputImage: …
image: Optional[Image]
The file ID of the image.
class FileSearchToolCallDelta: …
class FunctionToolCallDelta: …
The type of tool call. This is always going to be function for this type of tool call.
function: Optional[Function]The definition of the function that was called.
The definition of the function that was called.
The output of the function. This will be null if the outputs have not been submitted yet.
class ToolCallsStepDetails: …Details of the tool call.
Details of the tool call.
An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.
An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.
class CodeInterpreterToolCall: …Details of the Code Interpreter tool call the run step was involved in.
Details of the Code Interpreter tool call the run step was involved in.
code_interpreter: CodeInterpreterThe Code Interpreter tool call definition.
The Code Interpreter tool call definition.
outputs: List[CodeInterpreterOutput]The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.
class CodeInterpreterOutputLogs: …Text output from the Code Interpreter tool call as part of a run step.
Text output from the Code Interpreter tool call as part of a run step.
class CodeInterpreterOutputImage: …
image: CodeInterpreterOutputImageImage
The file ID of the image.
class FileSearchToolCall: …
file_search: FileSearchFor now, this is always going to be an empty object.
For now, this is always going to be an empty object.
ranking_options: Optional[FileSearchRankingOptions]The ranking options for the file search.
The ranking options for the file search.
class FunctionToolCall: …
function: FunctionThe definition of the function that was called.
The definition of the function that was called.
The output of the function. This will be null if the outputs have not been submitted yet.