Skip to content
Primary navigation
API Dashboard
API Reference
Beta
Threads

Runs

List runs
Deprecated
beta.threads.runs.list(strthread_id, RunListParams**kwargs) -> SyncCursorPage[Run]
GET/threads/{thread_id}/runs
Create run
Deprecated
beta.threads.runs.create(strthread_id, RunCreateParams**kwargs) -> Run
POST/threads/{thread_id}/runs
Retrieve run
Deprecated
beta.threads.runs.retrieve(strrun_id, RunRetrieveParams**kwargs) -> Run
GET/threads/{thread_id}/runs/{run_id}
Modify run
Deprecated
beta.threads.runs.update(strrun_id, RunUpdateParams**kwargs) -> Run
POST/threads/{thread_id}/runs/{run_id}
Submit tool outputs to run
Deprecated
beta.threads.runs.submit_tool_outputs(strrun_id, RunSubmitToolOutputsParams**kwargs) -> Run
POST/threads/{thread_id}/runs/{run_id}/submit_tool_outputs
Cancel a run
Deprecated
beta.threads.runs.cancel(strrun_id, RunCancelParams**kwargs) -> Run
POST/threads/{thread_id}/runs/{run_id}/cancel
ModelsExpand Collapse
class RequiredActionFunctionToolCall: …

Tool call objects

id: str

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.

function: Function

The function definition.

arguments: str

The arguments that the model expects you to pass to the function.

name: str

The name of the function.

type: Literal["function"]

The type of tool call the output is required for. For now, this is always function.

class Run: …

Represents an execution run on a thread.

id: str

The identifier, which can be referenced in API endpoints.

assistant_id: str

The ID of the assistant used for execution of this run.

cancelled_at: Optional[int]

The Unix timestamp (in seconds) for when the run was cancelled.

completed_at: Optional[int]

The Unix timestamp (in seconds) for when the run was completed.

created_at: int

The Unix timestamp (in seconds) for when the run was created.

expires_at: Optional[int]

The Unix timestamp (in seconds) for when the run will expire.

failed_at: Optional[int]

The Unix timestamp (in seconds) for when the run failed.

incomplete_details: Optional[IncompleteDetails]

Details on why the run is incomplete. Will be null if the run is not incomplete.

reason: Optional[Literal["max_completion_tokens", "max_prompt_tokens"]]

The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.

Accepts one of the following:
"max_completion_tokens"
"max_prompt_tokens"
instructions: str

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.

code: Literal["server_error", "rate_limit_exceeded", "invalid_prompt"]

One of server_error, rate_limit_exceeded, or invalid_prompt.

Accepts one of the following:
"server_error"
"rate_limit_exceeded"
"invalid_prompt"
message: str

A human-readable description of the error.

max_completion_tokens: Optional[int]

The maximum number of completion tokens specified to have been used over the course of the run.

minimum256
max_prompt_tokens: Optional[int]

The maximum number of prompt tokens specified to have been used over the course of the run.

minimum256
metadata: Optional[Metadata]

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.

model: str

The model that the assistant used for this run.

object: Literal["thread.run"]

The object type, which is always thread.run.

parallel_tool_calls: bool

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.

submit_tool_outputs: RequiredActionSubmitToolOutputs

Details on the tool outputs needed for this run to continue.

tool_calls: List[RequiredActionFunctionToolCall]

A list of the relevant tool calls.

id: str

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.

function: Function

The function definition.

arguments: str

The arguments that the model expects you to pass to the function.

name: str

The name of the function.

type: Literal["function"]

The type of tool call the output is required for. For now, this is always function.

type: Literal["submit_tool_outputs"]

For now, this is always submit_tool_outputs.

response_format: Optional[AssistantResponseFormatOption]

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.

started_at: Optional[int]

The Unix timestamp (in seconds) for when the run was started.

status: RunStatus

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

thread_id: str

The ID of the thread that was executed on as a part of this run.

tool_choice: Optional[AssistantToolChoiceOption]

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.

tools: List[AssistantTool]

The list of tools that the assistant used for this run.

Accepts one of the following:
class CodeInterpreterTool: …
type: Literal["code_interpreter"]

The type of tool being defined: code_interpreter

class FileSearchTool: …
type: Literal["file_search"]

The type of tool being defined: file_search

Accepts one of the following:
class FunctionTool: …
type: Literal["function"]

The type of tool being defined: function

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.

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.

Accepts one of the following:
"auto"
"last_messages"
last_messages: Optional[int]

