Beta

BetaChatKit

ModelsExpand Collapse

ChatKitWorkflow = object { id, state_variables, tracing, version }

Workflow metadata and state returned for the session.

id: string

Identifier of the workflow backing the session.

state_variables: map[string or boolean or number]

State variable key-value pairs applied when invoking the workflow. Defaults to null when no overrides were provided.

One of the following:

string

boolean

number

tracing: object { enabled }

Tracing settings applied to the workflow.

enabled: boolean

Indicates whether tracing is enabled.

version: string

Specific workflow version used for the session. Defaults to null when using the latest deployment.

BetaChatKitSessions

Cancel chat session

POST/chatkit/sessions/{session_id}/cancel

BetaChatKitThreads

ModelsExpand Collapse

ChatSession = object { id, chatkit_configuration, client_secret, 7 more }

Represents a ChatKit session and its resolved configuration.

id: string

Identifier for the ChatKit session.

chatkit_configuration: ChatSessionChatKitConfiguration { automatic_thread_titling, file_upload, history }

Resolved ChatKit feature configuration for the session.

client_secret: string

Ephemeral client secret that authenticates session requests.

expires_at: number

Unix timestamp (in seconds) for when the session expires.

max_requests_per_1_minute: number

Convenience copy of the per-minute request limit.

object: "chatkit.session"

Type discriminator that is always chatkit.session.

rate_limits: ChatSessionRateLimits { max_requests_per_1_minute }

Resolved rate limit values.

status: ChatSessionStatus

Current lifecycle state of the session.

user: string

User identifier associated with the session.

workflow: ChatKitWorkflow { id, state_variables, tracing, version }

Workflow metadata for the session.

ChatSessionAutomaticThreadTitling = object { enabled }

Automatic thread title preferences for the session.

enabled: boolean

Whether automatic thread titling is enabled.

ChatSessionChatKitConfiguration = object { automatic_thread_titling, file_upload, history }

ChatKit configuration for the session.

automatic_thread_titling: ChatSessionAutomaticThreadTitling { enabled }

Automatic thread titling preferences.

file_upload: ChatSessionFileUpload { enabled, max_file_size, max_files }

Upload settings for the session.

history: ChatSessionHistory { enabled, recent_threads }

History retention configuration.

ChatSessionChatKitConfigurationParam = object { automatic_thread_titling, file_upload, history }

Optional per-session configuration settings for ChatKit behavior.

automatic_thread_titling: optional object { enabled }

Configuration for automatic thread titling. When omitted, automatic thread titling is enabled by default.

enabled: optional boolean

Enable automatic thread title generation. Defaults to true.

file_upload: optional object { enabled, max_file_size, max_files }

Configuration for upload enablement and limits. When omitted, uploads are disabled by default (max_files 10, max_file_size 512 MB).

enabled: optional boolean

Enable uploads for this session. Defaults to false.

max_file_size: optional number

Maximum size in megabytes for each uploaded file. Defaults to 512 MB, which is the maximum allowable size.

maximum512

minimum1

max_files: optional number

Maximum number of files that can be uploaded to the session. Defaults to 10.

minimum1

history: optional object { enabled, recent_threads }

Configuration for chat history retention. When omitted, history is enabled by default with no limit on recent_threads (null).

enabled: optional boolean

Enables chat users to access previous ChatKit threads. Defaults to true.

recent_threads: optional number

Number of recent ChatKit threads users have access to. Defaults to unlimited when unset.

minimum1

ChatSessionExpiresAfterParam = object { anchor, seconds }

Controls when the session expires relative to an anchor timestamp.

anchor: "created_at"

Base timestamp used to calculate expiration. Currently fixed to created_at.

seconds: number

Number of seconds after the anchor when the session expires.

maximum600

minimum1

ChatSessionFileUpload = object { enabled, max_file_size, max_files }

Upload permissions and limits applied to the session.

enabled: boolean

Indicates if uploads are enabled for the session.

max_file_size: number

Maximum upload size in megabytes.

max_files: number

Maximum number of uploads allowed during the session.

ChatSessionHistory = object { enabled, recent_threads }

History retention preferences returned for the session.

enabled: boolean

Indicates if chat history is persisted for the session.

recent_threads: number

Number of prior threads surfaced in history views. Defaults to null when all history is retained.

ChatSessionRateLimits = object { max_requests_per_1_minute }

Active per-minute request limit for the session.

max_requests_per_1_minute: number

Maximum allowed requests per one-minute window.

ChatSessionRateLimitsParam = object { max_requests_per_1_minute }

Controls request rate limits for the session.

max_requests_per_1_minute: optional number

Maximum number of requests allowed per minute for the session. Defaults to 10.

minimum1

ChatSessionStatus = "active" or "expired" or "cancelled"

One of the following:

"active"

"expired"

"cancelled"

ChatSessionWorkflowParam = object { id, state_variables, tracing, version }

Workflow reference and overrides applied to the chat session.

id: string

Identifier for the workflow invoked by the session.

state_variables: optional map[string or boolean or number]

State variables forwarded to the workflow. Keys may be up to 64 characters, values must be primitive types, and the map defaults to an empty object.

One of the following:

string

boolean

number

tracing: optional object { enabled }

Optional tracing overrides for the workflow invocation. When omitted, tracing is enabled by default.

enabled: optional boolean

Whether tracing is enabled during the session. Defaults to true.

version: optional string

Specific workflow version to run. Defaults to the latest deployed version.

ChatKitAttachment = object { id, mime_type, name, 2 more }

Attachment metadata included on thread items.

id: string

Identifier for the attachment.

mime_type: string

MIME type of the attachment.

Original display name for the attachment.

preview_url: string

Preview URL for rendering the attachment inline.

type: "image" or "file"

Attachment discriminator.

One of the following:

"image"

"file"

ChatKitResponseOutputText = object { annotations, text, type }

Assistant response text accompanied by optional annotations.

annotations: array of object { source, type } or object { source, type }

Ordered list of annotations attached to the response text.

One of the following:

File = object { source, type }

Annotation that references an uploaded file.

source: object { filename, type }

File attachment referenced by the annotation.

filename: string

Filename referenced by the annotation.

type: "file"

Type discriminator that is always file.

type: "file"

Type discriminator that is always file for this annotation.

URL = object { source, type }

Annotation that references a URL.

source: object { type, url }

URL referenced by the annotation.

