Submit tool outputs to run

client.Beta.Threads.Runs.SubmitToolOutputs(ctx, threadID, runID, body) (*Run, error)

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

ParametersExpand Collapse

threadID string

runID string

body BetaThreadRunSubmitToolOutputsParams

ToolOutputs param.Field[[]BetaThreadRunSubmitToolOutputsParamsToolOutput]

A list of tools for which the outputs are being submitted.

Output stringOptional

The output of the tool call to be submitted to continue the run.

ToolCallID stringOptional

The ID of the tool call in the required_action object within the run object the output is being submitted for.

ReturnsExpand Collapse

type Run struct{…}

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

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 JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

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 JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

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:

type AssistantToolChoiceOptionAuto string

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:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

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:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

type AssistantStreamEventUnion interface{…}

Represents an event emitted when streaming a Run.

Each event in a server-sent events stream has an event and data property:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

We emit events whenever a new object is created, transitions to a new state, or is being streamed in parts (deltas). For example, we emit thread.run.created when a new run is created, thread.run.completed when a run completes, and so on. When an Assistant chooses to create a message during a run, we emit a thread.message.created event, a thread.message.in_progress event, many thread.message.delta events, and finally a thread.message.completed event.

We may add additional events over time, so we recommend handling unknown events gracefully in your code. See the Assistants API quickstart to learn how to integrate the Assistants API with streaming.

One of the following:

type AssistantStreamEventThreadCreated struct{…}

Occurs when a new thread is created.

Data Thread

Represents a thread that contains messages.

ID string

The identifier, which can be referenced in API endpoints.

CreatedAt int64

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

formatunixtime

Metadata Metadata

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.

ToolResources ThreadToolResources

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.

CodeInterpreter ThreadToolResourcesCodeInterpreterOptional

FileIDs []stringOptional

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

FileSearch ThreadToolResourcesFileSearchOptional

VectorStoreIDs []stringOptional

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

Event ThreadCreated

Enabled boolOptional

Whether to enable input audio transcription.

type AssistantStreamEventThreadRunCreated struct{…}

Occurs when a new run is created.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunCreated

type AssistantStreamEventThreadRunQueued struct{…}

Occurs when a run moves to a queued status.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunQueued

type AssistantStreamEventThreadRunInProgress struct{…}

Occurs when a run moves to an in_progress status.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunInProgress

type AssistantStreamEventThreadRunRequiresAction struct{…}

Occurs when a run moves to a requires_action status.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunRequiresAction

type AssistantStreamEventThreadRunCompleted struct{…}

Occurs when a run is completed.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunCompleted

type AssistantStreamEventThreadRunIncomplete struct{…}

Occurs when a run ends with status incomplete.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunIncomplete

type AssistantStreamEventThreadRunFailed struct{…}

Occurs when a run fails.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunFailed

type AssistantStreamEventThreadRunCancelling struct{…}

Occurs when a run moves to a cancelling status.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunCancelling

type AssistantStreamEventThreadRunCancelled struct{…}

Occurs when a run is cancelled.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunCancelled

type AssistantStreamEventThreadRunExpired struct{…}

Occurs when a run expires.

Data Run

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiresAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

IncompleteDetails RunIncompleteDetails

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

Reason stringOptional

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:

const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"

const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"

Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

const RunLastErrorCodeServerError RunLastErrorCode = "server_error"

const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"

const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"

Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256

MaxPromptTokens int64

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

minimum256

Metadata Metadata

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 ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

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 RequiredActionFunctionToolCallFunction

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 SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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.

One of the following:

type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

JSONSchema ResponseFormatJSONSchemaJSONSchema

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 stringOptional

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

Schema map[string, any]Optional

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

Strict boolOptional

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

formatunixtime

Status any

ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

One of the following:

type AssistantToolChoiceOptionAuto string

One of the following:

const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"

const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"

const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"

type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

One of the following:

const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"

const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"

const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"

Function AssistantToolChoiceFunctionOptional