The number of most recent messages from the thread when constructing the context for the run.

minimum1
usage: Optional[Usage]

Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).

completion_tokens: int

Number of completion tokens used over the course of the run.

prompt_tokens: int

Number of prompt tokens used over the course of the run.

total_tokens: int

Total number of tokens used (prompt + completion).

temperature: Optional[float]

The sampling temperature used for this run. If not set, defaults to 1.

top_p: Optional[float]

The nucleus sampling value used for this run. If not set, defaults to 1.

Literal["queued", "in_progress", "requires_action", 6 more]

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

Accepts one of the following:
"queued"
"in_progress"
"requires_action"
"cancelling"
"cancelled"
"failed"
"completed"
"incomplete"
"expired"

RunsSteps

List run steps
Deprecated
beta.threads.runs.steps.list(strrun_id, StepListParams**kwargs) -> SyncCursorPage[RunStep]
GET/threads/{thread_id}/runs/{run_id}/steps
Retrieve run step
Deprecated
beta.threads.runs.steps.retrieve(strstep_id, StepRetrieveParams**kwargs) -> RunStep
GET/threads/{thread_id}/runs/{run_id}/steps/{step_id}
ModelsExpand Collapse
class CodeInterpreterLogs: …

Text output from the Code Interpreter tool call as part of a run step.

index: int

The index of the output in the outputs array.

type: Literal["logs"]

Always logs.

logs: Optional[str]

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage: …
index: int

The index of the output in the outputs array.

type: Literal["image"]

Always image.

image: Optional[Image]
file_id: Optional[str]

The file ID of the image.

class CodeInterpreterToolCall: …

Details of the Code Interpreter tool call the run step was involved in.

id: str

The ID of the tool call.

code_interpreter: CodeInterpreter

The Code Interpreter tool call definition.

input: str

The input to the Code Interpreter tool call.

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.

Accepts one of the following:
class CodeInterpreterOutputLogs: …

Text output from the Code Interpreter tool call as part of a run step.

logs: str

The text output from the Code Interpreter tool call.

type: Literal["logs"]

Always logs.

class CodeInterpreterOutputImage: …
image: CodeInterpreterOutputImageImage
file_id: str

The file ID of the image.

type: Literal["image"]

Always image.

type: Literal["code_interpreter"]

The type of tool call. This is always going to be code_interpreter for this type of tool call.

class CodeInterpreterToolCallDelta: …

Details of the Code Interpreter tool call the run step was involved in.

index: int

The index of the tool call in the tool calls array.

type: Literal["code_interpreter"]

The type of tool call. This is always going to be code_interpreter for this type of tool call.

id: Optional[str]

The ID of the tool call.

code_interpreter: Optional[CodeInterpreter]

The Code Interpreter tool call definition.

input: Optional[str]

The input to the Code Interpreter tool call.

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.

Accepts one of the following:
class CodeInterpreterLogs: …

Text output from the Code Interpreter tool call as part of a run step.

index: int

The index of the output in the outputs array.

type: Literal["logs"]

Always logs.

logs: Optional[str]

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage: …
index: int

The index of the output in the outputs array.

type: Literal["image"]

Always image.

image: Optional[Image]
file_id: Optional[str]

The file ID of the image.

class FileSearchToolCall: …
id: str

The ID of the tool call object.

Accepts one of the following:
content: Optional[List[FileSearchResultContent]]

The content of the result that was found. The content is only included if requested via the include query parameter.

text: Optional[str]

The text content of the file.

type: Optional[Literal["text"]]

The type of the content.

type: Literal["file_search"]

The type of tool call. This is always going to be file_search for this type of tool call.

class FileSearchToolCallDelta: …
index: int

The index of the tool call in the tool calls array.

type: Literal["file_search"]

The type of tool call. This is always going to be file_search for this type of tool call.

id: Optional[str]

The ID of the tool call object.

class FunctionToolCall: …
id: str

The ID of the tool call object.

function: Function

The definition of the function that was called.

arguments: str

The arguments passed to the function.

name: str

The name of the function.

output: Optional[str]

The output of the function. This will be null if the outputs have not been submitted yet.

type: Literal["function"]

The type of tool call. This is always going to be function for this type of tool call.

class FunctionToolCallDelta: …
index: int

The index of the tool call in the tool calls array.

type: Literal["function"]

The type of tool call. This is always going to be function for this type of tool call.

id: Optional[str]

The ID of the tool call object.

function: Optional[Function]

The definition of the function that was called.

