API Reference

Beta

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Threads

Create thread

Deprecated

beta.threads.create(**kwargs) -> Thread { id, created_at, metadata, 2 more }

POST/threads

Create thread and run

Deprecated

beta.threads.create_and_run(**kwargs) -> Run { id, assistant_id, cancelled_at, 24 more }

POST/threads/runs

Retrieve thread

Deprecated

beta.threads.retrieve(thread_id) -> Thread { id, created_at, metadata, 2 more }

GET/threads/{thread_id}

Modify thread

Deprecated

beta.threads.update(thread_id, **kwargs) -> Thread { id, created_at, metadata, 2 more }

POST/threads/{thread_id}

Delete thread

Deprecated

beta.threads.delete(thread_id) -> ThreadDeleted { id, deleted, object }

DELETE/threads/{thread_id}

ModelsExpand Collapse

AssistantResponseFormatOption = :auto | ResponseFormatText { type } | ResponseFormatJSONObject { type } | 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.

Accepts one of the following:

AssistantResponseFormatOption = :auto

auto is the default value

class ResponseFormatText { type }

Default response format. Used to generate text responses.

type: :text

The type of response format being defined. Always text.

class 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.

class 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: String

A description of what the response format is for, used by the model to determine how to respond in the format.

schema: Hash[Symbol, untyped]

The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

strict: bool

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.

class AssistantToolChoice { type, function }

Specifies a tool the model should use. Use to force the model to call a specific tool.

type: :function | :code_interpreter | :file_search

The type of the tool. If type is function, the function name must be set

Accepts one of the following:

:function

:code_interpreter

:file_search

function: AssistantToolChoiceFunction { name }

class AssistantToolChoiceFunction { name }

name: String

The name of the function to call.

AssistantToolChoiceOption = :none | :auto | :required | 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.

Accepts one of the following:

Auto = :none | :auto | :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.

Accepts one of the following:

:none

:auto

:required

class AssistantToolChoice { type, function }

Specifies a tool the model should use. Use to force the model to call a specific tool.

type: :function | :code_interpreter | :file_search

The type of the tool. If type is function, the function name must be set

Accepts one of the following:

:function

:code_interpreter

:file_search

function: AssistantToolChoiceFunction { name }