Name string

The name of the function to call.

Tools []any

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

TruncationStrategy RunTruncationStrategy

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

Type string

One of the following:

const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"

const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"

LastMessages int64Optional

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

minimum1

Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64Optional

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

TopP float64Optional

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

Event ThreadRunExpired

type AssistantStreamEventThreadRunStepCreated struct{…}

Occurs when a run step is created.

Data RunStep

Represents a step in execution of a run.

ID string

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

AssistantID string

The ID of the assistant associated with the run step.

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiredAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

LastError RunStepLastError

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

Code string

One of server_error or rate_limit_exceeded.

One of the following:

const RunStepLastErrorCodeServerError RunStepLastErrorCode = "server_error"

const RunStepLastErrorCodeRateLimitExceeded RunStepLastErrorCode = "rate_limit_exceeded"

Message string

A human-readable description of the error.

Metadata Metadata

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

Object ThreadRunStep

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

RunID string

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

Status RunStepStatus

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

One of the following:

const RunStepStatusInProgress RunStepStatus = "in_progress"

const RunStepStatusCancelled RunStepStatus = "cancelled"

const RunStepStatusFailed RunStepStatus = "failed"

const RunStepStatusCompleted RunStepStatus = "completed"

const RunStepStatusExpired RunStepStatus = "expired"

StepDetails RunStepStepDetailsUnion

The details of the run step.

One of the following:

type MessageCreationStepDetails struct{…}

Details of the message creation by the run step.

MessageCreation MessageCreationStepDetailsMessageCreation

MessageID string

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

Type MessageCreation

Always message_creation.

type ToolCallsStepDetails struct{…}

Details of the tool call.

ToolCalls []any

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.

Type ToolCalls

Always tool_calls.

ThreadID string

The ID of the thread that was run.

Type RunStepType

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

One of the following:

const RunStepTypeMessageCreation RunStepType = "message_creation"

const RunStepTypeToolCalls RunStepType = "tool_calls"

Usage RunStepUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Event ThreadRunStepCreated

type AssistantStreamEventThreadRunStepInProgress struct{…}

Occurs when a run step moves to an in_progress state.

Data RunStep

Represents a step in execution of a run.

ID string

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

AssistantID string

The ID of the assistant associated with the run step.

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiredAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

LastError RunStepLastError

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

Code string

One of server_error or rate_limit_exceeded.

One of the following:

const RunStepLastErrorCodeServerError RunStepLastErrorCode = "server_error"

const RunStepLastErrorCodeRateLimitExceeded RunStepLastErrorCode = "rate_limit_exceeded"

Message string

A human-readable description of the error.

Metadata Metadata

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

Object ThreadRunStep

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

RunID string

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

Status RunStepStatus

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

One of the following:

const RunStepStatusInProgress RunStepStatus = "in_progress"

const RunStepStatusCancelled RunStepStatus = "cancelled"

const RunStepStatusFailed RunStepStatus = "failed"

const RunStepStatusCompleted RunStepStatus = "completed"

const RunStepStatusExpired RunStepStatus = "expired"

StepDetails RunStepStepDetailsUnion

The details of the run step.

One of the following:

type MessageCreationStepDetails struct{…}

Details of the message creation by the run step.

MessageCreation MessageCreationStepDetailsMessageCreation

MessageID string

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

Type MessageCreation

Always message_creation.

type ToolCallsStepDetails struct{…}

Details of the tool call.

ToolCalls []any

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.

Type ToolCalls

Always tool_calls.

ThreadID string

The ID of the thread that was run.

Type RunStepType

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

One of the following:

const RunStepTypeMessageCreation RunStepType = "message_creation"

const RunStepTypeToolCalls RunStepType = "tool_calls"

Usage RunStepUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Event ThreadRunStepInProgress

type AssistantStreamEventThreadRunStepDelta struct{…}

Occurs when parts of a run step are being streamed.

Data RunStepDeltaEvent

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 any