arguments: Optional[str]

The arguments passed to the function.

name: Optional[str]

The name of the function.

output: Optional[str]

The output of the function. This will be null if the outputs have not been submitted yet.

class MessageCreationStepDetails: …

Details of the message creation by the run step.

message_creation: MessageCreation
message_id: str

The ID of the message that was created by this run step.

type: Literal["message_creation"]

Always message_creation.

class RunStep: …

Represents a step in execution of a run.

id: str

The identifier of the run step, which can be referenced in API endpoints.

assistant_id: str

The ID of the assistant associated with the run step.

cancelled_at: Optional[int]

The Unix timestamp (in seconds) for when the run step was cancelled.

completed_at: Optional[int]

The Unix timestamp (in seconds) for when the run step completed.

created_at: int

The Unix timestamp (in seconds) for when the run step was created.

expired_at: Optional[int]

The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.

failed_at: Optional[int]

The Unix timestamp (in seconds) for when the run step failed.

last_error: Optional[LastError]

The last error associated with this run step. Will be null if there are no errors.

code: Literal["server_error", "rate_limit_exceeded"]

One of server_error or rate_limit_exceeded.

Accepts one of the following:
"server_error"
"rate_limit_exceeded"
message: str

A human-readable description of the error.

metadata: Optional[Metadata]

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.

object: Literal["thread.run.step"]

The object type, which is always thread.run.step.

run_id: str

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.

Accepts one of the following:
"in_progress"
"cancelled"
"failed"
"completed"
"expired"
step_details: StepDetails

The details of the run step.

Accepts one of the following:
class MessageCreationStepDetails: …

Details of the message creation by the run step.

message_creation: MessageCreation
message_id: str

The ID of the message that was created by this run step.

type: Literal["message_creation"]

Always message_creation.

class ToolCallsStepDetails: …

Details of the tool call.

tool_calls: List[ToolCall]

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.

Accepts one of the following:
class CodeInterpreterToolCall: …

Details of the Code Interpreter tool call the run step was involved in.

id: str

The ID of the tool call.

code_interpreter: CodeInterpreter

The Code Interpreter tool call definition.

input: str

The input to the Code Interpreter tool call.

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.

Accepts one of the following:
class CodeInterpreterOutputLogs: …

Text output from the Code Interpreter tool call as part of a run step.

logs: str

The text output from the Code Interpreter tool call.

type: Literal["logs"]

Always logs.

class CodeInterpreterOutputImage: …
image: CodeInterpreterOutputImageImage
file_id: str

The file ID of the image.

type: Literal["image"]

Always image.

type: Literal["code_interpreter"]

The type of tool call. This is always going to be code_interpreter for this type of tool call.

class FileSearchToolCall: …
id: str

The ID of the tool call object.

Accepts one of the following:
content: Optional[List[FileSearchResultContent]]

The content of the result that was found. The content is only included if requested via the include query parameter.

text: Optional[str]

The text content of the file.

type: Optional[Literal["text"]]

The type of the content.

type: Literal["file_search"]

The type of tool call. This is always going to be file_search for this type of tool call.

class FunctionToolCall: …
id: str

The ID of the tool call object.

function: Function

The definition of the function that was called.

arguments: str

The arguments passed to the function.

name: str

The name of the function.

output: Optional[str]

The output of the function. This will be null if the outputs have not been submitted yet.

type: Literal["function"]

The type of tool call. This is always going to be function for this type of tool call.

type: Literal["tool_calls"]

Always tool_calls.

thread_id: str

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.

Accepts one of the following:
"message_creation"
"tool_calls"
usage: Optional[Usage]

Usage statistics related to the run step. This value will be null while the run step's status is in_progress.

completion_tokens: int

Number of completion tokens used over the course of the run step.

prompt_tokens: int

Number of prompt tokens used over the course of the run step.

total_tokens: int

Total number of tokens used (prompt + completion).

class RunStepDelta: …

The delta containing the fields that have changed on the run step.

step_details: Optional[StepDetails]

The details of the run step.

Accepts one of the following:
class RunStepDeltaMessageDelta: …

Details of the message creation by the run step.

type: Literal["message_creation"]

Always message_creation.

message_creation: Optional[MessageCreation]
message_id: Optional[str]

The ID of the message that was created by this run step.

class ToolCallDeltaObject: …

Details of the tool call.

type: Literal["tool_calls"]

Always tool_calls.

tool_calls: Optional[List[ToolCallDelta]]

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.