type: "url"

Type discriminator that is always url.

url: string

URL referenced by the annotation.

type: "url"

Type discriminator that is always url for this annotation.

text: string

Assistant generated text.

type: "output_text"

Type discriminator that is always output_text.

ChatKitThread = object { id, created_at, object, 3 more }

Represents a ChatKit thread and its current status.

id: string

Identifier of the thread.

created_at: number

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

object: "chatkit.thread"

Type discriminator that is always chatkit.thread.

status: object { type } or object { reason, type } or object { reason, type }

Current status for the thread. Defaults to active for newly created threads.

One of the following:

Active = object { type }

Indicates that a thread is active.

type: "active"

Status discriminator that is always active.

Locked = object { reason, type }

Indicates that a thread is locked and cannot accept new input.

reason: string

Reason that the thread was locked. Defaults to null when no reason is recorded.

type: "locked"

Status discriminator that is always locked.

Closed = object { reason, type }

Indicates that a thread has been closed.

reason: string

Reason that the thread was closed. Defaults to null when no reason is recorded.

type: "closed"

Status discriminator that is always closed.

title: string

Optional human-readable title for the thread. Defaults to null when no title has been generated.

user: string

Free-form string that identifies your end user who owns the thread.

ChatKitThreadAssistantMessageItem = object { id, content, created_at, 3 more }

Assistant-authored message within a thread.

id: string

Identifier of the thread item.

content: array of ChatKitResponseOutputText { annotations, text, type }

Ordered assistant response segments.

annotations: array of object { source, type } or object { source, type }

Ordered list of annotations attached to the response text.

One of the following:

File = object { source, type }

Annotation that references an uploaded file.

source: object { filename, type }

File attachment referenced by the annotation.

filename: string

Filename referenced by the annotation.

type: "file"

Type discriminator that is always file.

type: "file"

Type discriminator that is always file for this annotation.

URL = object { source, type }

Annotation that references a URL.

source: object { type, url }

URL referenced by the annotation.

type: "url"

Type discriminator that is always url.

url: string

URL referenced by the annotation.

type: "url"

Type discriminator that is always url for this annotation.

text: string

Assistant generated text.

type: "output_text"

Type discriminator that is always output_text.

created_at: number

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

object: "chatkit.thread_item"

Type discriminator that is always chatkit.thread_item.

thread_id: string

Identifier of the parent thread.

type: "chatkit.assistant_message"

Type discriminator that is always chatkit.assistant_message.

ChatKitThreadItemList = object { data, first_id, has_more, 2 more }

A paginated list of thread items rendered for the ChatKit API.

data: array of ChatKitThreadUserMessageItem { id, attachments, content, 5 more } or ChatKitThreadAssistantMessageItem { id, content, created_at, 3 more } or ChatKitWidgetItem { id, created_at, object, 3 more } or 3 more

A list of items

One of the following:

ChatKitThreadUserMessageItem = object { id, attachments, content, 5 more }

User-authored messages within a thread.

id: string

Identifier of the thread item.

attachments: array of ChatKitAttachment { id, mime_type, name, 2 more }

Attachments associated with the user message. Defaults to an empty list.

id: string

Identifier for the attachment.

mime_type: string

MIME type of the attachment.

Original display name for the attachment.

preview_url: string

Preview URL for rendering the attachment inline.

type: "image" or "file"

Attachment discriminator.

One of the following:

"image"

"file"

content: array of object { text, type } or object { text, type }

Ordered content elements supplied by the user.

One of the following:

InputText = object { text, type }

Text block that a user contributed to the thread.

text: string

Plain-text content supplied by the user.

type: "input_text"

Type discriminator that is always input_text.

QuotedText = object { text, type }

Quoted snippet that the user referenced in their message.

text: string

Quoted text content.

type: "quoted_text"

Type discriminator that is always quoted_text.

created_at: number

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

inference_options: object { model, tool_choice }

Inference overrides applied to the message. Defaults to null when unset.

model: string

Model name that generated the response. Defaults to null when using the session default.

tool_choice: object { id }

Preferred tool to invoke. Defaults to null when ChatKit should auto-select.

id: string

Identifier of the requested tool.

object: "chatkit.thread_item"

Type discriminator that is always chatkit.thread_item.

thread_id: string

Identifier of the parent thread.

type: "chatkit.user_message"

ChatKitThreadAssistantMessageItem = object { id, content, created_at, 3 more }

Assistant-authored message within a thread.

id: string

Identifier of the thread item.

content: array of ChatKitResponseOutputText { annotations, text, type }

Ordered assistant response segments.

annotations: array of object { source, type } or object { source, type }

Ordered list of annotations attached to the response text.

One of the following:

File = object { source, type }

Annotation that references an uploaded file.

source: object { filename, type }

File attachment referenced by the annotation.

filename: string

Filename referenced by the annotation.

type: "file"

Type discriminator that is always file.

type: "file"

Type discriminator that is always file for this annotation.

URL = object { source, type }

Annotation that references a URL.

source: object { type, url }

URL referenced by the annotation.

type: "url"

Type discriminator that is always url.

url: string

URL referenced by the annotation.

type: "url"

Type discriminator that is always url for this annotation.

text: string

Assistant generated text.

type: "output_text"

Type discriminator that is always output_text.

created_at: number

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

object: "chatkit.thread_item"

Type discriminator that is always chatkit.thread_item.

thread_id: string

Identifier of the parent thread.

type: "chatkit.assistant_message"

Type discriminator that is always chatkit.assistant_message.

ChatKitWidgetItem = object { id, created_at, object, 3 more }

Thread item that renders a widget payload.

id: string

Identifier of the thread item.

created_at: number

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

object: "chatkit.thread_item"

Type discriminator that is always chatkit.thread_item.

thread_id: string

Identifier of the parent thread.

type: "chatkit.widget"

Type discriminator that is always chatkit.widget.

ChatKitClientToolCall = object { id, arguments, call_id, 7 more }

Record of a client side tool invocation initiated by the assistant.

id: string

Identifier of the thread item.

arguments: string

JSON-encoded arguments that were sent to the tool.

call_id: string

Identifier for the client tool call.

created_at: number

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

Tool name that was invoked.

object: "chatkit.thread_item"

Type discriminator that is always chatkit.thread_item.

output: string

JSON-encoded output captured from the tool. Defaults to null while execution is in progress.