Object ThreadRunStepDelta

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

Event ThreadRunStepDelta

type AssistantStreamEventThreadRunStepCompleted struct{…}

Occurs when a run step is completed.

Data RunStep

Represents a step in execution of a run.

ID string

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

AssistantID string

The ID of the assistant associated with the run step.

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiredAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

LastError RunStepLastError

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

Code string

One of server_error or rate_limit_exceeded.

One of the following:

const RunStepLastErrorCodeServerError RunStepLastErrorCode = "server_error"

const RunStepLastErrorCodeRateLimitExceeded RunStepLastErrorCode = "rate_limit_exceeded"

Message string

A human-readable description of the error.

Metadata Metadata

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

Object ThreadRunStep

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

RunID string

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

Status RunStepStatus

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

One of the following:

const RunStepStatusInProgress RunStepStatus = "in_progress"

const RunStepStatusCancelled RunStepStatus = "cancelled"

const RunStepStatusFailed RunStepStatus = "failed"

const RunStepStatusCompleted RunStepStatus = "completed"

const RunStepStatusExpired RunStepStatus = "expired"

StepDetails RunStepStepDetailsUnion

The details of the run step.

One of the following:

type MessageCreationStepDetails struct{…}

Details of the message creation by the run step.

MessageCreation MessageCreationStepDetailsMessageCreation

MessageID string

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

Type MessageCreation

Always message_creation.

type ToolCallsStepDetails struct{…}

Details of the tool call.

ToolCalls []any

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.

Type ToolCalls

Always tool_calls.

ThreadID string

The ID of the thread that was run.

Type RunStepType

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

One of the following:

const RunStepTypeMessageCreation RunStepType = "message_creation"

const RunStepTypeToolCalls RunStepType = "tool_calls"

Usage RunStepUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Event ThreadRunStepCompleted

type AssistantStreamEventThreadRunStepFailed struct{…}

Occurs when a run step fails.

Data RunStep

Represents a step in execution of a run.

ID string

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

AssistantID string

The ID of the assistant associated with the run step.

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiredAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

LastError RunStepLastError

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

Code string

One of server_error or rate_limit_exceeded.

One of the following:

const RunStepLastErrorCodeServerError RunStepLastErrorCode = "server_error"

const RunStepLastErrorCodeRateLimitExceeded RunStepLastErrorCode = "rate_limit_exceeded"

Message string

A human-readable description of the error.

Metadata Metadata

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

Object ThreadRunStep

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

RunID string

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

Status RunStepStatus

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

One of the following:

const RunStepStatusInProgress RunStepStatus = "in_progress"

const RunStepStatusCancelled RunStepStatus = "cancelled"

const RunStepStatusFailed RunStepStatus = "failed"

const RunStepStatusCompleted RunStepStatus = "completed"

const RunStepStatusExpired RunStepStatus = "expired"

StepDetails RunStepStepDetailsUnion

The details of the run step.

One of the following:

type MessageCreationStepDetails struct{…}

Details of the message creation by the run step.

MessageCreation MessageCreationStepDetailsMessageCreation

MessageID string

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

Type MessageCreation

Always message_creation.

type ToolCallsStepDetails struct{…}

Details of the tool call.

ToolCalls []any

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.

Type ToolCalls

Always tool_calls.

ThreadID string

The ID of the thread that was run.

Type RunStepType

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

One of the following:

const RunStepTypeMessageCreation RunStepType = "message_creation"

const RunStepTypeToolCalls RunStepType = "tool_calls"

Usage RunStepUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Event ThreadRunStepFailed

type AssistantStreamEventThreadRunStepCancelled struct{…}

Occurs when a run step is cancelled.

Data RunStep

Represents a step in execution of a run.

ID string

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

AssistantID string

The ID of the assistant associated with the run step.

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiredAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

LastError RunStepLastError

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

Code string

One of server_error or rate_limit_exceeded.

One of the following:

const RunStepLastErrorCodeServerError RunStepLastErrorCode = "server_error"