Accepts one of the following:
class CodeInterpreterToolCallDelta: …

Details of the Code Interpreter tool call the run step was involved in.

index: int

The index of the tool call in the tool calls array.

type: Literal["code_interpreter"]

The type of tool call. This is always going to be code_interpreter for this type of tool call.

id: Optional[str]

The ID of the tool call.

code_interpreter: Optional[CodeInterpreter]

The Code Interpreter tool call definition.

input: Optional[str]

The input to the Code Interpreter tool call.

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.

Accepts one of the following:
class CodeInterpreterLogs: …

Text output from the Code Interpreter tool call as part of a run step.

index: int

The index of the output in the outputs array.

type: Literal["logs"]

Always logs.

logs: Optional[str]

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage: …
index: int

The index of the output in the outputs array.

type: Literal["image"]

Always image.

image: Optional[Image]
file_id: Optional[str]

The file ID of the image.

class FileSearchToolCallDelta: …
index: int

The index of the tool call in the tool calls array.

type: Literal["file_search"]

The type of tool call. This is always going to be file_search for this type of tool call.

id: Optional[str]

The ID of the tool call object.

class FunctionToolCallDelta: …
index: int

The index of the tool call in the tool calls array.

type: Literal["function"]

The type of tool call. This is always going to be function for this type of tool call.

id: Optional[str]

The ID of the tool call object.

function: Optional[Function]

The definition of the function that was called.

arguments: Optional[str]

The arguments passed to the function.

name: Optional[str]

The name of the function.

output: Optional[str]

The output of the function. This will be null if the outputs have not been submitted yet.

class RunStepDeltaEvent: …

Represents a run step delta i.e. any changed fields on a run step during streaming.

id: str

The identifier of the run step, which can be referenced in API endpoints.

delta: RunStepDelta

The delta containing the fields that have changed on the run step.

object: Literal["thread.run.step.delta"]

The object type, which is always thread.run.step.delta.

class RunStepDeltaMessageDelta: …

Details of the message creation by the run step.

type: Literal["message_creation"]

Always message_creation.

message_creation: Optional[MessageCreation]
message_id: Optional[str]

The ID of the message that was created by this run step.

Literal["step_details.tool_calls[*].file_search.results[*].content"]
ToolCall

Details of the Code Interpreter tool call the run step was involved in.

Accepts one of the following:
class CodeInterpreterToolCall: …

Details of the Code Interpreter tool call the run step was involved in.

id: str

The ID of the tool call.

code_interpreter: CodeInterpreter

The Code Interpreter tool call definition.

input: str

The input to the Code Interpreter tool call.

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.

Accepts one of the following:
class CodeInterpreterOutputLogs: …

Text output from the Code Interpreter tool call as part of a run step.

logs: str

The text output from the Code Interpreter tool call.

type: Literal["logs"]

Always logs.

class CodeInterpreterOutputImage: …
image: CodeInterpreterOutputImageImage
file_id: str

The file ID of the image.

type: Literal["image"]

Always image.

type: Literal["code_interpreter"]

The type of tool call. This is always going to be code_interpreter for this type of tool call.

class FileSearchToolCall: …
id: str

The ID of the tool call object.

Accepts one of the following:
content: Optional[List[FileSearchResultContent]]

The content of the result that was found. The content is only included if requested via the include query parameter.

text: Optional[str]

The text content of the file.

type: Optional[Literal["text"]]

The type of the content.

type: Literal["file_search"]

The type of tool call. This is always going to be file_search for this type of tool call.

class FunctionToolCall: …
id: str

The ID of the tool call object.

function: Function

The definition of the function that was called.

arguments: str

The arguments passed to the function.

name: str

The name of the function.

output: Optional[str]

The output of the function. This will be null if the outputs have not been submitted yet.

type: Literal["function"]

The type of tool call. This is always going to be function for this type of tool call.

ToolCallDelta

Details of the Code Interpreter tool call the run step was involved in.

Accepts one of the following:
class CodeInterpreterToolCallDelta: …

Details of the Code Interpreter tool call the run step was involved in.

index: int

The index of the tool call in the tool calls array.

type: Literal["code_interpreter"]

The type of tool call. This is always going to be code_interpreter for this type of tool call.

id: Optional[str]

The ID of the tool call.

code_interpreter: Optional[CodeInterpreter]

The Code Interpreter tool call definition.

input: Optional[str]

The input to the Code Interpreter tool call.

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.

Accepts one of the following:
class CodeInterpreterLogs: …