class Thread { 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.

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.

object: :thread

The object type, which is always thread.

tool_resources: { code_interpreter, file_search}

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: { file_ids}

file_ids: Array[String]

A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool.

file_search: { vector_store_ids}

vector_store_ids: Array[String]

The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.

class ThreadDeleted { id, deleted, object }

id: String

deleted: bool

object: :"thread.deleted"

ThreadsRuns

List runs

Deprecated

beta.threads.runs.list(thread_id, **kwargs) -> CursorPage<Run { id, assistant_id, cancelled_at, 24 more } >

GET/threads/{thread_id}/runs

Create run

Deprecated

beta.threads.runs.create(thread_id, **kwargs) -> Run { id, assistant_id, cancelled_at, 24 more }

POST/threads/{thread_id}/runs

Retrieve run

Deprecated

beta.threads.runs.retrieve(run_id, **kwargs) -> Run { id, assistant_id, cancelled_at, 24 more }

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

Modify run

Deprecated

beta.threads.runs.update(run_id, **kwargs) -> Run { id, assistant_id, cancelled_at, 24 more }

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

Submit tool outputs to run

Deprecated

beta.threads.runs.submit_tool_outputs(run_id, **kwargs) -> Run { id, assistant_id, cancelled_at, 24 more }

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

Cancel a run

Deprecated

beta.threads.runs.cancel(run_id, **kwargs) -> Run { id, assistant_id, cancelled_at, 24 more }

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

ModelsExpand Collapse

class RequiredActionFunctionToolCall { 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.

class Run { 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

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

completed_at: Integer

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

created_at: Integer

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

expires_at: Integer

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

failed_at: Integer

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

incomplete_details: { reason}

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

reason: :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: String

The instructions that the assistant used for this run.

last_error: { code, message}

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

code: :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: String

A human-readable description of the error.

max_completion_tokens: Integer

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

minimum256

max_prompt_tokens: Integer

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

Whether to enable parallel function calling during tool use.

required_action: { submit_tool_outputs, type}

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[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

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

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: 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[AssistantTool]

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

Accepts one of the following:

class CodeInterpreterTool { type }

type: :code_interpreter

The type of tool being defined: code_interpreter

class FileSearchTool { type, file_search }

type: :file_search

The type of tool being defined: file_search

file_search: { max_num_results, ranking_options}

Overrides for the file search tool.

max_num_results: 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: { 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: Float

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

minimum0

maximum1

ranker: :auto | :default_2024_08_21

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

Accepts one of the following:

:auto

:default_2024_08_21

class FunctionTool { function, type }

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

type: :function

The type of tool being defined: function

truncation_strategy: { 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 | :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: Integer

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

minimum1

usage: { 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: 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: Float

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

top_p: Float

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

RunStatus = :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

ThreadsRunsSteps

List run steps

Deprecated

beta.threads.runs.steps.list(run_id, **kwargs) -> CursorPage<RunStep { id, assistant_id, cancelled_at, 13 more } >

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

Retrieve run step

Deprecated

beta.threads.runs.steps.retrieve(step_id, **kwargs) -> RunStep { id, assistant_id, cancelled_at, 13 more }

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

ModelsExpand Collapse

class 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: String

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage { index, type, image }

index: Integer

The index of the output in the outputs array.

type: :image

Always image.

image: { file_id}

file_id: String

The file ID of the image.

class 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[{ logs, type} | { 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.

Accepts one of the following:

class Logs { 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.

class Image { 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.

class 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: 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[CodeInterpreterLogs { index, type, logs } | 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.

Accepts one of the following:

class 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: String

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage { index, type, image }

index: Integer

The index of the output in the outputs array.

type: :image

Always image.

image: { file_id}

file_id: String

The file ID of the image.

class 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: { ranker, score_threshold}

The ranking options for the file search.

ranker: :auto | :default_2024_08_21

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

Accepts one of the following:

:auto

:default_2024_08_21

score_threshold: Float

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

minimum0

maximum1

results: Array[{ 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: Float

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

minimum0

maximum1

content: Array[{ text, type}]

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

text: String

The text content of the file.

type: :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.

class FileSearchToolCallDelta { file_search, index, type, id }

file_search: untyped

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

The ID of the tool call object.

class 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

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.

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

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

class 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.

class RunStep { 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

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

completed_at: Integer

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

created_at: Integer

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

expired_at: Integer

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

failed_at: Integer

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

last_error: { code, message}

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

code: :server_error | :rate_limit_exceeded

One of server_error or rate_limit_exceeded.

Accepts one of the following:

:server_error

:rate_limit_exceeded

message: String

A human-readable description of the error.

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.

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 | :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: MessageCreationStepDetails { message_creation, type } | ToolCallsStepDetails { tool_calls, type }

The details of the run step.

Accepts one of the following:

class 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.

class ToolCallsStepDetails { tool_calls, type }

Details of the tool call.

tool_calls: Array[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 { 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[{ logs, type} | { 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.

Accepts one of the following:

class Logs { 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.

class Image { 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.

class 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: { ranker, score_threshold}

The ranking options for the file search.

ranker: :auto | :default_2024_08_21

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

Accepts one of the following:

:auto

:default_2024_08_21

score_threshold: Float

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

minimum0

maximum1

results: Array[{ 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: Float

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

minimum0

maximum1

content: Array[{ text, type}]

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

text: String

The text content of the file.

type: :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.

class 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

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 | :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: { 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: 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).

class RunStepDelta { step_details }

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

step_details: RunStepDeltaMessageDelta { type, message_creation } | ToolCallDeltaObject { type, tool_calls }

The details of the run step.

Accepts one of the following:

class RunStepDeltaMessageDelta { type, message_creation }

Details of the message creation by the run step.

type: :message_creation

Always message_creation.

message_creation: { message_id}

message_id: String

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

class ToolCallDeltaObject { type, tool_calls }

Details of the tool call.

type: :tool_calls

Always tool_calls.

tool_calls: Array[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 { 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: 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[CodeInterpreterLogs { index, type, logs } | 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.

Accepts one of the following:

class 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: String

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage { index, type, image }

index: Integer

The index of the output in the outputs array.

type: :image

Always image.

image: { file_id}

file_id: String

The file ID of the image.

class FileSearchToolCallDelta { file_search, index, type, id }

file_search: untyped

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

The ID of the tool call object.

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

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

class RunStepDeltaEvent { 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: RunStepDelta { step_details }

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

object: :"thread.run.step.delta"

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

class RunStepDeltaMessageDelta { type, message_creation }

Details of the message creation by the run step.

type: :message_creation

Always message_creation.

message_creation: { message_id}

message_id: String

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

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

ToolCall = CodeInterpreterToolCall { id, code_interpreter, type } | FileSearchToolCall { id, file_search, type } | FunctionToolCall { id, function, type }

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

Accepts one of the following:

class 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[{ logs, type} | { 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.

Accepts one of the following:

class Logs { 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.

class Image { 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.

class 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: { ranker, score_threshold}

The ranking options for the file search.

ranker: :auto | :default_2024_08_21

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

Accepts one of the following:

:auto

:default_2024_08_21

score_threshold: Float

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

minimum0

maximum1

results: Array[{ 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: Float

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

minimum0

maximum1

content: Array[{ text, type}]

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

text: String

The text content of the file.

type: :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.

class 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

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.

ToolCallDelta = CodeInterpreterToolCallDelta { index, type, id, code_interpreter } | FileSearchToolCallDelta { file_search, index, type, id } | FunctionToolCallDelta { index, type, id, function }

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

Accepts one of the following:

class 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: 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[CodeInterpreterLogs { index, type, logs } | 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.

Accepts one of the following:

class 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: String

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage { index, type, image }

index: Integer

The index of the output in the outputs array.

type: :image

Always image.

image: { file_id}

file_id: String

The file ID of the image.

class FileSearchToolCallDelta { file_search, index, type, id }

file_search: untyped

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

The ID of the tool call object.

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

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

class ToolCallDeltaObject { type, tool_calls }

Details of the tool call.

type: :tool_calls

Always tool_calls.

tool_calls: Array[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 { 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: 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[CodeInterpreterLogs { index, type, logs } | 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.

Accepts one of the following:

class 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: String

The text output from the Code Interpreter tool call.

class CodeInterpreterOutputImage { index, type, image }

index: Integer

The index of the output in the outputs array.

type: :image

Always image.

image: { file_id}

file_id: String

The file ID of the image.

class FileSearchToolCallDelta { file_search, index, type, id }

file_search: untyped

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

The ID of the tool call object.

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

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

class ToolCallsStepDetails { tool_calls, type }

Details of the tool call.

tool_calls: Array[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 { 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[{ logs, type} | { 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.

Accepts one of the following:

class Logs { 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.

class Image { 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.

class 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: { ranker, score_threshold}

The ranking options for the file search.

ranker: :auto | :default_2024_08_21

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

Accepts one of the following:

:auto

:default_2024_08_21

score_threshold: Float

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

minimum0

maximum1

results: Array[{ 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: Float

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

minimum0

maximum1

content: Array[{ text, type}]

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

text: String

The text content of the file.

type: :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.

class 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

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.

ThreadsMessages

List messages

Deprecated

beta.threads.messages.list(thread_id, **kwargs) -> CursorPage<Message { id, assistant_id, attachments, 11 more } >

GET/threads/{thread_id}/messages

Create message

Deprecated

beta.threads.messages.create(thread_id, **kwargs) -> Message { id, assistant_id, attachments, 11 more }

POST/threads/{thread_id}/messages

Modify message

Deprecated

beta.threads.messages.update(message_id, **kwargs) -> Message { id, assistant_id, attachments, 11 more }

POST/threads/{thread_id}/messages/{message_id}

Retrieve message

Deprecated

beta.threads.messages.retrieve(message_id, **kwargs) -> Message { id, assistant_id, attachments, 11 more }

GET/threads/{thread_id}/messages/{message_id}

Delete message

Deprecated

beta.threads.messages.delete(message_id, **kwargs) -> MessageDeleted { id, deleted, object }

DELETE/threads/{thread_id}/messages/{message_id}

ModelsExpand Collapse

Annotation = FileCitationAnnotation { end_index, file_citation, start_index, 2 more } | FilePathAnnotation { end_index, file_path, 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.

Accepts one of the following:

class 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.

class 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.

AnnotationDelta = FileCitationDeltaAnnotation { index, type, end_index, 3 more } | FilePathDeltaAnnotation { 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.

Accepts one of the following:

class 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: Integer

minimum0

file_citation: { file_id, quote}

file_id: String

The ID of the specific File the citation is from.

quote: String

The specific quote in the file.

start_index: Integer

minimum0

text: String

The text in the message content that needs to be replaced.

class 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: 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.

class 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.

class 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: Integer

minimum0

file_citation: { file_id, quote}

file_id: String

The ID of the specific File the citation is from.

quote: String

The specific quote in the file.

start_index: Integer

minimum0

text: String

The text in the message content that needs to be replaced.

class 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.

class 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: 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.

class ImageFile { 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: :auto | :low | :high

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.

Accepts one of the following:

:auto

:low

:high

class 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.

class ImageFileDelta { detail, file_id }

detail: :auto | :low | :high

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.

Accepts one of the following:

:auto

:low

:high

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.

class 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: ImageFileDelta { detail, file_id }

class ImageURL { url, detail }

url: String

The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.

formaturi

detail: :auto | :low | :high

Specifies the detail level of the image. low uses fewer tokens, you can opt in to high resolution using high. Default value is auto

Accepts one of the following:

:auto

:low

:high

class 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.

class ImageURLDelta { detail, url }

detail: :auto | :low | :high

Specifies the detail level of the image. low uses fewer tokens, you can opt in to high resolution using high.

Accepts one of the following:

:auto

:low

:high

url: String

The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.

class 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: ImageURLDelta { detail, url }

class Message { 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

If applicable, the ID of the assistant that authored this message.

attachments: Array[{ file_id, tools}]

A list of files attached to the message, and the tools they were added to.

file_id: String

The ID of the file to attach to the message.

tools: Array[CodeInterpreterTool { type } | { type}]

The tools to add this file to.

Accepts one of the following:

class CodeInterpreterTool { type }

type: :code_interpreter

The type of tool being defined: code_interpreter

class AssistantToolsFileSearchTypeOnly { type }

type: :file_search

The type of tool being defined: file_search

completed_at: Integer

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

content: Array[MessageContent]

The content of the message in array of text and/or images.

Accepts one of the following:

class 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.

class 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.

class TextContentBlock { text, type }

The text content that is part of a message.

text: Text { annotations, value }

type: :text

Always text.

class 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.

incomplete_at: Integer

The Unix timestamp (in seconds) for when the message was marked as incomplete.

incomplete_details: { reason}

On an incomplete message, details about why the message is incomplete.

reason: :content_filter | :max_tokens | :run_cancelled | 2 more

The reason the message is incomplete.

Accepts one of the following:

:content_filter

:max_tokens

:run_cancelled

:run_expired

:run_failed

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.

object: :"thread.message"

The object type, which is always thread.message.

role: :user | :assistant

The entity that produced the message. One of user or assistant.

Accepts one of the following:

:user

:assistant

run_id: String

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 | :incomplete | :completed

The status of the message, which can be either in_progress, incomplete, or completed.

Accepts one of the following:

:in_progress

:incomplete

:completed

thread_id: String

The thread ID that this message belongs to.

MessageContent = ImageFileContentBlock { image_file, type } | ImageURLContentBlock { image_url, type } | TextContentBlock { text, type } | RefusalContentBlock { refusal, type }

References an image File in the content of a message.

Accepts one of the following:

class 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.

class 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.

class TextContentBlock { text, type }

The text content that is part of a message.

text: Text { annotations, value }

type: :text

Always text.

class RefusalContentBlock { refusal, type }

The refusal content generated by the assistant.

refusal: String

type: :refusal

Always refusal.

MessageContentDelta = ImageFileDeltaBlock { index, type, image_file } | TextDeltaBlock { index, type, text } | RefusalDeltaBlock { index, type, refusal } | ImageURLDeltaBlock { index, type, image_url }

References an image File in the content of a message.

Accepts one of the following:

class 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: ImageFileDelta { detail, file_id }

class 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: TextDelta { annotations, value }

class 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: String

class 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: ImageURLDelta { detail, url }

MessageContentPartParam = ImageFileContentBlock { image_file, type } | ImageURLContentBlock { image_url, type } | TextContentBlockParam { text, type }

References an image File in the content of a message.

Accepts one of the following:

class 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.

class 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.

class TextContentBlockParam { text, type }

The text content that is part of a message.

text: String

Text content to be sent to the model

type: :text

Always text.

class MessageDeleted { id, deleted, object }

id: String

deleted: bool

object: :"thread.message.deleted"

class MessageDelta { content, role }

The delta containing the fields that have changed on the Message.

content: Array[MessageContentDelta]

The content of the message in array of text and/or images.

Accepts one of the following:

class 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: ImageFileDelta { detail, file_id }

class 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: TextDelta { annotations, value }

class 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: String

class 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: ImageURLDelta { detail, url }

role: :user | :assistant

The entity that produced the message. One of user or assistant.

Accepts one of the following:

:user

:assistant

class MessageDeltaEvent { 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.

class RefusalContentBlock { refusal, type }

The refusal content generated by the assistant.

refusal: String

type: :refusal

Always refusal.

class 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: String

class Text { annotations, value }

annotations: Array[Annotation]

Accepts one of the following:

class 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.

class 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.

class TextContentBlock { text, type }

The text content that is part of a message.

text: Text { annotations, value }

type: :text

Always text.

class TextContentBlockParam { text, type }

The text content that is part of a message.

text: String

Text content to be sent to the model

type: :text

Always text.

class TextDelta { annotations, value }

annotations: Array[AnnotationDelta]

Accepts one of the following:

class 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: Integer

minimum0

file_citation: { file_id, quote}

file_id: String

The ID of the specific File the citation is from.

quote: String

The specific quote in the file.

start_index: Integer

minimum0

text: String

The text in the message content that needs to be replaced.

class 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: 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.

value: String

The data that makes up the text.

class 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: TextDelta { annotations, value }