const RunStepLastErrorCodeRateLimitExceeded RunStepLastErrorCode = "rate_limit_exceeded"

Message string

A human-readable description of the error.

Metadata Metadata

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

Object ThreadRunStep

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

RunID string

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

Status RunStepStatus

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

One of the following:

const RunStepStatusInProgress RunStepStatus = "in_progress"

const RunStepStatusCancelled RunStepStatus = "cancelled"

const RunStepStatusFailed RunStepStatus = "failed"

const RunStepStatusCompleted RunStepStatus = "completed"

const RunStepStatusExpired RunStepStatus = "expired"

StepDetails RunStepStepDetailsUnion

The details of the run step.

One of the following:

type MessageCreationStepDetails struct{…}

Details of the message creation by the run step.

MessageCreation MessageCreationStepDetailsMessageCreation

MessageID string

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

Type MessageCreation

Always message_creation.

type ToolCallsStepDetails struct{…}

Details of the tool call.

ToolCalls []any

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.

Type ToolCalls

Always tool_calls.

ThreadID string

The ID of the thread that was run.

Type RunStepType

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

One of the following:

const RunStepTypeMessageCreation RunStepType = "message_creation"

const RunStepTypeToolCalls RunStepType = "tool_calls"

Usage RunStepUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Event ThreadRunStepCancelled

type AssistantStreamEventThreadRunStepExpired struct{…}

Occurs when a run step expires.

Data RunStep

Represents a step in execution of a run.

ID string

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

AssistantID string

The ID of the assistant associated with the run step.

CancelledAt int64

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

formatunixtime

CompletedAt int64

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

formatunixtime

CreatedAt int64

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

formatunixtime

ExpiredAt int64

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

formatunixtime

FailedAt int64

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

formatunixtime

LastError RunStepLastError

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

Code string

One of server_error or rate_limit_exceeded.

One of the following:

const RunStepLastErrorCodeServerError RunStepLastErrorCode = "server_error"

const RunStepLastErrorCodeRateLimitExceeded RunStepLastErrorCode = "rate_limit_exceeded"

Message string

A human-readable description of the error.

Metadata Metadata

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

Object ThreadRunStep

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

RunID string

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

Status RunStepStatus

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

One of the following:

const RunStepStatusInProgress RunStepStatus = "in_progress"

const RunStepStatusCancelled RunStepStatus = "cancelled"

const RunStepStatusFailed RunStepStatus = "failed"

const RunStepStatusCompleted RunStepStatus = "completed"

const RunStepStatusExpired RunStepStatus = "expired"

StepDetails RunStepStepDetailsUnion

The details of the run step.

One of the following:

type MessageCreationStepDetails struct{…}

Details of the message creation by the run step.

MessageCreation MessageCreationStepDetailsMessageCreation

MessageID string

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

Type MessageCreation

Always message_creation.

type ToolCallsStepDetails struct{…}

Details of the tool call.

ToolCalls []any

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.

Type ToolCalls

Always tool_calls.

ThreadID string

The ID of the thread that was run.

Type RunStepType

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

One of the following:

const RunStepTypeMessageCreation RunStepType = "message_creation"

const RunStepTypeToolCalls RunStepType = "tool_calls"

Usage RunStepUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Event ThreadRunStepExpired

type AssistantStreamEventThreadMessageCreated struct{…}

Occurs when a message is created.

Data Message

Represents a message within a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

Attachments []MessageAttachment

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

FileID stringOptional

The ID of the file to attach to the message.

Tools []MessageAttachmentToolUnionOptional

The tools to add this file to.

One of the following:

type CodeInterpreterTool struct{…}

Type CodeInterpreter

The type of tool being defined: code_interpreter

type MessageAttachmentToolAssistantToolsFileSearchTypeOnly struct{…}

Type FileSearch

The type of tool being defined: file_search

CompletedAt int64

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

formatunixtime

Content []any

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

CreatedAt int64

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

