Threads
Build Assistants that can call models and use tools.
Models
AssistantResponseFormatOption = "auto" or ResponseFormatText { type } or ResponseFormatJSONObject { type } or ResponseFormatJSONSchema { json_schema, type } 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.
AssistantResponseFormatOption = "auto" or ResponseFormatText { type } or ResponseFormatJSONObject { type } or ResponseFormatJSONSchema { json_schema, type }
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.
One of the following: "auto" auto is the default value
ResponseFormatText { type } Default response format. Used to generate text responses.
type: "text" The type of response format being defined. Always text.
ResponseFormatJSONObject { type } JSON object response format. An older method of generating JSON responses.
Using json_schema is recommended for models that support it. Note that the
model will not generate JSON without a system or user message instructing it
to do so.
type: "json_object" The type of response format being defined. Always json_object.
ResponseFormatJSONSchema { json_schema, type } JSON Schema response format. Used to generate structured JSON responses.
Learn more about Structured Outputs.
json_schema: { name, description, schema, strict } Structured Outputs configuration options, including a JSON Schema.
name: string The name of the response format. Must be a-z, A-Z, 0-9, or contain
underscores and dashes, with a maximum length of 64.
description: optional string A description of what the response format is for, used by the model to
determine how to respond in the format.
schema: optional map[unknown] The schema for the response format, described as a JSON Schema object.
Learn how to build JSON schemas here.
strict: optional boolean or null (default: false) Whether to enable strict schema adherence when generating the output.
If set to true, the model will always follow the exact schema defined
in the schema field. Only a subset of JSON Schema is supported when
strict is true. To learn more, read the Structured Outputs
guide.
type: "json_schema" The type of response format being defined. Always json_schema.
AssistantToolChoice object { type, function } Specifies a tool the model should use. Use to force the model to call a specific tool.
AssistantToolChoice object { type, function }
Specifies a tool the model should use. Use to force the model to call a specific tool.
type: "function" or "code_interpreter" or "file_search" The type of the tool. If type is function, the function name must be set
One of the following: "function" "code_interpreter" "file_search" function: optional AssistantToolChoiceFunction { name }
AssistantToolChoiceOption = "none" or "auto" or "required" or AssistantToolChoice { type, function } 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.
AssistantToolChoiceOption = "none" or "auto" or "required" or AssistantToolChoice { type, function }
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.
One of the following: "none" or "auto" or "required" none means the model will not call any tools and instead generates a message. auto 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.
One of the following: "none" "auto" "required" AssistantToolChoice { type, function } Specifies a tool the model should use. Use to force the model to call a specific tool.
type: "function" or "code_interpreter" or "file_search" The type of the tool. If type is function, the function name must be set
One of the following: "function" "code_interpreter" "file_search" function: optional AssistantToolChoiceFunction { name }
Thread object { id, created_at, metadata, 2 more } Represents a thread that contains messages.
Thread object { id, created_at, metadata, 2 more }
Represents a thread that contains messages.
id: string The identifier, which can be referenced in API endpoints.
created_at: integer The Unix timestamp (in seconds) for when the thread was created.
formatunixtime metadata: Metadata or null 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: "thread" The object type, which is always thread.
tool_resources: object or null 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.
code_interpreter: optional { file_ids } file_ids: optional array of string (default: []) A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool.
maxItems20 file_search: optional { vector_store_ids } vector_store_ids: optional array of string The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.
maxItems1
ThreadsMessages
Build Assistants that can call models and use tools.
Models
FileCitationAnnotation object { end_index, file_citation, start_index, 2 more } A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.
FileCitationAnnotation object { end_index, file_citation, start_index, 2 more }
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.
end_index: integer minimum0 file_citation: { file_id } file_id: string The ID of the specific File the citation is from.
start_index: integer minimum0 text: string The text in the message content that needs to be replaced.
type: "file_citation" Always file_citation.
FileCitationDeltaAnnotation object { index, type, end_index, 3 more } A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.
FileCitationDeltaAnnotation object { index, type, end_index, 3 more }
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.
index: integer The index of the annotation in the text content part.
type: "file_citation" Always file_citation.
end_index: optional integer minimum0 file_citation: optional { file_id, quote } file_id: optional string The ID of the specific File the citation is from.
quote: optional string The specific quote in the file.
start_index: optional integer minimum0 text: optional string The text in the message content that needs to be replaced.
FilePathAnnotation object { end_index, file_path, start_index, 2 more } A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file.
FilePathAnnotation object { end_index, file_path, start_index, 2 more }
A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file.
end_index: integer minimum0 file_path: { file_id } file_id: string The ID of the file that was generated.
start_index: integer minimum0 text: string The text in the message content that needs to be replaced.
type: "file_path" Always file_path.
FilePathDeltaAnnotation object { index, type, end_index, 3 more } A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file.
FilePathDeltaAnnotation object { index, type, end_index, 3 more }
A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file.
index: integer The index of the annotation in the text content part.
type: "file_path" Always file_path.
end_index: optional integer minimum0 file_path: optional { file_id } file_id: optional string The ID of the file that was generated.
start_index: optional integer minimum0 text: optional string The text in the message content that needs to be replaced.
ImageFile object { file_id, detail }
ImageFile object { file_id, detail }
file_id: string The File ID of the image in the message content. Set purpose="vision" when uploading the File if you need to later display the file content.
detail: optional "auto" or "low" or "high" (default: "auto") Specifies the detail level of the image if specified by the user. low uses fewer tokens, you can opt in to high resolution using high.
One of the following: "auto" "low" "high"
ImageFileDelta object { detail, file_id }
ImageFileDelta object { detail, file_id }
detail: optional "auto" or "low" or "high" (default: "auto") Specifies the detail level of the image if specified by the user. low uses fewer tokens, you can opt in to high resolution using high.
One of the following: "auto" "low" "high" file_id: optional string The File ID of the image in the message content. Set purpose="vision" when uploading the File if you need to later display the file content.
ImageFileDeltaBlock object { index, type, image_file } References an image File in the content of a message.
ImageFileDeltaBlock object { index, type, image_file }
References an image File in the content of a message.
index: integer The index of the content part in the message.
type: "image_file" Always image_file.
image_file: optional ImageFileDelta { detail, file_id }
ImageURL object { url, detail }
ImageURL object { url, detail }
url: string The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.
formaturi detail: optional "auto" or "low" or "high" (default: "auto") Specifies the detail level of the image. low uses fewer tokens, you can opt in to high resolution using high. Default value is auto
One of the following: "auto" "low" "high"
ImageURLDelta object { detail, url }
ImageURLDelta object { detail, url }
detail: optional "auto" or "low" or "high" (default: "auto") Specifies the detail level of the image. low uses fewer tokens, you can opt in to high resolution using high.
One of the following: "auto" "low" "high" url: optional string The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.
formaturi
Message object { id, assistant_id, attachments, 11 more } Represents a message within a thread.
Message object { id, assistant_id, attachments, 11 more }
Represents a message within a thread.
id: string The identifier, which can be referenced in API endpoints.
assistant_id: string or null If applicable, the ID of the assistant that authored this message.
attachments: array of object or null A list of files attached to the message, and the tools they were added to.
file_id: optional string The ID of the file to attach to the message.
tools: optional array of CodeInterpreterTool or FileSearchTool The tools to add this file to.
One of the following: CodeInterpreterTool { type } type: "code_interpreter" The type of tool being defined: code_interpreter
FileSearchTool { type } type: "file_search" The type of tool being defined: file_search
completed_at: integer or null The Unix timestamp (in seconds) for when the message was completed.
formatunixtime content: array of ImageFileContentBlock or ImageURLContentBlock or TextContentBlock or RefusalContentBlock The content of the message in array of text and/or images.
One of the following: ImageFileContentBlock { image_file, type } References an image File in the content of a message.
image_file: ImageFile { file_id, detail } type: "image_file" Always image_file.
ImageURLContentBlock { image_url, type } References an image URL in the content of a message.
image_url: ImageURL { url, detail } type: "image_url" The type of the content part.
TextContentBlock { text, type } The text content that is part of a message.
text: Text { annotations, value } type: "text" Always text.
RefusalContentBlock { refusal, type } The refusal content generated by the assistant.
refusal: string type: "refusal" Always refusal.
created_at: integer The Unix timestamp (in seconds) for when the message was created.
formatunixtime incomplete_at: integer or null The Unix timestamp (in seconds) for when the message was marked as incomplete.
formatunixtime incomplete_details: object or null On an incomplete message, details about why the message is incomplete.
reason: "content_filter" or "max_tokens" or "run_cancelled" or 2 more The reason the message is incomplete.
One of the following: "content_filter" "max_tokens" "run_cancelled" "run_expired" "run_failed" metadata: Metadata or null 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: "thread.message" The object type, which is always thread.message.
role: "user" or "assistant" The entity that produced the message. One of user or assistant.
One of the following: "user" "assistant" run_id: string or null The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.
status: "in_progress" or "incomplete" or "completed" The status of the message, which can be either in_progress, incomplete, or completed.
One of the following: "in_progress" "incomplete" "completed" thread_id: string The thread ID that this message belongs to.
MessageDelta object { content, role } The delta containing the fields that have changed on the Message.
MessageDelta object { content, role }
The delta containing the fields that have changed on the Message.
content: optional array of ImageFileDeltaBlock or TextDeltaBlock or RefusalDeltaBlock or ImageURLDeltaBlock The content of the message in array of text and/or images.
One of the following: ImageFileDeltaBlock { index, type, image_file } References an image File in the content of a message.
index: integer The index of the content part in the message.
type: "image_file" Always image_file.
image_file: optional ImageFileDelta { detail, file_id } TextDeltaBlock { index, type, text } The text content that is part of a message.
index: integer The index of the content part in the message.
type: "text" Always text.
text: optional TextDelta { annotations, value } RefusalDeltaBlock { index, type, refusal } The refusal content that is part of a message.
index: integer The index of the refusal part in the message.
type: "refusal" Always refusal.
refusal: optional string ImageURLDeltaBlock { index, type, image_url } References an image URL in the content of a message.
index: integer The index of the content part in the message.
type: "image_url" Always image_url.
image_url: optional ImageURLDelta { detail, url } role: optional "user" or "assistant" The entity that produced the message. One of user or assistant.
One of the following: "user" "assistant"
MessageDeltaEvent object { id, delta, object } Represents a message delta i.e. any changed fields on a message during streaming.
MessageDeltaEvent object { id, delta, object }
Represents a message delta i.e. any changed fields on a message during streaming.
id: string The identifier of the message, which can be referenced in API endpoints.
delta: MessageDelta { content, role } The delta containing the fields that have changed on the Message.
object: "thread.message.delta" The object type, which is always thread.message.delta.
Text object { annotations, value }
Text object { annotations, value }
annotations: array of FileCitationAnnotation or FilePathAnnotation One of the following: FileCitationAnnotation { end_index, file_citation, start_index, 2 more } A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.
end_index: integer minimum0 file_citation: { file_id } file_id: string The ID of the specific File the citation is from.
start_index: integer minimum0 text: string The text in the message content that needs to be replaced.
type: "file_citation" Always file_citation.
FilePathAnnotation { end_index, file_path, start_index, 2 more } A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file.
end_index: integer minimum0 file_path: { file_id } file_id: string The ID of the file that was generated.
start_index: integer minimum0 text: string The text in the message content that needs to be replaced.
type: "file_path" Always file_path.
value: string The data that makes up the text.
TextDelta object { annotations, value }
TextDelta object { annotations, value }
annotations: optional array of FileCitationDeltaAnnotation or FilePathDeltaAnnotation One of the following: FileCitationDeltaAnnotation { index, type, end_index, 3 more } A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.
index: integer The index of the annotation in the text content part.
type: "file_citation" Always file_citation.
end_index: optional integer minimum0 file_citation: optional { file_id, quote } file_id: optional string The ID of the specific File the citation is from.
quote: optional string The specific quote in the file.
start_index: optional integer minimum0 text: optional string The text in the message content that needs to be replaced.
FilePathDeltaAnnotation { index, type, end_index, 3 more } A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file.
index: integer The index of the annotation in the text content part.
type: "file_path" Always file_path.
end_index: optional integer minimum0 file_path: optional { file_id } file_id: optional string The ID of the file that was generated.
start_index: optional integer minimum0 text: optional string The text in the message content that needs to be replaced.
value: optional string The data that makes up the text.
ThreadsRuns
Build Assistants that can call models and use tools.
Models
RequiredActionFunctionToolCall object { id, function, type } Tool call objects
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: { arguments, name } The function definition.
arguments: string The arguments that the model expects you to pass to the function.
name: string 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.
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: integer or null The Unix timestamp (in seconds) for when the run was cancelled.
formatunixtime completed_at: integer or null The Unix timestamp (in seconds) for when the run was completed.
formatunixtime created_at: integer The Unix timestamp (in seconds) for when the run was created.
formatunixtime expires_at: integer or null The Unix timestamp (in seconds) for when the run will expire.
formatunixtime failed_at: integer or null The Unix timestamp (in seconds) for when the run failed.
formatunixtime incomplete_details: object or null 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 or null 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: integer or null The maximum number of completion tokens specified to have been used over the course of the run.
minimum256 max_prompt_tokens: integer or null The maximum number of prompt tokens specified to have been used over the course of the run.
minimum256 metadata: Metadata or null 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 (default: true) Whether to enable parallel function calling during tool use.
required_action: object or null Details on the action required to continue the run. Will be null if no action is required.
submit_tool_outputs: { 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: { arguments, name } The function definition.
arguments: string The arguments that the model expects you to pass to the function.
name: string 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 or null 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: integer or null The Unix timestamp (in seconds) for when the run was started.
formatunixtime 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 or null 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 or FileSearchTool or FunctionTool (default: []) The list of tools that the assistant used for this run.
maxItems20 One of the following: CodeInterpreterTool { type } type: "code_interpreter" The type of tool being defined: code_interpreter
FileSearchTool { type, file_search } type: "file_search" The type of tool being defined: file_search
file_search: optional { max_num_results, ranking_options } Overrides for the file search tool.
max_num_results: optional integer 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 { 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 { function, type } function: FunctionDefinition { name, description, parameters, strict } type: "function" The type of tool being defined: function
truncation_strategy: object or null 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 integer or null The number of most recent messages from the thread when constructing the context for the run.
minimum1 usage: object or null 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: integer Number of completion tokens used over the course of the run.
prompt_tokens: integer Number of prompt tokens used over the course of the run.
total_tokens: integer Total number of tokens used (prompt + completion).
temperature: optional number or null The sampling temperature used for this run. If not set, defaults to 1.
top_p: optional number or null The nucleus sampling value used for this run. If not set, defaults to 1.
ThreadsRunsSteps
Build Assistants that can call models and use tools.
Models
CodeInterpreterToolCall object { id, code_interpreter, type } Details of the Code Interpreter tool call the run step was involved in.
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: { input, outputs } The Code Interpreter tool call definition.
input: string The input to the Code Interpreter tool call.
outputs: array of CodeInterpreterLogOutput or CodeInterpreterImageOutput 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 { 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 { image, type } image: { 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.
CodeInterpreterToolCallDelta object { index, type, id, code_interpreter }
Details of the Code Interpreter tool call the run step was involved in.
index: integer 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 { input, outputs } The Code Interpreter tool call definition.
input: optional string The input to the Code Interpreter tool call.
outputs: optional array of CodeInterpreterLogs or CodeInterpreterOutputImage 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 { index, type, logs } Text output from the Code Interpreter tool call as part of a run step.
index: integer 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 { index, type, image } index: integer The index of the output in the outputs array.
type: "image" Always image.
image: optional { file_id } file_id: optional string The file ID of the image.
FileSearchToolCall object { id, file_search, type }
FileSearchToolCall object { id, file_search, type }
id: string The ID of the tool call object.
file_search: { ranking_options, results } For now, this is always going to be an empty object.
ranking_options: optional { 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 { 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 { 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 }
FileSearchToolCallDelta object { file_search, index, type, id }
file_search: unknown For now, this is always going to be an empty object.
index: integer 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 }
FunctionToolCall object { id, function, type }
id: string The ID of the tool call object.
function: { arguments, name, output } The definition of the function that was called.
arguments: string The arguments passed to the function.
name: string The name of the function.
output: string or null 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 }
FunctionToolCallDelta object { index, type, id, function }
index: integer 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 { arguments, name, output } The definition of the function that was called.
arguments: optional string The arguments passed to the function.
name: optional string The name of the function.
output: optional string or null The output of the function. This will be null if the outputs have not been submitted yet.
RunStep object { id, assistant_id, cancelled_at, 13 more } Represents a step in execution of a run.
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: integer or null The Unix timestamp (in seconds) for when the run step was cancelled.
formatunixtime completed_at: integer or null The Unix timestamp (in seconds) for when the run step completed.
formatunixtime created_at: integer The Unix timestamp (in seconds) for when the run step was created.
formatunixtime expired_at: integer or null The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.
formatunixtime failed_at: integer or null The Unix timestamp (in seconds) for when the run step failed.
formatunixtime last_error: object or null 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 or null 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: "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 or ToolCallsStepDetails The details of the run step.
One of the following: MessageCreationStepDetails { message_creation, type } Details of the message creation by the run step.
message_creation: { message_id } message_id: string The ID of the message that was created by this run step.
type: "message_creation" Always message_creation.
ToolCallsStepDetails { tool_calls, type } Details of the tool call.
tool_calls: array of CodeInterpreterToolCall or FileSearchToolCall or FunctionToolCall 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 { 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: { input, outputs } The Code Interpreter tool call definition.
input: string The input to the Code Interpreter tool call.
outputs: array of CodeInterpreterLogOutput or CodeInterpreterImageOutput 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 { 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 { image, type } image: { 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 { id, file_search, type } id: string The ID of the tool call object.
file_search: { ranking_options, results } For now, this is always going to be an empty object.
ranking_options: optional { 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 { 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 { 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 { id, function, type } id: string The ID of the tool call object.
function: { arguments, name, output } The definition of the function that was called.
arguments: string The arguments passed to the function.
name: string The name of the function.
output: string or null 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 or null Usage statistics related to the run step. This value will be null while the run step’s status is in_progress.
completion_tokens: integer Number of completion tokens used over the course of the run step.
prompt_tokens: integer Number of prompt tokens used over the course of the run step.
total_tokens: integer 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.
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: { step_details } The delta containing the fields that have changed on the run step.
step_details: optional RunStepDeltaMessageDelta or ToolCallDeltaObject The details of the run step.
One of the following: RunStepDeltaMessageDelta { type, message_creation } Details of the message creation by the run step.
type: "message_creation" Always message_creation.
message_creation: optional { message_id } message_id: optional string The ID of the message that was created by this run step.
ToolCallDeltaObject { type, tool_calls } Details of the tool call.
type: "tool_calls" Always tool_calls.
tool_calls: optional array of CodeInterpreterToolCallDelta or FileSearchToolCallDelta or FunctionToolCallDelta 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 { index, type, id, code_interpreter } Details of the Code Interpreter tool call the run step was involved in.
index: integer 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 { input, outputs } The Code Interpreter tool call definition.
input: optional string The input to the Code Interpreter tool call.
outputs: optional array of CodeInterpreterLogs or CodeInterpreterOutputImage 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 { index, type, logs } Text output from the Code Interpreter tool call as part of a run step.
index: integer 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 { index, type, image } index: integer The index of the output in the outputs array.
type: "image" Always image.
image: optional { file_id } file_id: optional string The file ID of the image.
FileSearchToolCallDelta { file_search, index, type, id } file_search: unknown For now, this is always going to be an empty object.
index: integer 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 { index, type, id, function } index: integer 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 { arguments, name, output } The definition of the function that was called.
arguments: optional string The arguments passed to the function.
name: optional string The name of the function.
output: optional string or null 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.
ToolCallDeltaObject object { type, tool_calls } Details of the tool call.
ToolCallDeltaObject object { type, tool_calls }
Details of the tool call.
type: "tool_calls" Always tool_calls.
tool_calls: optional array of CodeInterpreterToolCallDelta or FileSearchToolCallDelta or FunctionToolCallDelta 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 { index, type, id, code_interpreter } Details of the Code Interpreter tool call the run step was involved in.
index: integer 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 { input, outputs } The Code Interpreter tool call definition.
input: optional string The input to the Code Interpreter tool call.
outputs: optional array of CodeInterpreterLogs or CodeInterpreterOutputImage 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 { index, type, logs } Text output from the Code Interpreter tool call as part of a run step.
index: integer 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 { index, type, image } index: integer The index of the output in the outputs array.
type: "image" Always image.
image: optional { file_id } file_id: optional string The file ID of the image.
FileSearchToolCallDelta { file_search, index, type, id } file_search: unknown For now, this is always going to be an empty object.
index: integer 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 { index, type, id, function } index: integer 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 { arguments, name, output } The definition of the function that was called.
arguments: optional string The arguments passed to the function.
name: optional string The name of the function.
output: optional string or null 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.
ToolCallsStepDetails object { tool_calls, type }
Details of the tool call.
tool_calls: array of CodeInterpreterToolCall or FileSearchToolCall or FunctionToolCall 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 { 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: { input, outputs } The Code Interpreter tool call definition.
input: string The input to the Code Interpreter tool call.
outputs: array of CodeInterpreterLogOutput or CodeInterpreterImageOutput 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 { 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 { image, type } image: { 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 { id, file_search, type } id: string The ID of the tool call object.
file_search: { ranking_options, results } For now, this is always going to be an empty object.
ranking_options: optional { 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 { 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 { 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 { id, function, type } id: string The ID of the tool call object.
function: { arguments, name, output } The definition of the function that was called.
arguments: string The arguments passed to the function.
name: string The name of the function.
output: string or null 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.