Runs

Build Assistants that can call models and use tools.

Retrieve run

Deprecated

GET/threads/{thread_id}/runs/{run_id}

Modify run

Deprecated

POST/threads/{thread_id}/runs/{run_id}

Submit tool outputs to run

Deprecated

POST/threads/{thread_id}/runs/{run_id}/submit_tool_outputs

Cancel a run

Deprecated

POST/threads/{thread_id}/runs/{run_id}/cancel

ModelsExpand Collapse

RequiredActionFunctionToolCall = object { id, function, type }

Tool call objects

id: string

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: object { arguments, name }

The function definition.

arguments: string

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

The name of the function.

type: "function"

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

Run = object { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

id: string

The identifier, which can be referenced in API endpoints.

assistant_id: string

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

cancelled_at: number

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

completed_at: number

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

created_at: number

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

expires_at: number

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

failed_at: number

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

incomplete_details: object { reason }

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

reason: optional "max_completion_tokens" or "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.

One of the following:

"max_completion_tokens"

"max_prompt_tokens"

instructions: string

The instructions that the assistant used for this run.

last_error: object { code, message }

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

code: "server_error" or "rate_limit_exceeded" or "invalid_prompt"

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

"server_error"

"rate_limit_exceeded"

"invalid_prompt"

message: string

A human-readable description of the error.

max_completion_tokens: number

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

minimum256

max_prompt_tokens: number

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

minimum256

metadata: 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: string

The model that the assistant used for this run.

object: "thread.run"

The object type, which is always thread.run.

parallel_tool_calls: boolean

Whether to enable parallel function calling during tool use.

required_action: object { submit_tool_outputs, type }

Details on the action required to continue the run. Will be null if no action is required.

submit_tool_outputs: object { tool_calls }

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

tool_calls: array of RequiredActionFunctionToolCall { id, function, type }

A list of the relevant tool calls.

id: string

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: object { arguments, name }

The function definition.

arguments: string

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

The name of the function.

type: "function"

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

type: "submit_tool_outputs"

For now, this is always submit_tool_outputs.

response_format: 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: number

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

status: "queued" or "in_progress" or "requires_action" or 6 more

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

One of the following:

"queued"

"in_progress"

"requires_action"

"cancelling"

"cancelled"

"failed"

"completed"

"incomplete"

"expired"

thread_id: string

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

tool_choice: 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: array of CodeInterpreterTool { type } or FileSearchTool { type, file_search } or FunctionTool { function, type }

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

One of the following:

CodeInterpreterTool = object { type }

type: "code_interpreter"

The type of tool being defined: code_interpreter

FileSearchTool = object { type, file_search }

type: "file_search"

The type of tool being defined: file_search

file_search: optional object { max_num_results, ranking_options }

Overrides for the file search tool.

max_num_results: optional number

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.

minimum1

maximum50

ranking_options: optional object { score_threshold, ranker }

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.

score_threshold: number

The score threshold for the file search. All values must be a floating point number between 0 and 1.

minimum0

maximum1

ranker: optional "auto" or "default_2024_08_21"

The ranker to use for the file search. If not specified will use the auto ranker.

One of the following:

"auto"

"default_2024_08_21"

FunctionTool = object { function, type }

function: FunctionDefinition { name, description, parameters, strict }

type: "function"

The type of tool being defined: function

truncation_strategy: object { type, last_messages }

Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.

type: "auto" or "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.

One of the following:

"auto"

"last_messages"

last_messages: optional number

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

minimum1

usage: object { completion_tokens, prompt_tokens, total_tokens }

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: number

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

prompt_tokens: number

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

total_tokens: number

Total number of tokens used (prompt + completion).

temperature: optional number

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

top_p: optional number

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

RunsSteps

Build Assistants that can call models and use tools.

List run steps

Deprecated

GET/threads/{thread_id}/runs/{run_id}/steps

Retrieve run step

Deprecated

GET/threads/{thread_id}/runs/{run_id}/steps/{step_id}

ModelsExpand Collapse

CodeInterpreterLogs = object { index, type, logs }

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

index: number

The index of the output in the outputs array.

type: "logs"

Always logs.

logs: optional string

The text output from the Code Interpreter tool call.

CodeInterpreterOutputImage = object { index, type, image }

index: number

The index of the output in the outputs array.

type: "image"

Always image.

image: optional object { file_id }

file_id: optional string

The file ID of the image.

CodeInterpreterToolCall = object { id, code_interpreter, type }

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

id: string

The ID of the tool call.

code_interpreter: object { input, outputs }

The Code Interpreter tool call definition.

input: string

The input to the Code Interpreter tool call.

outputs: array of object { logs, type } or object { image, 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.

One of the following:

CodeInterpreterLogOutput = object { logs, type }

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

logs: string

The text output from the Code Interpreter tool call.

type: "logs"

Always logs.

CodeInterpreterImageOutput = object { image, type }

image: object { file_id }

file_id: string

The file ID of the image.

type: "image"

Always image.

type: "code_interpreter"

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

CodeInterpreterToolCallDelta = object { index, type, id, code_interpreter }

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

index: number

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

type: "code_interpreter"

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

id: optional string

The ID of the tool call.

code_interpreter: optional object { input, outputs }

The Code Interpreter tool call definition.

input: optional string

The input to the Code Interpreter tool call.

outputs: optional array of CodeInterpreterLogs { index, type, logs } or CodeInterpreterOutputImage { index, type, image }

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.

One of the following:

CodeInterpreterLogs = object { index, type, logs }

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

index: number

The index of the output in the outputs array.

type: "logs"

Always logs.

logs: optional string

The text output from the Code Interpreter tool call.

CodeInterpreterOutputImage = object { index, type, image }

index: number

The index of the output in the outputs array.

type: "image"

Always image.

image: optional object { file_id }

file_id: optional string

The file ID of the image.

FileSearchToolCall = object { id, file_search, type }

id: string

The ID of the tool call object.

file_search: object { ranking_options, results }

For now, this is always going to be an empty object.

ranking_options: optional object { ranker, score_threshold }

The ranking options for the file search.

ranker: "auto" or "default_2024_08_21"

The ranker to use for the file search. If not specified will use the auto ranker.

One of the following:

"auto"

"default_2024_08_21"

score_threshold: number

The score threshold for the file search. All values must be a floating point number between 0 and 1.

minimum0

maximum1

results: optional array of object { file_id, file_name, score, content }

The results of the file search.

file_id: string

The ID of the file that result was found in.

file_name: string

The name of the file that result was found in.

score: number

The score of the result. All values must be a floating point number between 0 and 1.

minimum0

maximum1

content: optional array of object { text, type }

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

text: optional string

The text content of the file.

type: optional "text"

The type of the content.

type: "file_search"

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

FileSearchToolCallDelta = object { file_search, index, type, id }

file_search: unknown

For now, this is always going to be an empty object.

index: number

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

type: "file_search"

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

id: optional string

The ID of the tool call object.

FunctionToolCall = object { id, function, type }

id: string

The ID of the tool call object.

function: object { arguments, name, output }

The definition of the function that was called.

arguments: string

The arguments passed to the function.

The name of the function.

output: string

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

type: "function"

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

FunctionToolCallDelta = object { index, type, id, function }

index: number

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

type: "function"

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

id: optional string

The ID of the tool call object.

function: optional object { arguments, name, output }

The definition of the function that was called.

arguments: optional string

The arguments passed to the function.

The name of the function.

output: optional string

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

MessageCreationStepDetails = object { message_creation, type }

Details of the message creation by the run step.

message_creation: object { message_id }

message_id: string

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

type: "message_creation"

Always message_creation.

RunStep = object { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

id: string

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

assistant_id: string

The ID of the assistant associated with the run step.

cancelled_at: number

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

completed_at: number

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

created_at: number

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

expired_at: number

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

failed_at: number

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

last_error: object { code, message }

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

code: "server_error" or "rate_limit_exceeded"

One of server_error or rate_limit_exceeded.

One of the following:

"server_error"

"rate_limit_exceeded"

message: string

A human-readable description of the error.

metadata: Metadata

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

object: "thread.run.step"

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

run_id: string

The ID of the run that this run step is a part of.

status: "in_progress" or "cancelled" or "failed" or 2 more

The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.

One of the following:

"in_progress"

"cancelled"

"failed"

"completed"

"expired"

step_details: MessageCreationStepDetails { message_creation, type } or ToolCallsStepDetails { tool_calls, type }

The details of the run step.

One of the following:

MessageCreationStepDetails = object { message_creation, type }

Details of the message creation by the run step.

message_creation: object { message_id }

message_id: string

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

type: "message_creation"

Always message_creation.

ToolCallsStepDetails = object { tool_calls, type }

Details of the tool call.

tool_calls: array of CodeInterpreterToolCall { id, code_interpreter, type } or FileSearchToolCall { id, file_search, type } or FunctionToolCall { id, function, type }

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.

One of the following:

CodeInterpreterToolCall = object { id, code_interpreter, type }

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

id: string

The ID of the tool call.

code_interpreter: object { input, outputs }

The Code Interpreter tool call definition.

input: string

The input to the Code Interpreter tool call.

outputs: array of object { logs, type } or object { image, 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.

One of the following:

CodeInterpreterLogOutput = object { logs, type }

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

logs: string

The text output from the Code Interpreter tool call.

type: "logs"

Always logs.

CodeInterpreterImageOutput = object { image, type }

image: object { file_id }

file_id: string

The file ID of the image.

type: "image"

Always image.

type: "code_interpreter"

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

FileSearchToolCall = object { id, file_search, type }

id: string

The ID of the tool call object.

file_search: object { ranking_options, results }

For now, this is always going to be an empty object.

ranking_options: optional object { ranker, score_threshold }

The ranking options for the file search.

ranker: "auto" or "default_2024_08_21"

The ranker to use for the file search. If not specified will use the auto ranker.

One of the following:

"auto"

"default_2024_08_21"

score_threshold: number

The score threshold for the file search. All values must be a floating point number between 0 and 1.

minimum0

maximum1

results: optional array of object { file_id, file_name, score, content }

The results of the file search.

file_id: string

The ID of the file that result was found in.

file_name: string

The name of the file that result was found in.

score: number

The score of the result. All values must be a floating point number between 0 and 1.

minimum0

maximum1

content: optional array of object { text, type }

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

text: optional string

The text content of the file.

type: optional "text"

The type of the content.

type: "file_search"

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

FunctionToolCall = object { id, function, type }

id: string

The ID of the tool call object.

function: object { arguments, name, output }

The definition of the function that was called.

arguments: string

The arguments passed to the function.

The name of the function.

output: string

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

type: "function"

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

type: "tool_calls"

Always tool_calls.

thread_id: string

The ID of the thread that was run.

type: "message_creation" or "tool_calls"

The type of run step, which can be either message_creation or tool_calls.

One of the following:

"message_creation"

"tool_calls"

usage: object { completion_tokens, prompt_tokens, total_tokens }

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

completion_tokens: number

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

prompt_tokens: number

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

total_tokens: number

Total number of tokens used (prompt + completion).

RunStepDeltaEvent = object { id, delta, object }

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

id: string

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

delta: object { step_details }

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

step_details: optional RunStepDeltaMessageDelta { type, message_creation } or ToolCallDeltaObject { type, tool_calls }

The details of the run step.

One of the following:

RunStepDeltaMessageDelta = object { type, message_creation }

Details of the message creation by the run step.

type: "message_creation"

Always message_creation.

message_creation: optional object { message_id }

message_id: optional string

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

ToolCallDeltaObject = object { type, tool_calls }

Details of the tool call.

type: "tool_calls"

Always tool_calls.

tool_calls: optional array of CodeInterpreterToolCallDelta { index, type, id, code_interpreter } or FileSearchToolCallDelta { file_search, index, type, id } or FunctionToolCallDelta { index, type, id, 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.

One of the following:

CodeInterpreterToolCallDelta = object { index, type, id, code_interpreter }

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

index: number

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

type: "code_interpreter"

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

id: optional string

The ID of the tool call.

code_interpreter: optional object { input, outputs }

The Code Interpreter tool call definition.

input: optional string

The input to the Code Interpreter tool call.

outputs: optional array of CodeInterpreterLogs { index, type, logs } or CodeInterpreterOutputImage { index, type, image }

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.

One of the following:

CodeInterpreterLogs = object { index, type, logs }

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

index: number

The index of the output in the outputs array.

type: "logs"

Always logs.

logs: optional string

The text output from the Code Interpreter tool call.

CodeInterpreterOutputImage = object { index, type, image }

index: number

The index of the output in the outputs array.

type: "image"

Always image.

image: optional object { file_id }

file_id: optional string

The file ID of the image.

FileSearchToolCallDelta = object { file_search, index, type, id }

file_search: unknown

For now, this is always going to be an empty object.

index: number

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

type: "file_search"

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

id: optional string

The ID of the tool call object.

FunctionToolCallDelta = object { index, type, id, function }

index: number

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

type: "function"

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

id: optional string

The ID of the tool call object.

function: optional object { arguments, name, output }

The definition of the function that was called.

arguments: optional string

The arguments passed to the function.

The name of the function.

output: optional string

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

object: "thread.run.step.delta"

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

RunStepDeltaMessageDelta = object { type, message_creation }

Details of the message creation by the run step.

type: "message_creation"

Always message_creation.

message_creation: optional object { message_id }

message_id: optional string

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

RunStepInclude = "step_details.tool_calls[*].file_search.results[*].content"

ToolCallDeltaObject = object { type, tool_calls }

Details of the tool call.

type: "tool_calls"

Always tool_calls.

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.

One of the following:

CodeInterpreterToolCallDelta = object { index, type, id, code_interpreter }

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

index: number

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

type: "code_interpreter"

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

id: optional string

The ID of the tool call.

code_interpreter: optional object { input, outputs }

The Code Interpreter tool call definition.

input: optional string

The input to the Code Interpreter tool call.

outputs: optional array of CodeInterpreterLogs { index, type, logs } or CodeInterpreterOutputImage { index, type, image }

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.

One of the following:

CodeInterpreterLogs = object { index, type, logs }

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

index: number

The index of the output in the outputs array.

type: "logs"

Always logs.

logs: optional string

The text output from the Code Interpreter tool call.

CodeInterpreterOutputImage = object { index, type, image }

index: number

The index of the output in the outputs array.

type: "image"

Always image.

image: optional object { file_id }

file_id: optional string

The file ID of the image.

FileSearchToolCallDelta = object { file_search, index, type, id }

file_search: unknown

For now, this is always going to be an empty object.

index: number

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

type: "file_search"

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

id: optional string

The ID of the tool call object.

FunctionToolCallDelta = object { index, type, id, function }

index: number

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

type: "function"

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

id: optional string

The ID of the tool call object.

function: optional object { arguments, name, output }

The definition of the function that was called.

arguments: optional string

The arguments passed to the function.

The name of the function.

output: optional string

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

ToolCallsStepDetails = object { tool_calls, type }

Details of the tool call.

tool_calls: array of CodeInterpreterToolCall { id, code_interpreter, type } or FileSearchToolCall { id, file_search, type } or FunctionToolCall { id, function, type }

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.

One of the following:

CodeInterpreterToolCall = object { id, code_interpreter, type }

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

id: string

The ID of the tool call.

code_interpreter: object { input, outputs }

The Code Interpreter tool call definition.

input: string

The input to the Code Interpreter tool call.

outputs: array of object { logs, type } or object { image, 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.

One of the following:

CodeInterpreterLogOutput = object { logs, type }

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

logs: string

The text output from the Code Interpreter tool call.

type: "logs"

Always logs.

CodeInterpreterImageOutput = object { image, type }

image: object { file_id }

file_id: string

The file ID of the image.

type: "image"

Always image.

type: "code_interpreter"

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

FileSearchToolCall = object { id, file_search, type }

id: string

The ID of the tool call object.

file_search: object { ranking_options, results }

For now, this is always going to be an empty object.

ranking_options: optional object { ranker, score_threshold }

The ranking options for the file search.

ranker: "auto" or "default_2024_08_21"

The ranker to use for the file search. If not specified will use the auto ranker.

One of the following:

"auto"

"default_2024_08_21"

score_threshold: number

The score threshold for the file search. All values must be a floating point number between 0 and 1.

minimum0

maximum1

results: optional array of object { file_id, file_name, score, content }

The results of the file search.

file_id: string

The ID of the file that result was found in.

file_name: string

The name of the file that result was found in.

score: number

The score of the result. All values must be a floating point number between 0 and 1.

minimum0

maximum1

content: optional array of object { text, type }

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

text: optional string

The text content of the file.

type: optional "text"

The type of the content.

type: "file_search"

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

FunctionToolCall = object { id, function, type }

id: string

The ID of the tool call object.

function: object { arguments, name, output }

The definition of the function that was called.

arguments: string

The arguments passed to the function.

The name of the function.

output: string

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

type: "function"

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

type: "tool_calls"

Always tool_calls.

Suggested

Runs

ModelsExpand Collapse

RunsSteps

ModelsExpand Collapse