status: "in_progress" or "completed"

Execution status for the tool call.

One of the following:

"in_progress"

"completed"

thread_id: string

Identifier of the parent thread.

type: "chatkit.client_tool_call"

Type discriminator that is always chatkit.client_tool_call.

ChatKitTask = object { id, created_at, heading, 5 more }

Task emitted by the workflow to show progress and status updates.

id: string

Identifier of the thread item.

created_at: number

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

heading: string

Optional heading for the task. Defaults to null when not provided.

object: "chatkit.thread_item"

Type discriminator that is always chatkit.thread_item.

summary: string

Optional summary that describes the task. Defaults to null when omitted.

task_type: "custom" or "thought"

Subtype for the task.

One of the following:

"custom"

"thought"

thread_id: string

Identifier of the parent thread.

type: "chatkit.task"

Type discriminator that is always chatkit.task.

ChatKitTaskGroup = object { id, created_at, object, 3 more }

Collection of workflow tasks grouped together in the thread.

id: string

Identifier of the thread item.

created_at: number

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

object: "chatkit.thread_item"

Type discriminator that is always chatkit.thread_item.

tasks: array of object { heading, summary, type }

Tasks included in the group.

heading: string

Optional heading for the grouped task. Defaults to null when not provided.

summary: string

Optional summary that describes the grouped task. Defaults to null when omitted.

type: "custom" or "thought"

Subtype for the grouped task.

One of the following:

"custom"

"thought"

thread_id: string

Identifier of the parent thread.

type: "chatkit.task_group"

Type discriminator that is always chatkit.task_group.

first_id: string

The ID of the first item in the list.

has_more: boolean

Whether there are more items available.

last_id: string

The ID of the last item in the list.

object: "list"

The type of object returned, must be list.

ChatKitThreadUserMessageItem = object { id, attachments, content, 5 more }

User-authored messages within a thread.

id: string

Identifier of the thread item.

attachments: array of ChatKitAttachment { id, mime_type, name, 2 more }

Attachments associated with the user message. Defaults to an empty list.

id: string

Identifier for the attachment.

mime_type: string

MIME type of the attachment.

Original display name for the attachment.

preview_url: string

Preview URL for rendering the attachment inline.

type: "image" or "file"

Attachment discriminator.

One of the following:

"image"

"file"

content: array of object { text, type } or object { text, type }

Ordered content elements supplied by the user.

One of the following:

InputText = object { text, type }

Text block that a user contributed to the thread.

text: string

Plain-text content supplied by the user.

type: "input_text"

Type discriminator that is always input_text.

QuotedText = object { text, type }

Quoted snippet that the user referenced in their message.

text: string

Quoted text content.

type: "quoted_text"

Type discriminator that is always quoted_text.

created_at: number

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

inference_options: object { model, tool_choice }

Inference overrides applied to the message. Defaults to null when unset.

model: string

Model name that generated the response. Defaults to null when using the session default.

tool_choice: object { id }

Preferred tool to invoke. Defaults to null when ChatKit should auto-select.

id: string

Identifier of the requested tool.

object: "chatkit.thread_item"

Type discriminator that is always chatkit.thread_item.

thread_id: string

Identifier of the parent thread.

type: "chatkit.user_message"

ChatKitWidgetItem = object { id, created_at, object, 3 more }

Thread item that renders a widget payload.

id: string

Identifier of the thread item.

created_at: number

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

object: "chatkit.thread_item"

Type discriminator that is always chatkit.thread_item.

thread_id: string

Identifier of the parent thread.

type: "chatkit.widget"

Type discriminator that is always chatkit.widget.

BetaAssistants

Build Assistants that can call models and use tools.

Modify assistant

Deprecated

POST/assistants/{assistant_id}

Delete assistant

Deprecated

DELETE/assistants/{assistant_id}

ModelsExpand Collapse

Assistant = object { id, created_at, description, 10 more }

Represents an assistant that can call the model and use tools.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

description: string

The description of the assistant. The maximum length is 512 characters.

maxLength512

instructions: string

The system instructions that the assistant uses. The maximum length is 256,000 characters.

maxLength256000

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

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

The name of the assistant. The maximum length is 256 characters.

maxLength256

object: "assistant"

The object type, which is always assistant.

tools: array of CodeInterpreterTool { type } or FileSearchTool { type, file_search } or FunctionTool { function, type }

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

One of the following:

CodeInterpreterTool = object { type }

type: "code_interpreter"

The type of tool being defined: code_interpreter

FileSearchTool = object { type, file_search }

type: "file_search"

The type of tool being defined: file_search

file_search: optional object { max_num_results, ranking_options }

Overrides for the file search tool.

max_num_results: optional number

The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.

Note that the file search tool may output fewer than max_num_results results. See the file search tool documentation for more information.

minimum1

maximum50

ranking_options: optional object { score_threshold, ranker }

The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0.

See the file search tool documentation for more information.

score_threshold: number

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

minimum0

maximum1

ranker: optional "auto" or "default_2024_08_21"

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

One of the following:

"auto"

"default_2024_08_21"

FunctionTool = object { function, type }

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

type: "function"

The type of tool being defined: function

response_format: optional AssistantResponseFormatOption

Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

temperature: optional number

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

minimum0

maximum2

tool_resources: optional object { code_interpreter, file_search }

A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

code_interpreter: optional object { file_ids }

file_ids: optional array of string

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

file_search: optional object { vector_store_ids }

vector_store_ids: optional array of string

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

top_p: optional number

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

minimum0

maximum1

AssistantDeleted = object { id, deleted, object }

id: string

deleted: boolean

object: "assistant.deleted"

AssistantStreamEvent = object { data, event, enabled } or object { data, event } or object { data, event } or 22 more

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:

object { data, event, enabled }

Occurs when a new thread is created.

data: Thread { id, created_at, metadata, 2 more }

Represents a thread that contains messages.

event: "thread.created"

enabled: optional boolean

Whether to enable input audio transcription.

object { data, event }

Occurs when a new run is created.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.created"

object { data, event }

Occurs when a run moves to a queued status.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.queued"

object { data, event }

Occurs when a run moves to an in_progress status.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.in_progress"

object { data, event }

Occurs when a run moves to a requires_action status.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.requires_action"

object { data, event }

Occurs when a run is completed.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.completed"

object { data, event }

Occurs when a run ends with status incomplete.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.incomplete"