formatunixtime

IncompleteAt int64

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

formatunixtime

IncompleteDetails MessageIncompleteDetails

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

Reason string

The reason the message is incomplete.

One of the following:

const MessageIncompleteDetailsReasonContentFilter MessageIncompleteDetailsReason = "content_filter"

const MessageIncompleteDetailsReasonMaxTokens MessageIncompleteDetailsReason = "max_tokens"

const MessageIncompleteDetailsReasonRunCancelled MessageIncompleteDetailsReason = "run_cancelled"

const MessageIncompleteDetailsReasonRunExpired MessageIncompleteDetailsReason = "run_expired"

const MessageIncompleteDetailsReasonRunFailed MessageIncompleteDetailsReason = "run_failed"

Metadata Metadata

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

Object ThreadMessage

The object type, which is always thread.message.

Role MessageRole

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

One of the following:

const MessageRoleUser MessageRole = "user"

const MessageRoleAssistant MessageRole = "assistant"

RunID 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 MessageStatus

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

One of the following:

const MessageStatusInProgress MessageStatus = "in_progress"

const MessageStatusIncomplete MessageStatus = "incomplete"

const MessageStatusCompleted MessageStatus = "completed"

ThreadID string

The thread ID that this message belongs to.

Event ThreadMessageCreated

type AssistantStreamEventThreadMessageInProgress struct{…}

Occurs when a message moves to an in_progress state.

Data Message

Represents a message within a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

Attachments []MessageAttachment

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

FileID stringOptional

The ID of the file to attach to the message.

Tools []MessageAttachmentToolUnionOptional

The tools to add this file to.

One of the following:

type CodeInterpreterTool struct{…}

Type CodeInterpreter

The type of tool being defined: code_interpreter

type MessageAttachmentToolAssistantToolsFileSearchTypeOnly struct{…}

Type FileSearch

The type of tool being defined: file_search

CompletedAt int64

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

formatunixtime

Content []any

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

CreatedAt int64

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

formatunixtime

IncompleteAt int64

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

formatunixtime

IncompleteDetails MessageIncompleteDetails

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

Reason string

The reason the message is incomplete.

One of the following:

const MessageIncompleteDetailsReasonContentFilter MessageIncompleteDetailsReason = "content_filter"

const MessageIncompleteDetailsReasonMaxTokens MessageIncompleteDetailsReason = "max_tokens"

const MessageIncompleteDetailsReasonRunCancelled MessageIncompleteDetailsReason = "run_cancelled"

const MessageIncompleteDetailsReasonRunExpired MessageIncompleteDetailsReason = "run_expired"

const MessageIncompleteDetailsReasonRunFailed MessageIncompleteDetailsReason = "run_failed"

Metadata Metadata

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

Object ThreadMessage

The object type, which is always thread.message.

Role MessageRole

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

One of the following:

const MessageRoleUser MessageRole = "user"

const MessageRoleAssistant MessageRole = "assistant"

RunID 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 MessageStatus

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

One of the following:

const MessageStatusInProgress MessageStatus = "in_progress"

const MessageStatusIncomplete MessageStatus = "incomplete"

const MessageStatusCompleted MessageStatus = "completed"

ThreadID string

The thread ID that this message belongs to.

Event ThreadMessageInProgress

type AssistantStreamEventThreadMessageDelta struct{…}

Occurs when parts of a Message are being streamed.

Data MessageDeltaEvent

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

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

Content []anyOptional

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

Role MessageDeltaRoleOptional

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

One of the following:

const MessageDeltaRoleUser MessageDeltaRole = "user"

const MessageDeltaRoleAssistant MessageDeltaRole = "assistant"

Object ThreadMessageDelta

The object type, which is always thread.message.delta.

Event ThreadMessageDelta

type AssistantStreamEventThreadMessageCompleted struct{…}

Occurs when a message is completed.

Data Message

Represents a message within a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

Attachments []MessageAttachment

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

FileID stringOptional