Text output from the Code Interpreter tool call as part of a run step.

index: int

The index of the output in the outputs array.

type: Literal["logs"]

Always logs.

logs: Optional[str]

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage: …
index: int

The index of the output in the outputs array.

type: Literal["image"]

Always image.

image: Optional[Image]
file_id: Optional[str]

The file ID of the image.

class FileSearchToolCallDelta: …
index: int

The index of the tool call in the tool calls array.

type: Literal["file_search"]

The type of tool call. This is always going to be file_search for this type of tool call.

id: Optional[str]

The ID of the tool call object.

class FunctionToolCallDelta: …
index: int

The index of the tool call in the tool calls array.

type: Literal["function"]

The type of tool call. This is always going to be function for this type of tool call.

id: Optional[str]

The ID of the tool call object.

function: Optional[Function]

The definition of the function that was called.

arguments: Optional[str]

The arguments passed to the function.

name: Optional[str]

The name of the function.

output: Optional[str]

The output of the function. This will be null if the outputs have not been submitted yet.

class ToolCallDeltaObject: …

Details of the tool call.

type: Literal["tool_calls"]

Always tool_calls.

tool_calls: Optional[List[ToolCallDelta]]

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.

Accepts one of the following:
class CodeInterpreterToolCallDelta: …

Details of the Code Interpreter tool call the run step was involved in.

index: int

The index of the tool call in the tool calls array.

type: Literal["code_interpreter"]

The type of tool call. This is always going to be code_interpreter for this type of tool call.

id: Optional[str]

The ID of the tool call.

code_interpreter: Optional[CodeInterpreter]

The Code Interpreter tool call definition.

input: Optional[str]

The input to the Code Interpreter tool call.

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.

Accepts one of the following:
class CodeInterpreterLogs: …

Text output from the Code Interpreter tool call as part of a run step.

index: int

The index of the output in the outputs array.

type: Literal["logs"]

Always logs.

logs: Optional[str]

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage: …
index: int

The index of the output in the outputs array.

type: Literal["image"]

Always image.

image: Optional[Image]
file_id: Optional[str]

The file ID of the image.

class FileSearchToolCallDelta: …
index: int

The index of the tool call in the tool calls array.

type: Literal["file_search"]

The type of tool call. This is always going to be file_search for this type of tool call.

id: Optional[str]

The ID of the tool call object.

class FunctionToolCallDelta: …
index: int

The index of the tool call in the tool calls array.

type: Literal["function"]

The type of tool call. This is always going to be function for this type of tool call.

id: Optional[str]

The ID of the tool call object.

function: Optional[Function]

The definition of the function that was called.

arguments: Optional[str]

The arguments passed to the function.

name: Optional[str]

The name of the function.

output: Optional[str]

The output of the function. This will be null if the outputs have not been submitted yet.

class ToolCallsStepDetails: …

Details of the tool call.

tool_calls: List[ToolCall]

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.

Accepts one of the following:
class CodeInterpreterToolCall: …

Details of the Code Interpreter tool call the run step was involved in.

id: str

The ID of the tool call.

code_interpreter: CodeInterpreter

The Code Interpreter tool call definition.

input: str

The input to the Code Interpreter tool call.

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.

Accepts one of the following:
class CodeInterpreterOutputLogs: …

Text output from the Code Interpreter tool call as part of a run step.

logs: str

The text output from the Code Interpreter tool call.

type: Literal["logs"]

Always logs.

class CodeInterpreterOutputImage: …
image: CodeInterpreterOutputImageImage
file_id: str

The file ID of the image.

type: Literal["image"]

Always image.

type: Literal["code_interpreter"]

The type of tool call. This is always going to be code_interpreter for this type of tool call.

class FileSearchToolCall: …
id: str

The ID of the tool call object.

Accepts one of the following:
content: Optional[List[FileSearchResultContent]]

The content of the result that was found. The content is only included if requested via the include query parameter.

text: Optional[str]

The text content of the file.

type: Optional[Literal["text"]]

The type of the content.

type: Literal["file_search"]

The type of tool call. This is always going to be file_search for this type of tool call.

class FunctionToolCall: …
id: str

The ID of the tool call object.

function: Function

The definition of the function that was called.

arguments: str

The arguments passed to the function.

name: str

The name of the function.

output: Optional[str]

The output of the function. This will be null if the outputs have not been submitted yet.

type: Literal["function"]

The type of tool call. This is always going to be function for this type of tool call.

type: Literal["tool_calls"]

Always tool_calls.