object { data, event }

Occurs when a run fails.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.failed"

object { data, event }

Occurs when a run moves to a cancelling status.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.cancelling"

object { data, event }

Occurs when a run is cancelled.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.cancelled"

object { data, event }

Occurs when a run expires.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.expired"

object { data, event }

Occurs when a run step is created.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.created"

object { data, event }

Occurs when a run step moves to an in_progress state.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.in_progress"

object { data, event }

Occurs when parts of a run step are being streamed.

data: RunStepDeltaEvent { id, delta, object }

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

event: "thread.run.step.delta"

object { data, event }

Occurs when a run step is completed.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.completed"

object { data, event }

Occurs when a run step fails.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.failed"

object { data, event }

Occurs when a run step is cancelled.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.cancelled"

object { data, event }

Occurs when a run step expires.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.expired"

object { data, event }

Occurs when a message is created.

data: Message { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

event: "thread.message.created"

object { data, event }

Occurs when a message moves to an in_progress state.

data: Message { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

event: "thread.message.in_progress"

object { data, event }

Occurs when parts of a Message are being streamed.

data: MessageDeltaEvent { id, delta, object }

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

event: "thread.message.delta"

object { data, event }

Occurs when a message is completed.

data: Message { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

event: "thread.message.completed"

object { data, event }

Occurs when a message ends before it is completed.

data: Message { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

event: "thread.message.incomplete"

ErrorEvent = object { data, event }

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

data: ErrorObject { code, message, param, type }

event: "error"

DoneEvent = object { data, event }

Occurs when a stream ends.

data: "[DONE]"

event: "done"

CodeInterpreterTool = object { type }

type: "code_interpreter"

The type of tool being defined: code_interpreter

FileSearchTool = object { type, file_search }

type: "file_search"

The type of tool being defined: file_search

file_search: optional object { max_num_results, ranking_options }

Overrides for the file search tool.

max_num_results: optional number

The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.

Note that the file search tool may output fewer than max_num_results results. See the file search tool documentation for more information.

minimum1

maximum50

ranking_options: optional object { score_threshold, ranker }

The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0.

See the file search tool documentation for more information.

score_threshold: number

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

minimum0

maximum1

ranker: optional "auto" or "default_2024_08_21"

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

One of the following:

"auto"

"default_2024_08_21"

FunctionTool = object { function, type }

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

type: "function"

The type of tool being defined: function

MessageStreamEvent = object { data, event } or object { data, event } or object { data, event } or 2 more

Occurs when a message is created.

One of the following:

object { data, event }

Occurs when a message is created.

data: Message { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

event: "thread.message.created"

object { data, event }

Occurs when a message moves to an in_progress state.

data: Message { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

event: "thread.message.in_progress"

object { data, event }

Occurs when parts of a Message are being streamed.

data: MessageDeltaEvent { id, delta, object }

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

event: "thread.message.delta"

object { data, event }

Occurs when a message is completed.

data: Message { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

event: "thread.message.completed"

object { data, event }

Occurs when a message ends before it is completed.

data: Message { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

event: "thread.message.incomplete"

RunStepStreamEvent = object { data, event } or object { data, event } or object { data, event } or 4 more

Occurs when a run step is created.

One of the following:

object { data, event }

Occurs when a run step is created.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.created"

object { data, event }

Occurs when a run step moves to an in_progress state.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.in_progress"

object { data, event }

Occurs when parts of a run step are being streamed.

data: RunStepDeltaEvent { id, delta, object }

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

event: "thread.run.step.delta"

object { data, event }

Occurs when a run step is completed.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.completed"

object { data, event }

Occurs when a run step fails.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.failed"

object { data, event }

Occurs when a run step is cancelled.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.cancelled"

object { data, event }

Occurs when a run step expires.

data: RunStep { id, assistant_id, cancelled_at, 13 more }

Represents a step in execution of a run.

event: "thread.run.step.expired"

RunStreamEvent = object { data, event } or object { data, event } or object { data, event } or 7 more

Occurs when a new run is created.

One of the following:

object { data, event }

Occurs when a new run is created.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.created"

object { data, event }

Occurs when a run moves to a queued status.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.queued"

object { data, event }

Occurs when a run moves to an in_progress status.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.in_progress"

object { data, event }

Occurs when a run moves to a requires_action status.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.requires_action"

object { data, event }

Occurs when a run is completed.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.completed"

object { data, event }

Occurs when a run ends with status incomplete.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.incomplete"

object { data, event }

Occurs when a run fails.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.failed"

object { data, event }

Occurs when a run moves to a cancelling status.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.cancelling"

object { data, event }

Occurs when a run is cancelled.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.cancelled"

object { data, event }

Occurs when a run expires.

data: Run { id, assistant_id, cancelled_at, 24 more }

Represents an execution run on a thread.

event: "thread.run.expired"

ThreadStreamEvent = object { data, event, enabled }

Occurs when a new thread is created.

data: Thread { id, created_at, metadata, 2 more }

Represents a thread that contains messages.

event: "thread.created"

enabled: optional boolean

Whether to enable input audio transcription.

BetaThreads

Build Assistants that can call models and use tools.

Create thread

Deprecated

POST/threads

Create thread and run

Deprecated

POST/threads/runs

Retrieve thread

Deprecated

GET/threads/{thread_id}

Modify thread

Deprecated

POST/threads/{thread_id}

Delete thread

Deprecated

DELETE/threads/{thread_id}

ModelsExpand Collapse

AssistantResponseFormatOption = "auto" or ResponseFormatText { type } or ResponseFormatJSONObject { type } or ResponseFormatJSONSchema { json_schema, type }

Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

One of the following:

"auto"

auto is the default value

ResponseFormatText = object { type }

Default response format. Used to generate text responses.

type: "text"

The type of response format being defined. Always text.

ResponseFormatJSONObject = object { type }

JSON object response format. An older method of generating JSON responses. Using json_schema is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.

type: "json_object"

The type of response format being defined. Always json_object.

ResponseFormatJSONSchema = object { json_schema, type }

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

json_schema: object { name, description, schema, strict }

Structured Outputs configuration options, including a JSON Schema.

The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

description: optional string

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

schema: optional map[unknown]

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

strict: optional boolean

Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.

type: "json_schema"

The type of response format being defined. Always json_schema.

AssistantToolChoice = object { type, function }

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

type: "function" or "code_interpreter" or "file_search"

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

One of the following:

"function"

"code_interpreter"

"file_search"

function: optional AssistantToolChoiceFunction { name }

AssistantToolChoiceFunction = object { name }

The name of the function to call.

AssistantToolChoiceOption = "none" or "auto" or "required" or AssistantToolChoice { type, function }

Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

One of the following:

"none" or "auto" or "required"

none means the model will not call any tools and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user.

One of the following:

"none"

"auto"

"required"

AssistantToolChoice = object { type, function }

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

type: "function" or "code_interpreter" or "file_search"

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

One of the following:

"function"

"code_interpreter"

"file_search"

function: optional AssistantToolChoiceFunction { name }

Thread = object { id, created_at, metadata, 2 more }

Represents a thread that contains messages.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

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.

tool_resources: object { code_interpreter, file_search }

A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

code_interpreter: optional object { file_ids }

file_ids: optional array of string

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

file_search: optional object { vector_store_ids }

vector_store_ids: optional array of string

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

ThreadDeleted = object { id, deleted, object }

id: string

deleted: boolean

object: "thread.deleted"

BetaThreadsRuns

Build Assistants that can call models and use tools.

List runs

Deprecated

GET/threads/{thread_id}/runs

Create run

Deprecated

POST/threads/{thread_id}/runs

Retrieve run

Deprecated

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

Modify run

Deprecated

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

Submit tool outputs to run

Deprecated

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

Cancel a run

Deprecated

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

ModelsExpand Collapse

RequiredActionFunctionToolCall = object { id, function, type }

Tool call objects

id: string

The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the Submit tool outputs to run endpoint.

function: object { arguments, name }

The function definition.

arguments: string

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

The name of the function.

type: "function"

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

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

Represents an execution run on a thread.

id: string

The identifier, which can be referenced in API endpoints.

assistant_id: string

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

cancelled_at: number

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

completed_at: number

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

created_at: number

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

expires_at: number

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

failed_at: number

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

incomplete_details: object { reason }

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

reason: optional "max_completion_tokens" or "max_prompt_tokens"

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

One of the following:

"max_completion_tokens"

"max_prompt_tokens"

instructions: string

The instructions that the assistant used for this run.

last_error: object { code, message }

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

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

One of server_error, rate_limit_exceeded, or invalid_prompt.

One of the following:

"server_error"

"rate_limit_exceeded"

"invalid_prompt"

message: string

A human-readable description of the error.

max_completion_tokens: number

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

minimum256

max_prompt_tokens: number

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

minimum256

metadata: Metadata

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

model: string

The model that the assistant used for this run.

object: "thread.run"

The object type, which is always thread.run.

parallel_tool_calls: boolean

Whether to enable parallel function calling during tool use.

required_action: object { submit_tool_outputs, type }

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

submit_tool_outputs: object { tool_calls }

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

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

A list of the relevant tool calls.

id: string

The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the Submit tool outputs to run endpoint.

function: object { arguments, name }

The function definition.

arguments: string

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

The name of the function.

type: "function"

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

type: "submit_tool_outputs"

For now, this is always submit_tool_outputs.

response_format: AssistantResponseFormatOption

Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

started_at: number

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

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

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

One of the following:

"queued"

"in_progress"

"requires_action"

"cancelling"

"cancelled"

"failed"

"completed"

"incomplete"

"expired"

thread_id: string

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

tool_choice: AssistantToolChoiceOption

tools: array of CodeInterpreterTool { type } or FileSearchTool { type, file_search } or FunctionTool { function, type }

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

One of the following:

CodeInterpreterTool = object { type }

type: "code_interpreter"

The type of tool being defined: code_interpreter

FileSearchTool = object { type, file_search }

type: "file_search"

The type of tool being defined: file_search

file_search: optional object { max_num_results, ranking_options }

Overrides for the file search tool.

max_num_results: optional number

The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.

Note that the file search tool may output fewer than max_num_results results. See the file search tool documentation for more information.

minimum1

maximum50

ranking_options: optional object { score_threshold, ranker }

The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0.

See the file search tool documentation for more information.

score_threshold: number

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

minimum0

maximum1

ranker: optional "auto" or "default_2024_08_21"

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

One of the following:

"auto"

"default_2024_08_21"

FunctionTool = object { function, type }

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

type: "function"

The type of tool being defined: function

truncation_strategy: object { type, last_messages }

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

type: "auto" or "last_messages"

The truncation strategy to use for the thread. The default is auto. If set to last_messages, the thread will be truncated to the n most recent messages in the thread. When set to auto, messages in the middle of the thread will be dropped to fit the context length of the model, max_prompt_tokens.

One of the following:

"auto"

"last_messages"

last_messages: optional number

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

minimum1

usage: object { completion_tokens, prompt_tokens, total_tokens }

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

completion_tokens: number

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

prompt_tokens: number

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

total_tokens: number

Total number of tokens used (prompt + completion).

temperature: optional number

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

top_p: optional number

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

BetaThreadsRunsSteps

Build Assistants that can call models and use tools.

List run steps

Deprecated

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

Retrieve run step

Deprecated

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

ModelsExpand Collapse

CodeInterpreterLogs = object { index, type, logs }

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

index: number

The index of the output in the outputs array.

type: "logs"

Always logs.

logs: optional string

The text output from the Code Interpreter tool call.

CodeInterpreterOutputImage = object { index, type, image }

index: number

The index of the output in the outputs array.

type: "image"

Always image.

image: optional object { file_id }

file_id: optional string

The file ID of the image.

CodeInterpreterToolCall = object { id, code_interpreter, type }

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

id: string

The ID of the tool call.

code_interpreter: object { input, outputs }

The Code Interpreter tool call definition.

input: string

The input to the Code Interpreter tool call.

outputs: array of object { logs, type } or object { image, type }

The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.

One of the following:

CodeInterpreterLogOutput = object { logs, type }

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

logs: string

The text output from the Code Interpreter tool call.

type: "logs"

Always logs.

CodeInterpreterImageOutput = object { image, type }

image: object { file_id }

file_id: string

The file ID of the image.

type: "image"

Always image.

type: "code_interpreter"

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

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

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

index: number

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

type: "code_interpreter"

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

id: optional string

The ID of the tool call.

code_interpreter: optional object { input, outputs }

The Code Interpreter tool call definition.

input: optional string

The input to the Code Interpreter tool call.

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

The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.

One of the following:

CodeInterpreterLogs = object { index, type, logs }

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

index: number

The index of the output in the outputs array.

type: "logs"

Always logs.

logs: optional string

The text output from the Code Interpreter tool call.

CodeInterpreterOutputImage = object { index, type, image }

index: number

The index of the output in the outputs array.

type: "image"

Always image.

image: optional object { file_id }

file_id: optional string

The file ID of the image.

FileSearchToolCall = object { id, file_search, type }

id: string

The ID of the tool call object.

file_search: object { ranking_options, results }

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

ranking_options: optional object { ranker, score_threshold }

The ranking options for the file search.

ranker: "auto" or "default_2024_08_21"

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

One of the following:

"auto"

"default_2024_08_21"

score_threshold: number

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

minimum0

maximum1

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

The results of the file search.

file_id: string

The ID of the file that result was found in.

file_name: string

The name of the file that result was found in.

score: number

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

minimum0

maximum1

content: optional array of object { text, type }

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

text: optional string

The text content of the file.

type: optional "text"

The type of the content.

type: "file_search"

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

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

file_search: unknown

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

index: number

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

type: "file_search"

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

id: optional string

The ID of the tool call object.

FunctionToolCall = object { id, function, type }

id: string

The ID of the tool call object.

function: object { arguments, name, output }

The definition of the function that was called.

arguments: string

The arguments passed to the function.

The name of the function.

output: string

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

type: "function"

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

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

index: number

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

type: "function"

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

id: optional string

The ID of the tool call object.

function: optional object { arguments, name, output }

The definition of the function that was called.

arguments: optional string

The arguments passed to the function.

The name of the function.

output: optional string

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

MessageCreationStepDetails = object { message_creation, type }

Details of the message creation by the run step.

message_creation: object { message_id }

message_id: string

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

type: "message_creation"

Always message_creation.

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

Represents a step in execution of a run.

id: string

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

assistant_id: string

The ID of the assistant associated with the run step.

cancelled_at: number

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

completed_at: number

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

created_at: number

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

expired_at: number

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

failed_at: number

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

last_error: object { code, message }

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

code: "server_error" or "rate_limit_exceeded"

One of server_error or rate_limit_exceeded.

One of the following:

"server_error"

"rate_limit_exceeded"

message: string

A human-readable description of the error.

metadata: Metadata

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

object: "thread.run.step"

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

run_id: string

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

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

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

One of the following:

"in_progress"

"cancelled"

"failed"

"completed"

"expired"

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

The details of the run step.

One of the following:

MessageCreationStepDetails = object { message_creation, type }

Details of the message creation by the run step.

message_creation: object { message_id }

message_id: string

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

type: "message_creation"

Always message_creation.

ToolCallsStepDetails = object { tool_calls, type }

Details of the tool call.

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

An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.

One of the following:

CodeInterpreterToolCall = object { id, code_interpreter, type }

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

id: string

The ID of the tool call.

code_interpreter: object { input, outputs }

The Code Interpreter tool call definition.

input: string

The input to the Code Interpreter tool call.

outputs: array of object { logs, type } or object { image, type }

The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.

One of the following:

CodeInterpreterLogOutput = object { logs, type }

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

logs: string

The text output from the Code Interpreter tool call.

type: "logs"

Always logs.

CodeInterpreterImageOutput = object { image, type }

image: object { file_id }

file_id: string

The file ID of the image.

type: "image"

Always image.

type: "code_interpreter"

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

FileSearchToolCall = object { id, file_search, type }

id: string

The ID of the tool call object.

file_search: object { ranking_options, results }

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

ranking_options: optional object { ranker, score_threshold }

The ranking options for the file search.

ranker: "auto" or "default_2024_08_21"

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

One of the following:

"auto"

"default_2024_08_21"

score_threshold: number

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

minimum0

maximum1

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

The results of the file search.

file_id: string

The ID of the file that result was found in.

file_name: string

The name of the file that result was found in.

score: number

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

minimum0

maximum1

content: optional array of object { text, type }

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

text: optional string

The text content of the file.

type: optional "text"

The type of the content.

type: "file_search"

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

FunctionToolCall = object { id, function, type }

id: string

The ID of the tool call object.

function: object { arguments, name, output }

The definition of the function that was called.

arguments: string

The arguments passed to the function.

The name of the function.

output: string

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

type: "function"

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

type: "tool_calls"

Always tool_calls.

thread_id: string

The ID of the thread that was run.

type: "message_creation" or "tool_calls"

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

One of the following:

"message_creation"

"tool_calls"

usage: object { completion_tokens, prompt_tokens, total_tokens }

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

completion_tokens: number

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

prompt_tokens: number

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

total_tokens: number

Total number of tokens used (prompt + completion).

RunStepDeltaEvent = object { id, delta, object }

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

id: string

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

delta: object { step_details }

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

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

The details of the run step.

One of the following:

RunStepDeltaMessageDelta = object { type, message_creation }

Details of the message creation by the run step.

type: "message_creation"

Always message_creation.

message_creation: optional object { message_id }

message_id: optional string

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

ToolCallDeltaObject = object { type, tool_calls }

Details of the tool call.

type: "tool_calls"

Always tool_calls.

tool_calls: optional array of CodeInterpreterToolCallDelta { index, type, id, code_interpreter } or FileSearchToolCallDelta { file_search, index, type, id } or FunctionToolCallDelta { index, type, id, function }

An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.

One of the following:

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

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

index: number

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

type: "code_interpreter"

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

id: optional string

The ID of the tool call.

code_interpreter: optional object { input, outputs }

The Code Interpreter tool call definition.

input: optional string

The input to the Code Interpreter tool call.

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

The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.

One of the following:

CodeInterpreterLogs = object { index, type, logs }

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

index: number

The index of the output in the outputs array.

type: "logs"

Always logs.

logs: optional string

The text output from the Code Interpreter tool call.

CodeInterpreterOutputImage = object { index, type, image }

index: number

The index of the output in the outputs array.

type: "image"

Always image.

image: optional object { file_id }

file_id: optional string

The file ID of the image.

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

file_search: unknown

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

index: number

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

type: "file_search"

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

id: optional string

The ID of the tool call object.

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

index: number

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

type: "function"

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

id: optional string

The ID of the tool call object.

function: optional object { arguments, name, output }

The definition of the function that was called.

arguments: optional string

The arguments passed to the function.

The name of the function.

output: optional string

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

object: "thread.run.step.delta"

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

RunStepDeltaMessageDelta = object { type, message_creation }

Details of the message creation by the run step.

type: "message_creation"

Always message_creation.

message_creation: optional object { message_id }

message_id: optional string

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

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

ToolCallDeltaObject = object { type, tool_calls }

Details of the tool call.

type: "tool_calls"

Always tool_calls.

An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.

One of the following:

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

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

index: number

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

type: "code_interpreter"

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

id: optional string

The ID of the tool call.

code_interpreter: optional object { input, outputs }

The Code Interpreter tool call definition.

input: optional string

The input to the Code Interpreter tool call.

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

The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.

One of the following:

CodeInterpreterLogs = object { index, type, logs }

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

index: number

The index of the output in the outputs array.

type: "logs"

Always logs.

logs: optional string

The text output from the Code Interpreter tool call.

CodeInterpreterOutputImage = object { index, type, image }

index: number

The index of the output in the outputs array.

type: "image"

Always image.

image: optional object { file_id }

file_id: optional string

The file ID of the image.

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

file_search: unknown

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

index: number

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

type: "file_search"

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

id: optional string

The ID of the tool call object.

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

index: number

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

type: "function"

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

id: optional string

The ID of the tool call object.

function: optional object { arguments, name, output }

The definition of the function that was called.

arguments: optional string

The arguments passed to the function.

The name of the function.

output: optional string

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

ToolCallsStepDetails = object { tool_calls, type }

Details of the tool call.

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

An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.

One of the following:

CodeInterpreterToolCall = object { id, code_interpreter, type }

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

id: string

The ID of the tool call.

code_interpreter: object { input, outputs }

The Code Interpreter tool call definition.

input: string

The input to the Code Interpreter tool call.

outputs: array of object { logs, type } or object { image, type }

The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.

One of the following:

CodeInterpreterLogOutput = object { logs, type }

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

logs: string

The text output from the Code Interpreter tool call.

type: "logs"

Always logs.

CodeInterpreterImageOutput = object { image, type }

image: object { file_id }

file_id: string

The file ID of the image.

type: "image"

Always image.

type: "code_interpreter"

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

FileSearchToolCall = object { id, file_search, type }

id: string

The ID of the tool call object.

file_search: object { ranking_options, results }

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

ranking_options: optional object { ranker, score_threshold }

The ranking options for the file search.

ranker: "auto" or "default_2024_08_21"

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

One of the following:

"auto"

"default_2024_08_21"

score_threshold: number

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

minimum0

maximum1

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

The results of the file search.

file_id: string

The ID of the file that result was found in.

file_name: string

The name of the file that result was found in.

score: number

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

minimum0

maximum1

content: optional array of object { text, type }

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

text: optional string

The text content of the file.

type: optional "text"

The type of the content.

type: "file_search"

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

FunctionToolCall = object { id, function, type }

id: string

The ID of the tool call object.

function: object { arguments, name, output }

The definition of the function that was called.

arguments: string

The arguments passed to the function.

The name of the function.

output: string

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

type: "function"

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

type: "tool_calls"

Always tool_calls.

BetaThreadsMessages

Build Assistants that can call models and use tools.

List messages

Deprecated

GET/threads/{thread_id}/messages

Create message

Deprecated

POST/threads/{thread_id}/messages

Modify message

Deprecated

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

Retrieve message

Deprecated

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

Delete message

Deprecated

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

ModelsExpand Collapse

FileCitationAnnotation = object { end_index, file_citation, start_index, 2 more }

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files.

end_index: number

minimum0

file_citation: object { file_id }

file_id: string

The ID of the specific File the citation is from.

start_index: number

minimum0

text: string

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

type: "file_citation"

Always file_citation.

FileCitationDeltaAnnotation = object { index, type, end_index, 3 more }

index: number

The index of the annotation in the text content part.

type: "file_citation"

Always file_citation.

end_index: optional number

minimum0

file_citation: optional object { file_id, quote }

file_id: optional string

The ID of the specific File the citation is from.

quote: optional string

The specific quote in the file.

start_index: optional number

minimum0

text: optional string

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

FilePathAnnotation = object { end_index, file_path, start_index, 2 more }

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

end_index: number

minimum0

file_path: object { file_id }

file_id: string

The ID of the file that was generated.

start_index: number

minimum0

text: string

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

type: "file_path"

Always file_path.

FilePathDeltaAnnotation = object { index, type, end_index, 3 more }

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

index: number

The index of the annotation in the text content part.

type: "file_path"

Always file_path.

end_index: optional number

minimum0

file_path: optional object { file_id }

file_id: optional string

The ID of the file that was generated.

start_index: optional number

minimum0

text: optional string

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

ImageFile = object { file_id, detail }

file_id: string

The File ID of the image in the message content. Set purpose="vision" when uploading the File if you need to later display the file content.

detail: optional "auto" or "low" or "high"

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

One of the following:

"auto"

"low"

"high"

ImageFileContentBlock = object { image_file, type }

References an image File in the content of a message.

image_file: ImageFile { file_id, detail }

type: "image_file"

Always image_file.

ImageFileDelta = object { detail, file_id }

detail: optional "auto" or "low" or "high"

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

One of the following:

"auto"

"low"

"high"

file_id: optional string

The File ID of the image in the message content. Set purpose="vision" when uploading the File if you need to later display the file content.

ImageFileDeltaBlock = object { index, type, image_file }

References an image File in the content of a message.

index: number

The index of the content part in the message.

type: "image_file"

Always image_file.

image_file: optional ImageFileDelta { detail, file_id }

ImageURL = object { url, detail }

url: string

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

formaturi

detail: optional "auto" or "low" or "high"

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

One of the following:

"auto"

"low"

"high"

ImageURLContentBlock = object { image_url, type }

References an image URL in the content of a message.

image_url: ImageURL { url, detail }

type: "image_url"

The type of the content part.

ImageURLDelta = object { detail, url }

detail: optional "auto" or "low" or "high"

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

One of the following:

"auto"

"low"

"high"

url: optional string

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

ImageURLDeltaBlock = object { index, type, image_url }

References an image URL in the content of a message.

index: number

The index of the content part in the message.

type: "image_url"

Always image_url.

image_url: optional ImageURLDelta { detail, url }

Message = object { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

id: string

The identifier, which can be referenced in API endpoints.

assistant_id: string

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

attachments: array of object { file_id, tools }

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

file_id: optional string

The ID of the file to attach to the message.

tools: optional array of CodeInterpreterTool { type } or object { type }

The tools to add this file to.

One of the following:

CodeInterpreterTool = object { type }

type: "code_interpreter"

The type of tool being defined: code_interpreter

FileSearchTool = object { type }

type: "file_search"

The type of tool being defined: file_search

completed_at: number

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

content: array of ImageFileContentBlock { image_file, type } or ImageURLContentBlock { image_url, type } or TextContentBlock { text, type } or RefusalContentBlock { refusal, type }

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

One of the following:

ImageFileContentBlock = object { image_file, type }

References an image File in the content of a message.

image_file: ImageFile { file_id, detail }

type: "image_file"

Always image_file.

ImageURLContentBlock = object { image_url, type }

References an image URL in the content of a message.

image_url: ImageURL { url, detail }

type: "image_url"

The type of the content part.

TextContentBlock = object { text, type }

The text content that is part of a message.

text: Text { annotations, value }

type: "text"

Always text.

RefusalContentBlock = object { refusal, type }

The refusal content generated by the assistant.

refusal: string

type: "refusal"

Always refusal.

created_at: number

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

incomplete_at: number

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

incomplete_details: object { reason }

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

reason: "content_filter" or "max_tokens" or "run_cancelled" or 2 more

The reason the message is incomplete.

One of the following:

"content_filter"

"max_tokens"

"run_cancelled"

"run_expired"

"run_failed"

metadata: Metadata

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

object: "thread.message"

The object type, which is always thread.message.

role: "user" or "assistant"

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

One of the following:

"user"

"assistant"

run_id: string

The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.

status: "in_progress" or "incomplete" or "completed"

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

One of the following:

"in_progress"

"incomplete"

"completed"

thread_id: string

The thread ID that this message belongs to.

MessageDeleted = object { id, deleted, object }

id: string

deleted: boolean

object: "thread.message.deleted"

MessageDelta = object { content, role }

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

content: optional array of ImageFileDeltaBlock { index, type, image_file } or TextDeltaBlock { index, type, text } or RefusalDeltaBlock { index, type, refusal } or ImageURLDeltaBlock { index, type, image_url }

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

One of the following:

ImageFileDeltaBlock = object { index, type, image_file }

References an image File in the content of a message.

index: number

The index of the content part in the message.

type: "image_file"

Always image_file.

image_file: optional ImageFileDelta { detail, file_id }

TextDeltaBlock = object { index, type, text }

The text content that is part of a message.

index: number

The index of the content part in the message.

type: "text"

Always text.

text: optional TextDelta { annotations, value }

RefusalDeltaBlock = object { index, type, refusal }

The refusal content that is part of a message.

index: number

The index of the refusal part in the message.

type: "refusal"

Always refusal.

refusal: optional string

ImageURLDeltaBlock = object { index, type, image_url }

References an image URL in the content of a message.

index: number

The index of the content part in the message.

type: "image_url"

Always image_url.

image_url: optional ImageURLDelta { detail, url }

role: optional "user" or "assistant"

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

One of the following:

"user"

"assistant"

MessageDeltaEvent = object { id, delta, object }

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

id: string

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

delta: MessageDelta { content, role }

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

object: "thread.message.delta"

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

RefusalContentBlock = object { refusal, type }

The refusal content generated by the assistant.

refusal: string

type: "refusal"

Always refusal.

RefusalDeltaBlock = object { index, type, refusal }

The refusal content that is part of a message.

index: number

The index of the refusal part in the message.

type: "refusal"

Always refusal.

refusal: optional string

Text = object { annotations, value }

annotations: array of FileCitationAnnotation { end_index, file_citation, start_index, 2 more } or FilePathAnnotation { end_index, file_path, start_index, 2 more }

One of the following:

FileCitationAnnotation = object { end_index, file_citation, start_index, 2 more }

end_index: number

minimum0

file_citation: object { file_id }

file_id: string

The ID of the specific File the citation is from.

start_index: number

minimum0

text: string

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

type: "file_citation"

Always file_citation.

FilePathAnnotation = object { end_index, file_path, start_index, 2 more }

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

end_index: number

minimum0

file_path: object { file_id }

file_id: string

The ID of the file that was generated.

start_index: number

minimum0

text: string

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

type: "file_path"

Always file_path.

value: string

The data that makes up the text.

TextContentBlock = object { text, type }

The text content that is part of a message.

text: Text { annotations, value }

type: "text"

Always text.

TextContentBlockParam = object { text, type }

The text content that is part of a message.

text: string

Text content to be sent to the model

type: "text"

Always text.

TextDelta = object { annotations, value }

annotations: optional array of FileCitationDeltaAnnotation { index, type, end_index, 3 more } or FilePathDeltaAnnotation { index, type, end_index, 3 more }

One of the following:

FileCitationDeltaAnnotation = object { index, type, end_index, 3 more }

index: number

The index of the annotation in the text content part.

type: "file_citation"

Always file_citation.

end_index: optional number

minimum0

file_citation: optional object { file_id, quote }

file_id: optional string

The ID of the specific File the citation is from.

quote: optional string

The specific quote in the file.

start_index: optional number

minimum0

text: optional string

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

FilePathDeltaAnnotation = object { index, type, end_index, 3 more }

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

index: number

The index of the annotation in the text content part.

type: "file_path"

Always file_path.

end_index: optional number

minimum0

file_path: optional object { file_id }

file_id: optional string

The ID of the file that was generated.

start_index: optional number

minimum0

text: optional string

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

value: optional string

The data that makes up the text.

TextDeltaBlock = object { index, type, text }

The text content that is part of a message.

index: number

The index of the content part in the message.

type: "text"

Always text.

text: optional TextDelta { annotations, value }

Suggested

Beta

BetaChatKit

ModelsExpand Collapse

BetaChatKitSessions

BetaChatKitThreads

ModelsExpand Collapse

BetaAssistants

ModelsExpand Collapse

BetaThreads

ModelsExpand Collapse

BetaThreadsRuns

ModelsExpand Collapse

BetaThreadsRunsSteps

ModelsExpand Collapse

BetaThreadsMessages

ModelsExpand Collapse