The ID of the file to attach to the message.

Tools []MessageAttachmentToolUnionOptional

The tools to add this file to.

One of the following:

type CodeInterpreterTool struct{…}

Type CodeInterpreter

The type of tool being defined: code_interpreter

type MessageAttachmentToolAssistantToolsFileSearchTypeOnly struct{…}

Type FileSearch

The type of tool being defined: file_search

CompletedAt int64

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

formatunixtime

Content []any

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

CreatedAt int64

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

formatunixtime

IncompleteAt int64

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

formatunixtime

IncompleteDetails MessageIncompleteDetails

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

Reason string

The reason the message is incomplete.

One of the following:

const MessageIncompleteDetailsReasonContentFilter MessageIncompleteDetailsReason = "content_filter"

const MessageIncompleteDetailsReasonMaxTokens MessageIncompleteDetailsReason = "max_tokens"

const MessageIncompleteDetailsReasonRunCancelled MessageIncompleteDetailsReason = "run_cancelled"

const MessageIncompleteDetailsReasonRunExpired MessageIncompleteDetailsReason = "run_expired"

const MessageIncompleteDetailsReasonRunFailed MessageIncompleteDetailsReason = "run_failed"

Metadata Metadata

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

Object ThreadMessage

The object type, which is always thread.message.

Role MessageRole

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

One of the following:

const MessageRoleUser MessageRole = "user"

const MessageRoleAssistant MessageRole = "assistant"

RunID 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 MessageStatus

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

One of the following:

const MessageStatusInProgress MessageStatus = "in_progress"

const MessageStatusIncomplete MessageStatus = "incomplete"

const MessageStatusCompleted MessageStatus = "completed"

ThreadID string

The thread ID that this message belongs to.

Event ThreadMessageCompleted

type AssistantStreamEventThreadMessageIncomplete struct{…}

Occurs when a message ends before it is completed.

Data Message

Represents a message within a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

Attachments []MessageAttachment

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

FileID stringOptional

The ID of the file to attach to the message.

Tools []MessageAttachmentToolUnionOptional

The tools to add this file to.

One of the following:

type CodeInterpreterTool struct{…}

Type CodeInterpreter

The type of tool being defined: code_interpreter

type MessageAttachmentToolAssistantToolsFileSearchTypeOnly struct{…}

Type FileSearch

The type of tool being defined: file_search

CompletedAt int64

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

formatunixtime

Content []any

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

CreatedAt int64

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

formatunixtime

IncompleteAt int64

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

formatunixtime

IncompleteDetails MessageIncompleteDetails

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

Reason string

The reason the message is incomplete.

One of the following:

const MessageIncompleteDetailsReasonContentFilter MessageIncompleteDetailsReason = "content_filter"

const MessageIncompleteDetailsReasonMaxTokens MessageIncompleteDetailsReason = "max_tokens"

const MessageIncompleteDetailsReasonRunCancelled MessageIncompleteDetailsReason = "run_cancelled"

const MessageIncompleteDetailsReasonRunExpired MessageIncompleteDetailsReason = "run_expired"

const MessageIncompleteDetailsReasonRunFailed MessageIncompleteDetailsReason = "run_failed"

Metadata Metadata

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

Object ThreadMessage

The object type, which is always thread.message.

Role MessageRole

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

One of the following:

const MessageRoleUser MessageRole = "user"

const MessageRoleAssistant MessageRole = "assistant"

RunID 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 MessageStatus

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

One of the following:

const MessageStatusInProgress MessageStatus = "in_progress"

const MessageStatusIncomplete MessageStatus = "incomplete"

const MessageStatusCompleted MessageStatus = "completed"

ThreadID string

The thread ID that this message belongs to.

Event ThreadMessageIncomplete

type AssistantStreamEventErrorEvent struct{…}

Occurs when an error occurs. This can happen due to an internal server error or a timeout.

Data ErrorObject

Code string

Message string

Param string

Type string

Event Error