# Beta # ChatKit ## Domain Types ### ChatKit Workflow - `ChatKitWorkflow` Workflow metadata and state returned for the session. - `id: string` Identifier of the workflow backing the session. - `state_variables: Record | null` State variable key-value pairs applied when invoking the workflow. Defaults to null when no overrides were provided. - `string` - `boolean` - `number` - `tracing: Tracing` Tracing settings applied to the workflow. - `enabled: boolean` Indicates whether tracing is enabled. - `version: string | null` Specific workflow version used for the session. Defaults to null when using the latest deployment. # Sessions ## Cancel chat session `client.beta.chatkit.sessions.cancel(stringsessionID, RequestOptionsoptions?): ChatSession` **post** `/chatkit/sessions/{session_id}/cancel` Cancel an active ChatKit session and return its most recent metadata. Cancelling prevents new requests from using the issued client secret. ### Parameters - `sessionID: string` ### Returns - `ChatSession` Represents a ChatKit session and its resolved configuration. - `id: string` Identifier for the ChatKit session. - `chatkit_configuration: ChatSessionChatKitConfiguration` Resolved ChatKit feature configuration for the session. - `automatic_thread_titling: ChatSessionAutomaticThreadTitling` Automatic thread titling preferences. - `enabled: boolean` Whether automatic thread titling is enabled. - `file_upload: ChatSessionFileUpload` Upload settings for the session. - `enabled: boolean` Indicates if uploads are enabled for the session. - `max_file_size: number | null` Maximum upload size in megabytes. - `max_files: number | null` Maximum number of uploads allowed during the session. - `history: ChatSessionHistory` History retention configuration. - `enabled: boolean` Indicates if chat history is persisted for the session. - `recent_threads: number | null` Number of prior threads surfaced in history views. Defaults to null when all history is retained. - `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`. - `"chatkit.session"` - `rate_limits: ChatSessionRateLimits` Resolved rate limit values. - `max_requests_per_1_minute: number` Maximum allowed requests per one-minute window. - `status: ChatSessionStatus` Current lifecycle state of the session. - `"active"` - `"expired"` - `"cancelled"` - `user: string` User identifier associated with the session. - `workflow: ChatKitWorkflow` Workflow metadata for the session. - `id: string` Identifier of the workflow backing the session. - `state_variables: Record | null` State variable key-value pairs applied when invoking the workflow. Defaults to null when no overrides were provided. - `string` - `boolean` - `number` - `tracing: Tracing` Tracing settings applied to the workflow. - `enabled: boolean` Indicates whether tracing is enabled. - `version: string | null` Specific workflow version used for the session. Defaults to null when using the latest deployment. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const chatSession = await client.beta.chatkit.sessions.cancel('cksess_123'); console.log(chatSession.id); ``` #### Response ```json { "id": "id", "chatkit_configuration": { "automatic_thread_titling": { "enabled": true }, "file_upload": { "enabled": true, "max_file_size": 0, "max_files": 0 }, "history": { "enabled": true, "recent_threads": 0 } }, "client_secret": "client_secret", "expires_at": 0, "max_requests_per_1_minute": 0, "object": "chatkit.session", "rate_limits": { "max_requests_per_1_minute": 0 }, "status": "active", "user": "user", "workflow": { "id": "id", "state_variables": { "foo": "string" }, "tracing": { "enabled": true }, "version": "version" } } ``` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI(); const chatSession = await client.beta.chatkit.sessions.cancel('cksess_123'); console.log(chatSession.id); ``` #### Response ```json { "id": "cksess_123", "object": "chatkit.session", "workflow": { "id": "workflow_alpha", "version": "1" }, "scope": { "customer_id": "cust_456" }, "max_requests_per_1_minute": 30, "ttl_seconds": 900, "status": "cancelled", "cancelled_at": 1712345678 } ``` ## Create ChatKit session `client.beta.chatkit.sessions.create(SessionCreateParamsbody, RequestOptionsoptions?): ChatSession` **post** `/chatkit/sessions` Create a ChatKit session. ### Parameters - `body: SessionCreateParams` - `user: string` A free-form string that identifies your end user; ensures this Session can access other objects that have the same `user` scope. - `workflow: ChatSessionWorkflowParam` Workflow that powers the session. - `id: string` Identifier for the workflow invoked by the session. - `state_variables?: Record` 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. - `string` - `boolean` - `number` - `tracing?: Tracing` Optional tracing overrides for the workflow invocation. When omitted, tracing is enabled by default. - `enabled?: boolean` Whether tracing is enabled during the session. Defaults to true. - `version?: string` Specific workflow version to run. Defaults to the latest deployed version. - `chatkit_configuration?: ChatSessionChatKitConfigurationParam` Optional overrides for ChatKit runtime configuration features - `automatic_thread_titling?: AutomaticThreadTitling` Configuration for automatic thread titling. When omitted, automatic thread titling is enabled by default. - `enabled?: boolean` Enable automatic thread title generation. Defaults to true. - `file_upload?: FileUpload` Configuration for upload enablement and limits. When omitted, uploads are disabled by default (max_files 10, max_file_size 512 MB). - `enabled?: boolean` Enable uploads for this session. Defaults to false. - `max_file_size?: number` Maximum size in megabytes for each uploaded file. Defaults to 512 MB, which is the maximum allowable size. - `max_files?: number` Maximum number of files that can be uploaded to the session. Defaults to 10. - `history?: History` Configuration for chat history retention. When omitted, history is enabled by default with no limit on recent_threads (null). - `enabled?: boolean` Enables chat users to access previous ChatKit threads. Defaults to true. - `recent_threads?: number` Number of recent ChatKit threads users have access to. Defaults to unlimited when unset. - `expires_after?: ChatSessionExpiresAfterParam` Optional override for session expiration timing in seconds from creation. Defaults to 10 minutes. - `anchor: "created_at"` Base timestamp used to calculate expiration. Currently fixed to `created_at`. - `"created_at"` - `seconds: number` Number of seconds after the anchor when the session expires. - `rate_limits?: ChatSessionRateLimitsParam` Optional override for per-minute request limits. When omitted, defaults to 10. - `max_requests_per_1_minute?: number` Maximum number of requests allowed per minute for the session. Defaults to 10. ### Returns - `ChatSession` Represents a ChatKit session and its resolved configuration. - `id: string` Identifier for the ChatKit session. - `chatkit_configuration: ChatSessionChatKitConfiguration` Resolved ChatKit feature configuration for the session. - `automatic_thread_titling: ChatSessionAutomaticThreadTitling` Automatic thread titling preferences. - `enabled: boolean` Whether automatic thread titling is enabled. - `file_upload: ChatSessionFileUpload` Upload settings for the session. - `enabled: boolean` Indicates if uploads are enabled for the session. - `max_file_size: number | null` Maximum upload size in megabytes. - `max_files: number | null` Maximum number of uploads allowed during the session. - `history: ChatSessionHistory` History retention configuration. - `enabled: boolean` Indicates if chat history is persisted for the session. - `recent_threads: number | null` Number of prior threads surfaced in history views. Defaults to null when all history is retained. - `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`. - `"chatkit.session"` - `rate_limits: ChatSessionRateLimits` Resolved rate limit values. - `max_requests_per_1_minute: number` Maximum allowed requests per one-minute window. - `status: ChatSessionStatus` Current lifecycle state of the session. - `"active"` - `"expired"` - `"cancelled"` - `user: string` User identifier associated with the session. - `workflow: ChatKitWorkflow` Workflow metadata for the session. - `id: string` Identifier of the workflow backing the session. - `state_variables: Record | null` State variable key-value pairs applied when invoking the workflow. Defaults to null when no overrides were provided. - `string` - `boolean` - `number` - `tracing: Tracing` Tracing settings applied to the workflow. - `enabled: boolean` Indicates whether tracing is enabled. - `version: string | null` Specific workflow version used for the session. Defaults to null when using the latest deployment. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const chatSession = await client.beta.chatkit.sessions.create({ user: 'x', workflow: { id: 'id' }, }); console.log(chatSession.id); ``` #### Response ```json { "id": "id", "chatkit_configuration": { "automatic_thread_titling": { "enabled": true }, "file_upload": { "enabled": true, "max_file_size": 0, "max_files": 0 }, "history": { "enabled": true, "recent_threads": 0 } }, "client_secret": "client_secret", "expires_at": 0, "max_requests_per_1_minute": 0, "object": "chatkit.session", "rate_limits": { "max_requests_per_1_minute": 0 }, "status": "active", "user": "user", "workflow": { "id": "id", "state_variables": { "foo": "string" }, "tracing": { "enabled": true }, "version": "version" } } ``` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI(); const chatSession = await client.beta.chatkit.sessions.create({ user: 'user', workflow: { id: 'id' } }); console.log(chatSession.id); ``` #### Response ```json { "client_secret": "chatkit_token_123", "expires_at": 1735689600, "workflow": { "id": "workflow_alpha", "version": "2024-10-01" }, "scope": { "project": "alpha", "environment": "staging" }, "max_requests_per_1_minute": 60, "max_requests_per_session": 500, "status": "active" } ``` # Threads ## List ChatKit thread items `client.beta.chatkit.threads.listItems(stringthreadID, ThreadListItemsParamsquery?, RequestOptionsoptions?): ConversationCursorPage` **get** `/chatkit/threads/{thread_id}/items` List items that belong to a ChatKit thread. ### Parameters - `threadID: string` - `query: ThreadListItemsParams` - `after?: string` List items created after this thread item ID. Defaults to null for the first page. - `before?: string` List items created before this thread item ID. Defaults to null for the newest results. - `limit?: number` Maximum number of thread items to return. Defaults to 20. - `order?: "asc" | "desc"` Sort order for results by creation time. Defaults to `desc`. - `"asc"` - `"desc"` ### Returns - `Data = ChatKitThreadUserMessageItem | ChatKitThreadAssistantMessageItem | ChatKitWidgetItem | 3 more` User-authored messages within a thread. - `ChatKitThreadUserMessageItem` User-authored messages within a thread. - `id: string` Identifier of the thread item. - `attachments: Array` 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. - `name: string` Original display name for the attachment. - `preview_url: string | null` Preview URL for rendering the attachment inline. - `type: "image" | "file"` Attachment discriminator. - `"image"` - `"file"` - `content: Array` Ordered content elements supplied by the user. - `InputText` 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`. - `"input_text"` - `QuotedText` Quoted snippet that the user referenced in their message. - `text: string` Quoted text content. - `type: "quoted_text"` Type discriminator that is always `quoted_text`. - `"quoted_text"` - `created_at: number` Unix timestamp (in seconds) for when the item was created. - `inference_options: InferenceOptions | null` Inference overrides applied to the message. Defaults to null when unset. - `model: string | null` Model name that generated the response. Defaults to null when using the session default. - `tool_choice: ToolChoice | null` 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`. - `"chatkit.thread_item"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.user_message"` - `"chatkit.user_message"` - `ChatKitThreadAssistantMessageItem` Assistant-authored message within a thread. - `id: string` Identifier of the thread item. - `content: Array` Ordered assistant response segments. - `annotations: Array` Ordered list of annotations attached to the response text. - `File` Annotation that references an uploaded file. - `source: Source` File attachment referenced by the annotation. - `filename: string` Filename referenced by the annotation. - `type: "file"` Type discriminator that is always `file`. - `"file"` - `type: "file"` Type discriminator that is always `file` for this annotation. - `"file"` - `URL` Annotation that references a URL. - `source: Source` URL referenced by the annotation. - `type: "url"` Type discriminator that is always `url`. - `"url"` - `url: string` URL referenced by the annotation. - `type: "url"` Type discriminator that is always `url` for this annotation. - `"url"` - `text: string` Assistant generated text. - `type: "output_text"` Type discriminator that is always `output_text`. - `"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`. - `"chatkit.thread_item"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.assistant_message"` Type discriminator that is always `chatkit.assistant_message`. - `"chatkit.assistant_message"` - `ChatKitWidgetItem` 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`. - `"chatkit.thread_item"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.widget"` Type discriminator that is always `chatkit.widget`. - `"chatkit.widget"` - `widget: string` Serialized widget payload rendered in the UI. - `ChatKitClientToolCall` 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. - `name: string` Tool name that was invoked. - `object: "chatkit.thread_item"` Type discriminator that is always `chatkit.thread_item`. - `"chatkit.thread_item"` - `output: string | null` JSON-encoded output captured from the tool. Defaults to null while execution is in progress. - `status: "in_progress" | "completed"` Execution status for the tool call. - `"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`. - `"chatkit.client_tool_call"` - `ChatKitTask` 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 | null` Optional heading for the task. Defaults to null when not provided. - `object: "chatkit.thread_item"` Type discriminator that is always `chatkit.thread_item`. - `"chatkit.thread_item"` - `summary: string | null` Optional summary that describes the task. Defaults to null when omitted. - `task_type: "custom" | "thought"` Subtype for the task. - `"custom"` - `"thought"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.task"` Type discriminator that is always `chatkit.task`. - `"chatkit.task"` - `ChatKitTaskGroup` 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`. - `"chatkit.thread_item"` - `tasks: Array` Tasks included in the group. - `heading: string | null` Optional heading for the grouped task. Defaults to null when not provided. - `summary: string | null` Optional summary that describes the grouped task. Defaults to null when omitted. - `type: "custom" | "thought"` Subtype for the grouped task. - `"custom"` - `"thought"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.task_group"` Type discriminator that is always `chatkit.task_group`. - `"chatkit.task_group"` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const thread of client.beta.chatkit.threads.listItems('cthr_123')) { console.log(thread); } ``` #### Response ```json { "data": [ { "id": "id", "attachments": [ { "id": "id", "mime_type": "mime_type", "name": "name", "preview_url": "preview_url", "type": "image" } ], "content": [ { "text": "text", "type": "input_text" } ], "created_at": 0, "inference_options": { "model": "model", "tool_choice": { "id": "id" } }, "object": "chatkit.thread_item", "thread_id": "thread_id", "type": "chatkit.user_message" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id", "object": "list" } ``` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI(); // Automatically fetches more pages as needed. for await (const thread of client.beta.chatkit.threads.listItems('cthr_123')) { console.log(thread); } ``` #### Response ```json { "data": [ { "id": "cthi_user_001", "object": "chatkit.thread_item", "type": "user_message", "content": [ { "type": "input_text", "text": "I need help debugging an onboarding issue." } ], "attachments": [] }, { "id": "cthi_assistant_002", "object": "chatkit.thread_item", "type": "assistant_message", "content": [ { "type": "output_text", "text": "Let's start by confirming the workflow version you deployed." } ] } ], "has_more": false, "object": "list" } ``` ## Retrieve ChatKit thread `client.beta.chatkit.threads.retrieve(stringthreadID, RequestOptionsoptions?): ChatKitThread` **get** `/chatkit/threads/{thread_id}` Retrieve a ChatKit thread by its identifier. ### Parameters - `threadID: string` ### Returns - `ChatKitThread` 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`. - `"chatkit.thread"` - `status: Active | Locked | Closed` Current status for the thread. Defaults to `active` for newly created threads. - `Active` Indicates that a thread is active. - `type: "active"` Status discriminator that is always `active`. - `"active"` - `Locked` Indicates that a thread is locked and cannot accept new input. - `reason: string | null` Reason that the thread was locked. Defaults to null when no reason is recorded. - `type: "locked"` Status discriminator that is always `locked`. - `"locked"` - `Closed` Indicates that a thread has been closed. - `reason: string | null` Reason that the thread was closed. Defaults to null when no reason is recorded. - `type: "closed"` Status discriminator that is always `closed`. - `"closed"` - `title: string | null` 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. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const chatkitThread = await client.beta.chatkit.threads.retrieve('cthr_123'); console.log(chatkitThread.id); ``` #### Response ```json { "id": "cthr_def456", "created_at": 1712345600, "object": "chatkit.thread", "status": { "type": "active" }, "title": "Demo feedback", "user": "user_456" } ``` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI(); const chatkitThread = await client.beta.chatkit.threads.retrieve('cthr_123'); console.log(chatkitThread.id); ``` #### Response ```json { "id": "cthr_abc123", "object": "chatkit.thread", "title": "Customer escalation", "items": { "data": [ { "id": "cthi_user_001", "object": "chatkit.thread_item", "type": "user_message", "content": [ { "type": "input_text", "text": "I need help debugging an onboarding issue." } ], "attachments": [] }, { "id": "cthi_assistant_002", "object": "chatkit.thread_item", "type": "assistant_message", "content": [ { "type": "output_text", "text": "Let's start by confirming the workflow version you deployed." } ] } ], "has_more": false } } ``` ## Delete ChatKit thread `client.beta.chatkit.threads.delete(stringthreadID, RequestOptionsoptions?): ThreadDeleteResponse` **delete** `/chatkit/threads/{thread_id}` Delete a ChatKit thread along with its items and stored attachments. ### Parameters - `threadID: string` ### Returns - `ThreadDeleteResponse` Confirmation payload returned after deleting a thread. - `id: string` Identifier of the deleted thread. - `deleted: boolean` Indicates that the thread has been deleted. - `object: "chatkit.thread.deleted"` Type discriminator that is always `chatkit.thread.deleted`. - `"chatkit.thread.deleted"` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const thread = await client.beta.chatkit.threads.delete('cthr_123'); console.log(thread.id); ``` #### Response ```json { "id": "id", "deleted": true, "object": "chatkit.thread.deleted" } ``` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI(); const thread = await client.beta.chat_kit.threads.delete('cthr_123'); console.log(thread.id); ``` ## List ChatKit threads `client.beta.chatkit.threads.list(ThreadListParamsquery?, RequestOptionsoptions?): ConversationCursorPage` **get** `/chatkit/threads` List ChatKit threads with optional pagination and user filters. ### Parameters - `query: ThreadListParams` - `after?: string` List items created after this thread item ID. Defaults to null for the first page. - `before?: string` List items created before this thread item ID. Defaults to null for the newest results. - `limit?: number` Maximum number of thread items to return. Defaults to 20. - `order?: "asc" | "desc"` Sort order for results by creation time. Defaults to `desc`. - `"asc"` - `"desc"` - `user?: string` Filter threads that belong to this user identifier. Defaults to null to return all users. ### Returns - `ChatKitThread` 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`. - `"chatkit.thread"` - `status: Active | Locked | Closed` Current status for the thread. Defaults to `active` for newly created threads. - `Active` Indicates that a thread is active. - `type: "active"` Status discriminator that is always `active`. - `"active"` - `Locked` Indicates that a thread is locked and cannot accept new input. - `reason: string | null` Reason that the thread was locked. Defaults to null when no reason is recorded. - `type: "locked"` Status discriminator that is always `locked`. - `"locked"` - `Closed` Indicates that a thread has been closed. - `reason: string | null` Reason that the thread was closed. Defaults to null when no reason is recorded. - `type: "closed"` Status discriminator that is always `closed`. - `"closed"` - `title: string | null` 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. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const chatkitThread of client.beta.chatkit.threads.list()) { console.log(chatkitThread.id); } ``` #### Response ```json { "data": [ { "id": "cthr_def456", "created_at": 1712345600, "object": "chatkit.thread", "status": { "type": "active" }, "title": "Demo feedback", "user": "user_456" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id", "object": "list" } ``` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI(); // Automatically fetches more pages as needed. for await (const chatkitThread of client.beta.chatkit.threads.list()) { console.log(chatkitThread.id); } ``` #### Response ```json { "data": [ { "id": "cthr_abc123", "object": "chatkit.thread", "title": "Customer escalation" }, { "id": "cthr_def456", "object": "chatkit.thread", "title": "Demo feedback" } ], "has_more": false, "object": "list" } ``` ## Domain Types ### Chat Session - `ChatSession` Represents a ChatKit session and its resolved configuration. - `id: string` Identifier for the ChatKit session. - `chatkit_configuration: ChatSessionChatKitConfiguration` Resolved ChatKit feature configuration for the session. - `automatic_thread_titling: ChatSessionAutomaticThreadTitling` Automatic thread titling preferences. - `enabled: boolean` Whether automatic thread titling is enabled. - `file_upload: ChatSessionFileUpload` Upload settings for the session. - `enabled: boolean` Indicates if uploads are enabled for the session. - `max_file_size: number | null` Maximum upload size in megabytes. - `max_files: number | null` Maximum number of uploads allowed during the session. - `history: ChatSessionHistory` History retention configuration. - `enabled: boolean` Indicates if chat history is persisted for the session. - `recent_threads: number | null` Number of prior threads surfaced in history views. Defaults to null when all history is retained. - `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`. - `"chatkit.session"` - `rate_limits: ChatSessionRateLimits` Resolved rate limit values. - `max_requests_per_1_minute: number` Maximum allowed requests per one-minute window. - `status: ChatSessionStatus` Current lifecycle state of the session. - `"active"` - `"expired"` - `"cancelled"` - `user: string` User identifier associated with the session. - `workflow: ChatKitWorkflow` Workflow metadata for the session. - `id: string` Identifier of the workflow backing the session. - `state_variables: Record | null` State variable key-value pairs applied when invoking the workflow. Defaults to null when no overrides were provided. - `string` - `boolean` - `number` - `tracing: Tracing` Tracing settings applied to the workflow. - `enabled: boolean` Indicates whether tracing is enabled. - `version: string | null` Specific workflow version used for the session. Defaults to null when using the latest deployment. ### Chat Session Automatic Thread Titling - `ChatSessionAutomaticThreadTitling` Automatic thread title preferences for the session. - `enabled: boolean` Whether automatic thread titling is enabled. ### Chat Session ChatKit Configuration - `ChatSessionChatKitConfiguration` ChatKit configuration for the session. - `automatic_thread_titling: ChatSessionAutomaticThreadTitling` Automatic thread titling preferences. - `enabled: boolean` Whether automatic thread titling is enabled. - `file_upload: ChatSessionFileUpload` Upload settings for the session. - `enabled: boolean` Indicates if uploads are enabled for the session. - `max_file_size: number | null` Maximum upload size in megabytes. - `max_files: number | null` Maximum number of uploads allowed during the session. - `history: ChatSessionHistory` History retention configuration. - `enabled: boolean` Indicates if chat history is persisted for the session. - `recent_threads: number | null` Number of prior threads surfaced in history views. Defaults to null when all history is retained. ### Chat Session ChatKit Configuration Param - `ChatSessionChatKitConfigurationParam` Optional per-session configuration settings for ChatKit behavior. - `automatic_thread_titling?: AutomaticThreadTitling` Configuration for automatic thread titling. When omitted, automatic thread titling is enabled by default. - `enabled?: boolean` Enable automatic thread title generation. Defaults to true. - `file_upload?: FileUpload` Configuration for upload enablement and limits. When omitted, uploads are disabled by default (max_files 10, max_file_size 512 MB). - `enabled?: boolean` Enable uploads for this session. Defaults to false. - `max_file_size?: number` Maximum size in megabytes for each uploaded file. Defaults to 512 MB, which is the maximum allowable size. - `max_files?: number` Maximum number of files that can be uploaded to the session. Defaults to 10. - `history?: History` Configuration for chat history retention. When omitted, history is enabled by default with no limit on recent_threads (null). - `enabled?: boolean` Enables chat users to access previous ChatKit threads. Defaults to true. - `recent_threads?: number` Number of recent ChatKit threads users have access to. Defaults to unlimited when unset. ### Chat Session Expires After Param - `ChatSessionExpiresAfterParam` Controls when the session expires relative to an anchor timestamp. - `anchor: "created_at"` Base timestamp used to calculate expiration. Currently fixed to `created_at`. - `"created_at"` - `seconds: number` Number of seconds after the anchor when the session expires. ### Chat Session File Upload - `ChatSessionFileUpload` Upload permissions and limits applied to the session. - `enabled: boolean` Indicates if uploads are enabled for the session. - `max_file_size: number | null` Maximum upload size in megabytes. - `max_files: number | null` Maximum number of uploads allowed during the session. ### Chat Session History - `ChatSessionHistory` History retention preferences returned for the session. - `enabled: boolean` Indicates if chat history is persisted for the session. - `recent_threads: number | null` Number of prior threads surfaced in history views. Defaults to null when all history is retained. ### Chat Session Rate Limits - `ChatSessionRateLimits` Active per-minute request limit for the session. - `max_requests_per_1_minute: number` Maximum allowed requests per one-minute window. ### Chat Session Rate Limits Param - `ChatSessionRateLimitsParam` Controls request rate limits for the session. - `max_requests_per_1_minute?: number` Maximum number of requests allowed per minute for the session. Defaults to 10. ### Chat Session Status - `ChatSessionStatus = "active" | "expired" | "cancelled"` - `"active"` - `"expired"` - `"cancelled"` ### Chat Session Workflow Param - `ChatSessionWorkflowParam` Workflow reference and overrides applied to the chat session. - `id: string` Identifier for the workflow invoked by the session. - `state_variables?: Record` 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. - `string` - `boolean` - `number` - `tracing?: Tracing` Optional tracing overrides for the workflow invocation. When omitted, tracing is enabled by default. - `enabled?: boolean` Whether tracing is enabled during the session. Defaults to true. - `version?: string` Specific workflow version to run. Defaults to the latest deployed version. ### ChatKit Attachment - `ChatKitAttachment` Attachment metadata included on thread items. - `id: string` Identifier for the attachment. - `mime_type: string` MIME type of the attachment. - `name: string` Original display name for the attachment. - `preview_url: string | null` Preview URL for rendering the attachment inline. - `type: "image" | "file"` Attachment discriminator. - `"image"` - `"file"` ### ChatKit Response Output Text - `ChatKitResponseOutputText` Assistant response text accompanied by optional annotations. - `annotations: Array` Ordered list of annotations attached to the response text. - `File` Annotation that references an uploaded file. - `source: Source` File attachment referenced by the annotation. - `filename: string` Filename referenced by the annotation. - `type: "file"` Type discriminator that is always `file`. - `"file"` - `type: "file"` Type discriminator that is always `file` for this annotation. - `"file"` - `URL` Annotation that references a URL. - `source: Source` URL referenced by the annotation. - `type: "url"` Type discriminator that is always `url`. - `"url"` - `url: string` URL referenced by the annotation. - `type: "url"` Type discriminator that is always `url` for this annotation. - `"url"` - `text: string` Assistant generated text. - `type: "output_text"` Type discriminator that is always `output_text`. - `"output_text"` ### ChatKit Thread - `ChatKitThread` 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`. - `"chatkit.thread"` - `status: Active | Locked | Closed` Current status for the thread. Defaults to `active` for newly created threads. - `Active` Indicates that a thread is active. - `type: "active"` Status discriminator that is always `active`. - `"active"` - `Locked` Indicates that a thread is locked and cannot accept new input. - `reason: string | null` Reason that the thread was locked. Defaults to null when no reason is recorded. - `type: "locked"` Status discriminator that is always `locked`. - `"locked"` - `Closed` Indicates that a thread has been closed. - `reason: string | null` Reason that the thread was closed. Defaults to null when no reason is recorded. - `type: "closed"` Status discriminator that is always `closed`. - `"closed"` - `title: string | null` 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. ### ChatKit Thread Assistant Message Item - `ChatKitThreadAssistantMessageItem` Assistant-authored message within a thread. - `id: string` Identifier of the thread item. - `content: Array` Ordered assistant response segments. - `annotations: Array` Ordered list of annotations attached to the response text. - `File` Annotation that references an uploaded file. - `source: Source` File attachment referenced by the annotation. - `filename: string` Filename referenced by the annotation. - `type: "file"` Type discriminator that is always `file`. - `"file"` - `type: "file"` Type discriminator that is always `file` for this annotation. - `"file"` - `URL` Annotation that references a URL. - `source: Source` URL referenced by the annotation. - `type: "url"` Type discriminator that is always `url`. - `"url"` - `url: string` URL referenced by the annotation. - `type: "url"` Type discriminator that is always `url` for this annotation. - `"url"` - `text: string` Assistant generated text. - `type: "output_text"` Type discriminator that is always `output_text`. - `"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`. - `"chatkit.thread_item"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.assistant_message"` Type discriminator that is always `chatkit.assistant_message`. - `"chatkit.assistant_message"` ### ChatKit Thread Item List - `ChatKitThreadItemList` A paginated list of thread items rendered for the ChatKit API. - `data: Array` A list of items - `ChatKitThreadUserMessageItem` User-authored messages within a thread. - `id: string` Identifier of the thread item. - `attachments: Array` 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. - `name: string` Original display name for the attachment. - `preview_url: string | null` Preview URL for rendering the attachment inline. - `type: "image" | "file"` Attachment discriminator. - `"image"` - `"file"` - `content: Array` Ordered content elements supplied by the user. - `InputText` 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`. - `"input_text"` - `QuotedText` Quoted snippet that the user referenced in their message. - `text: string` Quoted text content. - `type: "quoted_text"` Type discriminator that is always `quoted_text`. - `"quoted_text"` - `created_at: number` Unix timestamp (in seconds) for when the item was created. - `inference_options: InferenceOptions | null` Inference overrides applied to the message. Defaults to null when unset. - `model: string | null` Model name that generated the response. Defaults to null when using the session default. - `tool_choice: ToolChoice | null` 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`. - `"chatkit.thread_item"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.user_message"` - `"chatkit.user_message"` - `ChatKitThreadAssistantMessageItem` Assistant-authored message within a thread. - `id: string` Identifier of the thread item. - `content: Array` Ordered assistant response segments. - `annotations: Array` Ordered list of annotations attached to the response text. - `File` Annotation that references an uploaded file. - `source: Source` File attachment referenced by the annotation. - `filename: string` Filename referenced by the annotation. - `type: "file"` Type discriminator that is always `file`. - `"file"` - `type: "file"` Type discriminator that is always `file` for this annotation. - `"file"` - `URL` Annotation that references a URL. - `source: Source` URL referenced by the annotation. - `type: "url"` Type discriminator that is always `url`. - `"url"` - `url: string` URL referenced by the annotation. - `type: "url"` Type discriminator that is always `url` for this annotation. - `"url"` - `text: string` Assistant generated text. - `type: "output_text"` Type discriminator that is always `output_text`. - `"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`. - `"chatkit.thread_item"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.assistant_message"` Type discriminator that is always `chatkit.assistant_message`. - `"chatkit.assistant_message"` - `ChatKitWidgetItem` 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`. - `"chatkit.thread_item"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.widget"` Type discriminator that is always `chatkit.widget`. - `"chatkit.widget"` - `widget: string` Serialized widget payload rendered in the UI. - `ChatKitClientToolCall` 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. - `name: string` Tool name that was invoked. - `object: "chatkit.thread_item"` Type discriminator that is always `chatkit.thread_item`. - `"chatkit.thread_item"` - `output: string | null` JSON-encoded output captured from the tool. Defaults to null while execution is in progress. - `status: "in_progress" | "completed"` Execution status for the tool call. - `"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`. - `"chatkit.client_tool_call"` - `ChatKitTask` 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 | null` Optional heading for the task. Defaults to null when not provided. - `object: "chatkit.thread_item"` Type discriminator that is always `chatkit.thread_item`. - `"chatkit.thread_item"` - `summary: string | null` Optional summary that describes the task. Defaults to null when omitted. - `task_type: "custom" | "thought"` Subtype for the task. - `"custom"` - `"thought"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.task"` Type discriminator that is always `chatkit.task`. - `"chatkit.task"` - `ChatKitTaskGroup` 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`. - `"chatkit.thread_item"` - `tasks: Array` Tasks included in the group. - `heading: string | null` Optional heading for the grouped task. Defaults to null when not provided. - `summary: string | null` Optional summary that describes the grouped task. Defaults to null when omitted. - `type: "custom" | "thought"` Subtype for the grouped task. - `"custom"` - `"thought"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.task_group"` Type discriminator that is always `chatkit.task_group`. - `"chatkit.task_group"` - `first_id: string | null` The ID of the first item in the list. - `has_more: boolean` Whether there are more items available. - `last_id: string | null` The ID of the last item in the list. - `object: "list"` The type of object returned, must be `list`. - `"list"` ### ChatKit Thread User Message Item - `ChatKitThreadUserMessageItem` User-authored messages within a thread. - `id: string` Identifier of the thread item. - `attachments: Array` 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. - `name: string` Original display name for the attachment. - `preview_url: string | null` Preview URL for rendering the attachment inline. - `type: "image" | "file"` Attachment discriminator. - `"image"` - `"file"` - `content: Array` Ordered content elements supplied by the user. - `InputText` 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`. - `"input_text"` - `QuotedText` Quoted snippet that the user referenced in their message. - `text: string` Quoted text content. - `type: "quoted_text"` Type discriminator that is always `quoted_text`. - `"quoted_text"` - `created_at: number` Unix timestamp (in seconds) for when the item was created. - `inference_options: InferenceOptions | null` Inference overrides applied to the message. Defaults to null when unset. - `model: string | null` Model name that generated the response. Defaults to null when using the session default. - `tool_choice: ToolChoice | null` 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`. - `"chatkit.thread_item"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.user_message"` - `"chatkit.user_message"` ### ChatKit Widget Item - `ChatKitWidgetItem` 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`. - `"chatkit.thread_item"` - `thread_id: string` Identifier of the parent thread. - `type: "chatkit.widget"` Type discriminator that is always `chatkit.widget`. - `"chatkit.widget"` - `widget: string` Serialized widget payload rendered in the UI. # Assistants ## List assistants `client.beta.assistants.list(AssistantListParamsquery?, RequestOptionsoptions?): CursorPage` **get** `/assistants` Returns a list of assistants. ### Parameters - `query: AssistantListParams` - `after?: string` A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - `before?: string` A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - `limit?: number` A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - `order?: "asc" | "desc"` Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. - `"asc"` - `"desc"` ### Returns - `Assistant` 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 | null` The description of the assistant. The maximum length is 512 characters. - `instructions: string | null` The system instructions that the assistant uses. The maximum length is 256,000 characters. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - `name: string | null` The name of the assistant. The maximum length is 256 characters. - `object: "assistant"` The object type, which is always `assistant`. - `"assistant"` - `tools: Array` 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`. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `response_format?: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `temperature?: number | null` 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. - `tool_resources?: ToolResources | null` 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?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - `top_p?: number | null` 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. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const assistant of client.beta.assistants.list()) { console.log(assistant.id); } ``` #### Response ```json { "data": [ { "id": "id", "created_at": 0, "description": "description", "instructions": "instructions", "metadata": { "foo": "string" }, "model": "model", "name": "name", "object": "assistant", "tools": [ { "type": "code_interpreter" } ], "response_format": "auto", "temperature": 1, "tool_resources": { "code_interpreter": { "file_ids": [ "string" ] }, "file_search": { "vector_store_ids": [ "string" ] } }, "top_p": 1 } ], "first_id": "asst_abc123", "has_more": false, "last_id": "asst_abc456", "object": "list" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const myAssistants = await openai.beta.assistants.list({ order: "desc", limit: "20", }); console.log(myAssistants.data); } main(); ``` #### Response ```json { "object": "list", "data": [ { "id": "asst_abc123", "object": "assistant", "created_at": 1698982736, "name": "Coding Tutor", "description": null, "model": "gpt-4o", "instructions": "You are a helpful assistant designed to make me better at coding!", "tools": [], "tool_resources": {}, "metadata": {}, "top_p": 1.0, "temperature": 1.0, "response_format": "auto" }, { "id": "asst_abc456", "object": "assistant", "created_at": 1698982718, "name": "My Assistant", "description": null, "model": "gpt-4o", "instructions": "You are a helpful assistant designed to make me better at coding!", "tools": [], "tool_resources": {}, "metadata": {}, "top_p": 1.0, "temperature": 1.0, "response_format": "auto" }, { "id": "asst_abc789", "object": "assistant", "created_at": 1698982643, "name": null, "description": null, "model": "gpt-4o", "instructions": null, "tools": [], "tool_resources": {}, "metadata": {}, "top_p": 1.0, "temperature": 1.0, "response_format": "auto" } ], "first_id": "asst_abc123", "last_id": "asst_abc789", "has_more": false } ``` ## Create assistant `client.beta.assistants.create(AssistantCreateParamsbody, RequestOptionsoptions?): Assistant` **post** `/assistants` Create an assistant with a model and instructions. ### Parameters - `body: AssistantCreateParams` - `model: (string & {}) | ChatModel` ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - `(string & {})` - `ChatModel = "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | 75 more` - `"gpt-5.4"` - `"gpt-5.4-mini"` - `"gpt-5.4-nano"` - `"gpt-5.4-mini-2026-03-17"` - `"gpt-5.4-nano-2026-03-17"` - `"gpt-5.3-chat-latest"` - `"gpt-5.2"` - `"gpt-5.2-2025-12-11"` - `"gpt-5.2-chat-latest"` - `"gpt-5.2-pro"` - `"gpt-5.2-pro-2025-12-11"` - `"gpt-5.1"` - `"gpt-5.1-2025-11-13"` - `"gpt-5.1-codex"` - `"gpt-5.1-mini"` - `"gpt-5.1-chat-latest"` - `"gpt-5"` - `"gpt-5-mini"` - `"gpt-5-nano"` - `"gpt-5-2025-08-07"` - `"gpt-5-mini-2025-08-07"` - `"gpt-5-nano-2025-08-07"` - `"gpt-5-chat-latest"` - `"gpt-4.1"` - `"gpt-4.1-mini"` - `"gpt-4.1-nano"` - `"gpt-4.1-2025-04-14"` - `"gpt-4.1-mini-2025-04-14"` - `"gpt-4.1-nano-2025-04-14"` - `"o4-mini"` - `"o4-mini-2025-04-16"` - `"o3"` - `"o3-2025-04-16"` - `"o3-mini"` - `"o3-mini-2025-01-31"` - `"o1"` - `"o1-2024-12-17"` - `"o1-preview"` - `"o1-preview-2024-09-12"` - `"o1-mini"` - `"o1-mini-2024-09-12"` - `"gpt-4o"` - `"gpt-4o-2024-11-20"` - `"gpt-4o-2024-08-06"` - `"gpt-4o-2024-05-13"` - `"gpt-4o-audio-preview"` - `"gpt-4o-audio-preview-2024-10-01"` - `"gpt-4o-audio-preview-2024-12-17"` - `"gpt-4o-audio-preview-2025-06-03"` - `"gpt-4o-mini-audio-preview"` - `"gpt-4o-mini-audio-preview-2024-12-17"` - `"gpt-4o-search-preview"` - `"gpt-4o-mini-search-preview"` - `"gpt-4o-search-preview-2025-03-11"` - `"gpt-4o-mini-search-preview-2025-03-11"` - `"chatgpt-4o-latest"` - `"codex-mini-latest"` - `"gpt-4o-mini"` - `"gpt-4o-mini-2024-07-18"` - `"gpt-4-turbo"` - `"gpt-4-turbo-2024-04-09"` - `"gpt-4-0125-preview"` - `"gpt-4-turbo-preview"` - `"gpt-4-1106-preview"` - `"gpt-4-vision-preview"` - `"gpt-4"` - `"gpt-4-0314"` - `"gpt-4-0613"` - `"gpt-4-32k"` - `"gpt-4-32k-0314"` - `"gpt-4-32k-0613"` - `"gpt-3.5-turbo"` - `"gpt-3.5-turbo-16k"` - `"gpt-3.5-turbo-0301"` - `"gpt-3.5-turbo-0613"` - `"gpt-3.5-turbo-1106"` - `"gpt-3.5-turbo-0125"` - `"gpt-3.5-turbo-16k-0613"` - `description?: string | null` The description of the assistant. The maximum length is 512 characters. - `instructions?: string | null` The system instructions that the assistant uses. The maximum length is 256,000 characters. - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `name?: string | null` The name of the assistant. The maximum length is 256 characters. - `reasoning_effort?: ReasoningEffort | null` Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - `"none"` - `"minimal"` - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `response_format?: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `temperature?: number | null` 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. - `tool_resources?: ToolResources | null` 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?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - `vector_stores?: Array` A helper to create a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant. - `chunking_strategy?: Auto | Static` The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. - `Auto` The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. - `type: "auto"` Always `auto`. - `"auto"` - `Static` - `static: Static` - `chunk_overlap_tokens: number` The number of tokens that overlap between chunks. The default value is `400`. Note that the overlap must not exceed half of `max_chunk_size_tokens`. - `max_chunk_size_tokens: number` The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. - `type: "static"` Always `static`. - `"static"` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files. - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `tools?: Array` 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`. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `top_p?: number | null` 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. ### Returns - `Assistant` 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 | null` The description of the assistant. The maximum length is 512 characters. - `instructions: string | null` The system instructions that the assistant uses. The maximum length is 256,000 characters. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - `name: string | null` The name of the assistant. The maximum length is 256 characters. - `object: "assistant"` The object type, which is always `assistant`. - `"assistant"` - `tools: Array` 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`. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `response_format?: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `temperature?: number | null` 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. - `tool_resources?: ToolResources | null` 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?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - `top_p?: number | null` 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. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const assistant = await client.beta.assistants.create({ model: 'gpt-4o' }); console.log(assistant.id); ``` #### Response ```json { "id": "id", "created_at": 0, "description": "description", "instructions": "instructions", "metadata": { "foo": "string" }, "model": "model", "name": "name", "object": "assistant", "tools": [ { "type": "code_interpreter" } ], "response_format": "auto", "temperature": 1, "tool_resources": { "code_interpreter": { "file_ids": [ "string" ] }, "file_search": { "vector_store_ids": [ "string" ] } }, "top_p": 1 } ``` ### Code Interpreter ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const myAssistant = await openai.beta.assistants.create({ instructions: "You are a personal math tutor. When asked a question, write and run Python code to answer the question.", name: "Math Tutor", tools: [{ type: "code_interpreter" }], model: "gpt-4o", }); console.log(myAssistant); } main(); ``` #### Response ```json { "id": "asst_abc123", "object": "assistant", "created_at": 1698984975, "name": "Math Tutor", "description": null, "model": "gpt-4o", "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.", "tools": [ { "type": "code_interpreter" } ], "metadata": {}, "top_p": 1.0, "temperature": 1.0, "response_format": "auto" } ``` ### Files ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const myAssistant = await openai.beta.assistants.create({ instructions: "You are an HR bot, and you have access to files to answer employee questions about company policies.", name: "HR Helper", tools: [{ type: "file_search" }], tool_resources: { file_search: { vector_store_ids: ["vs_123"] } }, model: "gpt-4o" }); console.log(myAssistant); } main(); ``` #### Response ```json { "id": "asst_abc123", "object": "assistant", "created_at": 1699009403, "name": "HR Helper", "description": null, "model": "gpt-4o", "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.", "tools": [ { "type": "file_search" } ], "tool_resources": { "file_search": { "vector_store_ids": ["vs_123"] } }, "metadata": {}, "top_p": 1.0, "temperature": 1.0, "response_format": "auto" } ``` ## Retrieve assistant `client.beta.assistants.retrieve(stringassistantID, RequestOptionsoptions?): Assistant` **get** `/assistants/{assistant_id}` Retrieves an assistant. ### Parameters - `assistantID: string` ### Returns - `Assistant` 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 | null` The description of the assistant. The maximum length is 512 characters. - `instructions: string | null` The system instructions that the assistant uses. The maximum length is 256,000 characters. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - `name: string | null` The name of the assistant. The maximum length is 256 characters. - `object: "assistant"` The object type, which is always `assistant`. - `"assistant"` - `tools: Array` 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`. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `response_format?: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `temperature?: number | null` 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. - `tool_resources?: ToolResources | null` 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?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - `top_p?: number | null` 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. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const assistant = await client.beta.assistants.retrieve('assistant_id'); console.log(assistant.id); ``` #### Response ```json { "id": "id", "created_at": 0, "description": "description", "instructions": "instructions", "metadata": { "foo": "string" }, "model": "model", "name": "name", "object": "assistant", "tools": [ { "type": "code_interpreter" } ], "response_format": "auto", "temperature": 1, "tool_resources": { "code_interpreter": { "file_ids": [ "string" ] }, "file_search": { "vector_store_ids": [ "string" ] } }, "top_p": 1 } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const myAssistant = await openai.beta.assistants.retrieve( "asst_abc123" ); console.log(myAssistant); } main(); ``` #### Response ```json { "id": "asst_abc123", "object": "assistant", "created_at": 1699009709, "name": "HR Helper", "description": null, "model": "gpt-4o", "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.", "tools": [ { "type": "file_search" } ], "metadata": {}, "top_p": 1.0, "temperature": 1.0, "response_format": "auto" } ``` ## Modify assistant `client.beta.assistants.update(stringassistantID, AssistantUpdateParamsbody, RequestOptionsoptions?): Assistant` **post** `/assistants/{assistant_id}` Modifies an assistant. ### Parameters - `assistantID: string` - `body: AssistantUpdateParams` - `description?: string | null` The description of the assistant. The maximum length is 512 characters. - `instructions?: string | null` The system instructions that the assistant uses. The maximum length is 256,000 characters. - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model?: (string & {}) | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | 39 more` ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - `(string & {})` - `"gpt-5" | "gpt-5-mini" | "gpt-5-nano" | 39 more` - `"gpt-5"` - `"gpt-5-mini"` - `"gpt-5-nano"` - `"gpt-5-2025-08-07"` - `"gpt-5-mini-2025-08-07"` - `"gpt-5-nano-2025-08-07"` - `"gpt-4.1"` - `"gpt-4.1-mini"` - `"gpt-4.1-nano"` - `"gpt-4.1-2025-04-14"` - `"gpt-4.1-mini-2025-04-14"` - `"gpt-4.1-nano-2025-04-14"` - `"o3-mini"` - `"o3-mini-2025-01-31"` - `"o1"` - `"o1-2024-12-17"` - `"gpt-4o"` - `"gpt-4o-2024-11-20"` - `"gpt-4o-2024-08-06"` - `"gpt-4o-2024-05-13"` - `"gpt-4o-mini"` - `"gpt-4o-mini-2024-07-18"` - `"gpt-4.5-preview"` - `"gpt-4.5-preview-2025-02-27"` - `"gpt-4-turbo"` - `"gpt-4-turbo-2024-04-09"` - `"gpt-4-0125-preview"` - `"gpt-4-turbo-preview"` - `"gpt-4-1106-preview"` - `"gpt-4-vision-preview"` - `"gpt-4"` - `"gpt-4-0314"` - `"gpt-4-0613"` - `"gpt-4-32k"` - `"gpt-4-32k-0314"` - `"gpt-4-32k-0613"` - `"gpt-3.5-turbo"` - `"gpt-3.5-turbo-16k"` - `"gpt-3.5-turbo-0613"` - `"gpt-3.5-turbo-1106"` - `"gpt-3.5-turbo-0125"` - `"gpt-3.5-turbo-16k-0613"` - `name?: string | null` The name of the assistant. The maximum length is 256 characters. - `reasoning_effort?: ReasoningEffort | null` Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - `"none"` - `"minimal"` - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `response_format?: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `temperature?: number | null` 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. - `tool_resources?: ToolResources | null` 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?: CodeInterpreter` - `file_ids?: Array` Overrides the list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` Overrides the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - `tools?: Array` 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`. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `top_p?: number | null` 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. ### Returns - `Assistant` 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 | null` The description of the assistant. The maximum length is 512 characters. - `instructions: string | null` The system instructions that the assistant uses. The maximum length is 256,000 characters. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - `name: string | null` The name of the assistant. The maximum length is 256 characters. - `object: "assistant"` The object type, which is always `assistant`. - `"assistant"` - `tools: Array` 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`. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `response_format?: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `temperature?: number | null` 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. - `tool_resources?: ToolResources | null` 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?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - `top_p?: number | null` 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. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const assistant = await client.beta.assistants.update('assistant_id'); console.log(assistant.id); ``` #### Response ```json { "id": "id", "created_at": 0, "description": "description", "instructions": "instructions", "metadata": { "foo": "string" }, "model": "model", "name": "name", "object": "assistant", "tools": [ { "type": "code_interpreter" } ], "response_format": "auto", "temperature": 1, "tool_resources": { "code_interpreter": { "file_ids": [ "string" ] }, "file_search": { "vector_store_ids": [ "string" ] } }, "top_p": 1 } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const myUpdatedAssistant = await openai.beta.assistants.update( "asst_abc123", { instructions: "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", name: "HR Helper", tools: [{ type: "file_search" }], model: "gpt-4o" } ); console.log(myUpdatedAssistant); } main(); ``` #### Response ```json { "id": "asst_123", "object": "assistant", "created_at": 1699009709, "name": "HR Helper", "description": null, "model": "gpt-4o", "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", "tools": [ { "type": "file_search" } ], "tool_resources": { "file_search": { "vector_store_ids": [] } }, "metadata": {}, "top_p": 1.0, "temperature": 1.0, "response_format": "auto" } ``` ## Delete assistant `client.beta.assistants.delete(stringassistantID, RequestOptionsoptions?): AssistantDeleted` **delete** `/assistants/{assistant_id}` Delete an assistant. ### Parameters - `assistantID: string` ### Returns - `AssistantDeleted` - `id: string` - `deleted: boolean` - `object: "assistant.deleted"` - `"assistant.deleted"` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const assistantDeleted = await client.beta.assistants.delete('assistant_id'); console.log(assistantDeleted.id); ``` #### Response ```json { "id": "id", "deleted": true, "object": "assistant.deleted" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const response = await openai.beta.assistants.delete("asst_abc123"); console.log(response); } main(); ``` #### Response ```json { "id": "asst_abc123", "object": "assistant.deleted", "deleted": true } ``` ## Domain Types ### Assistant - `Assistant` 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 | null` The description of the assistant. The maximum length is 512 characters. - `instructions: string | null` The system instructions that the assistant uses. The maximum length is 256,000 characters. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. - `name: string | null` The name of the assistant. The maximum length is 256 characters. - `object: "assistant"` The object type, which is always `assistant`. - `"assistant"` - `tools: Array` 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`. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `response_format?: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `temperature?: number | null` 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. - `tool_resources?: ToolResources | null` 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?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - `top_p?: number | null` 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. ### Assistant Deleted - `AssistantDeleted` - `id: string` - `deleted: boolean` - `object: "assistant.deleted"` - `"assistant.deleted"` ### Assistant Stream Event - `AssistantStreamEvent = ThreadCreated | ThreadRunCreated | ThreadRunQueued | 21 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](https://platform.openai.com/docs/assistants/overview) to learn how to integrate the Assistants API with streaming. - `ThreadCreated` Occurs when a new [thread](https://platform.openai.com/docs/api-reference/threads/object) is created. - `data: Thread` Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/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 | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread"` The object type, which is always `thread`. - `"thread"` - `tool_resources: ToolResources | null` A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - `code_interpreter?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. - `event: "thread.created"` - `"thread.created"` - `enabled?: boolean` Whether to enable input audio transcription. - `ThreadRunCreated` Occurs when a new [run](https://platform.openai.com/docs/api-reference/runs/object) is created. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.created"` - `"thread.run.created"` - `ThreadRunQueued` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `queued` status. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.queued"` - `"thread.run.queued"` - `ThreadRunInProgress` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to an `in_progress` status. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.in_progress"` - `"thread.run.in_progress"` - `ThreadRunRequiresAction` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `requires_action` status. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.requires_action"` - `"thread.run.requires_action"` - `ThreadRunCompleted` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is completed. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.completed"` - `"thread.run.completed"` - `ThreadRunIncomplete` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) ends with status `incomplete`. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.incomplete"` - `"thread.run.incomplete"` - `ThreadRunFailed` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) fails. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.failed"` - `"thread.run.failed"` - `ThreadRunCancelling` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `cancelling` status. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.cancelling"` - `"thread.run.cancelling"` - `ThreadRunCancelled` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is cancelled. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.cancelled"` - `"thread.run.cancelled"` - `ThreadRunExpired` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) expires. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.expired"` - `"thread.run.expired"` - `ThreadRunStepCreated` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.created"` - `"thread.run.step.created"` - `ThreadRunStepInProgress` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.in_progress"` - `"thread.run.step.in_progress"` - `ThreadRunStepDelta` Occurs when parts of a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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: RunStepDelta` The delta containing the fields that have changed on the run step. - `step_details?: RunStepDeltaMessageDelta | ToolCallDeltaObject` The details of the run step. - `RunStepDeltaMessageDelta` Details of the message creation by the run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `message_creation?: MessageCreation` - `message_id?: string` The ID of the message that was created by this run step. - `ToolCallDeltaObject` Details of the tool call. - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `tool_calls?: Array` 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`. - `CodeInterpreterToolCallDelta` 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. - `"code_interpreter"` - `id?: string` The ID of the tool call. - `code_interpreter?: CodeInterpreter` The Code Interpreter tool call definition. - `input?: string` The input to the Code Interpreter tool call. - `outputs?: Array` 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. - `CodeInterpreterLogs` 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"` - `logs?: string` The text output from the Code Interpreter tool call. - `CodeInterpreterOutputImage` - `index: number` The index of the output in the outputs array. - `type: "image"` Always `image`. - `"image"` - `image?: Image` - `file_id?: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `FileSearchToolCallDelta` - `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. - `"file_search"` - `id?: string` The ID of the tool call object. - `FunctionToolCallDelta` - `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. - `"function"` - `id?: string` The ID of the tool call object. - `function?: Function` The definition of the function that was called. - `arguments?: string` The arguments passed to the function. - `name?: string` The name of the function. - `output?: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `object: "thread.run.step.delta"` The object type, which is always `thread.run.step.delta`. - `"thread.run.step.delta"` - `event: "thread.run.step.delta"` - `"thread.run.step.delta"` - `ThreadRunStepCompleted` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.completed"` - `"thread.run.step.completed"` - `ThreadRunStepFailed` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.failed"` - `"thread.run.step.failed"` - `ThreadRunStepCancelled` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.cancelled"` - `"thread.run.step.cancelled"` - `ThreadRunStepExpired` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.expired"` - `"thread.run.step.expired"` - `ThreadMessageCreated` Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is created. - `data: Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - `event: "thread.message.created"` - `"thread.message.created"` - `ThreadMessageInProgress` Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) moves to an `in_progress` state. - `data: Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - `event: "thread.message.in_progress"` - `"thread.message.in_progress"` - `ThreadMessageDelta` Occurs when parts of a [Message](https://platform.openai.com/docs/api-reference/messages/object) 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?: Array` The content of the message in array of text and/or images. - `ImageFileDeltaBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) 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"` - `image_file?: ImageFileDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `file_id?: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `TextDeltaBlock` 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"` - `text?: TextDelta` - `annotations?: Array` - `FileCitationDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `index: number` The index of the annotation in the text content part. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `end_index?: number` - `file_citation?: FileCitation` - `file_id?: string` The ID of the specific File the citation is from. - `quote?: string` The specific quote in the file. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `FilePathDeltaAnnotation` 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`. - `"file_path"` - `end_index?: number` - `file_path?: FilePath` - `file_id?: string` The ID of the file that was generated. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `value?: string` The data that makes up the text. - `RefusalDeltaBlock` 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"` - `refusal?: string` - `ImageURLDeltaBlock` 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"` - `image_url?: ImageURLDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `url?: string` The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `role?: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `object: "thread.message.delta"` The object type, which is always `thread.message.delta`. - `"thread.message.delta"` - `event: "thread.message.delta"` - `"thread.message.delta"` - `ThreadMessageCompleted` Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is completed. - `data: Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - `event: "thread.message.completed"` - `"thread.message.completed"` - `ThreadMessageIncomplete` Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) ends before it is completed. - `data: Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - `event: "thread.message.incomplete"` - `"thread.message.incomplete"` - `ErrorEvent` Occurs when an [error](https://platform.openai.com/docs/guides/error-codes#api-errors) occurs. This can happen due to an internal server error or a timeout. - `data: ErrorObject` - `code: string | null` - `message: string` - `param: string | null` - `type: string` - `event: "error"` - `"error"` ### Assistant Tool - `AssistantTool = CodeInterpreterTool | FileSearchTool | FunctionTool` - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` ### Code Interpreter Tool - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` ### File Search Tool - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` ### Function Tool - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` ### Message Stream Event - `MessageStreamEvent = ThreadMessageCreated | ThreadMessageInProgress | ThreadMessageDelta | 2 more` Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is created. - `ThreadMessageCreated` Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is created. - `data: Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - `event: "thread.message.created"` - `"thread.message.created"` - `ThreadMessageInProgress` Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) moves to an `in_progress` state. - `data: Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - `event: "thread.message.in_progress"` - `"thread.message.in_progress"` - `ThreadMessageDelta` Occurs when parts of a [Message](https://platform.openai.com/docs/api-reference/messages/object) 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?: Array` The content of the message in array of text and/or images. - `ImageFileDeltaBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) 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"` - `image_file?: ImageFileDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `file_id?: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `TextDeltaBlock` 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"` - `text?: TextDelta` - `annotations?: Array` - `FileCitationDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `index: number` The index of the annotation in the text content part. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `end_index?: number` - `file_citation?: FileCitation` - `file_id?: string` The ID of the specific File the citation is from. - `quote?: string` The specific quote in the file. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `FilePathDeltaAnnotation` 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`. - `"file_path"` - `end_index?: number` - `file_path?: FilePath` - `file_id?: string` The ID of the file that was generated. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `value?: string` The data that makes up the text. - `RefusalDeltaBlock` 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"` - `refusal?: string` - `ImageURLDeltaBlock` 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"` - `image_url?: ImageURLDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `url?: string` The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `role?: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `object: "thread.message.delta"` The object type, which is always `thread.message.delta`. - `"thread.message.delta"` - `event: "thread.message.delta"` - `"thread.message.delta"` - `ThreadMessageCompleted` Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is completed. - `data: Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - `event: "thread.message.completed"` - `"thread.message.completed"` - `ThreadMessageIncomplete` Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) ends before it is completed. - `data: Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. - `event: "thread.message.incomplete"` - `"thread.message.incomplete"` ### Run Step Stream Event - `RunStepStreamEvent = ThreadRunStepCreated | ThreadRunStepInProgress | ThreadRunStepDelta | 4 more` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is created. - `ThreadRunStepCreated` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.created"` - `"thread.run.step.created"` - `ThreadRunStepInProgress` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.in_progress"` - `"thread.run.step.in_progress"` - `ThreadRunStepDelta` Occurs when parts of a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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: RunStepDelta` The delta containing the fields that have changed on the run step. - `step_details?: RunStepDeltaMessageDelta | ToolCallDeltaObject` The details of the run step. - `RunStepDeltaMessageDelta` Details of the message creation by the run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `message_creation?: MessageCreation` - `message_id?: string` The ID of the message that was created by this run step. - `ToolCallDeltaObject` Details of the tool call. - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `tool_calls?: Array` 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`. - `CodeInterpreterToolCallDelta` 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. - `"code_interpreter"` - `id?: string` The ID of the tool call. - `code_interpreter?: CodeInterpreter` The Code Interpreter tool call definition. - `input?: string` The input to the Code Interpreter tool call. - `outputs?: Array` 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. - `CodeInterpreterLogs` 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"` - `logs?: string` The text output from the Code Interpreter tool call. - `CodeInterpreterOutputImage` - `index: number` The index of the output in the outputs array. - `type: "image"` Always `image`. - `"image"` - `image?: Image` - `file_id?: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `FileSearchToolCallDelta` - `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. - `"file_search"` - `id?: string` The ID of the tool call object. - `FunctionToolCallDelta` - `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. - `"function"` - `id?: string` The ID of the tool call object. - `function?: Function` The definition of the function that was called. - `arguments?: string` The arguments passed to the function. - `name?: string` The name of the function. - `output?: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `object: "thread.run.step.delta"` The object type, which is always `thread.run.step.delta`. - `"thread.run.step.delta"` - `event: "thread.run.step.delta"` - `"thread.run.step.delta"` - `ThreadRunStepCompleted` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.completed"` - `"thread.run.step.completed"` - `ThreadRunStepFailed` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.failed"` - `"thread.run.step.failed"` - `ThreadRunStepCancelled` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.cancelled"` - `"thread.run.step.cancelled"` - `ThreadRunStepExpired` Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) 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. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). - `event: "thread.run.step.expired"` - `"thread.run.step.expired"` ### Run Stream Event - `RunStreamEvent = ThreadRunCreated | ThreadRunQueued | ThreadRunInProgress | 7 more` Occurs when a new [run](https://platform.openai.com/docs/api-reference/runs/object) is created. - `ThreadRunCreated` Occurs when a new [run](https://platform.openai.com/docs/api-reference/runs/object) is created. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.created"` - `"thread.run.created"` - `ThreadRunQueued` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `queued` status. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.queued"` - `"thread.run.queued"` - `ThreadRunInProgress` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to an `in_progress` status. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.in_progress"` - `"thread.run.in_progress"` - `ThreadRunRequiresAction` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `requires_action` status. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.requires_action"` - `"thread.run.requires_action"` - `ThreadRunCompleted` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is completed. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.completed"` - `"thread.run.completed"` - `ThreadRunIncomplete` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) ends with status `incomplete`. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.incomplete"` - `"thread.run.incomplete"` - `ThreadRunFailed` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) fails. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.failed"` - `"thread.run.failed"` - `ThreadRunCancelling` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `cancelling` status. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.cancelling"` - `"thread.run.cancelling"` - `ThreadRunCancelled` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is cancelled. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.cancelled"` - `"thread.run.cancelled"` - `ThreadRunExpired` Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) expires. - `data: Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. - `event: "thread.run.expired"` - `"thread.run.expired"` ### Thread Stream Event - `ThreadStreamEvent` Occurs when a new [thread](https://platform.openai.com/docs/api-reference/threads/object) is created. - `data: Thread` Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/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 | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread"` The object type, which is always `thread`. - `"thread"` - `tool_resources: ToolResources | null` A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - `code_interpreter?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. - `event: "thread.created"` - `"thread.created"` - `enabled?: boolean` Whether to enable input audio transcription. # Threads ## Create thread `client.beta.threads.create(ThreadCreateParamsbody?, RequestOptionsoptions?): Thread` **post** `/threads` Create a thread. ### Parameters - `body: ThreadCreateParams` - `messages?: Array` A list of [messages](https://platform.openai.com/docs/api-reference/messages) to start the thread with. - `content: string | Array` The text contents of the message. - `string` - `Array` - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlockParam` The text content that is part of a message. - `text: string` Text content to be sent to the model - `type: "text"` Always `text`. - `"text"` - `role: "user" | "assistant"` The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. - `"user"` - `"assistant"` - `attachments?: Array | null` A list of files attached to the message, and the tools they should be added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearch` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `tool_resources?: ToolResources | null` A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - `code_interpreter?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. - `vector_stores?: Array` A helper to create a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. - `chunking_strategy?: Auto | Static` The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. - `Auto` The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. - `type: "auto"` Always `auto`. - `"auto"` - `Static` - `static: Static` - `chunk_overlap_tokens: number` The number of tokens that overlap between chunks. The default value is `400`. Note that the overlap must not exceed half of `max_chunk_size_tokens`. - `max_chunk_size_tokens: number` The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. - `type: "static"` Always `static`. - `"static"` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files. - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. ### Returns - `Thread` Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/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 | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread"` The object type, which is always `thread`. - `"thread"` - `tool_resources: ToolResources | null` A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - `code_interpreter?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const thread = await client.beta.threads.create(); console.log(thread.id); ``` #### Response ```json { "id": "id", "created_at": 0, "metadata": { "foo": "string" }, "object": "thread", "tool_resources": { "code_interpreter": { "file_ids": [ "string" ] }, "file_search": { "vector_store_ids": [ "string" ] } } } ``` ### Empty ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const emptyThread = await openai.beta.threads.create(); console.log(emptyThread); } main(); ``` #### Response ```json { "id": "thread_abc123", "object": "thread", "created_at": 1699012949, "metadata": {}, "tool_resources": {} } ``` ### Messages ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const messageThread = await openai.beta.threads.create({ messages: [ { role: "user", content: "Hello, what is AI?" }, { role: "user", content: "How does AI work? Explain it in simple terms.", }, ], }); console.log(messageThread); } main(); ``` #### Response ```json { "id": "thread_abc123", "object": "thread", "created_at": 1699014083, "metadata": {}, "tool_resources": {} } ``` ## Create thread and run `client.beta.threads.createAndRun(ThreadCreateAndRunParamsbody, RequestOptionsoptions?): Run | Stream` **post** `/threads/runs` Create a thread and run it in one request. ### Parameters - `ThreadCreateAndRunParams = ThreadCreateAndRunParamsNonStreaming | ThreadCreateAndRunParamsStreaming` - `ThreadCreateAndRunParamsBase` - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to execute this run. - `instructions?: string | null` Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. - `max_completion_tokens?: number | null` The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. - `max_prompt_tokens?: number | null` The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model?: (string & {}) | ChatModel | null` The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. - `(string & {})` - `ChatModel = "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | 75 more` - `"gpt-5.4"` - `"gpt-5.4-mini"` - `"gpt-5.4-nano"` - `"gpt-5.4-mini-2026-03-17"` - `"gpt-5.4-nano-2026-03-17"` - `"gpt-5.3-chat-latest"` - `"gpt-5.2"` - `"gpt-5.2-2025-12-11"` - `"gpt-5.2-chat-latest"` - `"gpt-5.2-pro"` - `"gpt-5.2-pro-2025-12-11"` - `"gpt-5.1"` - `"gpt-5.1-2025-11-13"` - `"gpt-5.1-codex"` - `"gpt-5.1-mini"` - `"gpt-5.1-chat-latest"` - `"gpt-5"` - `"gpt-5-mini"` - `"gpt-5-nano"` - `"gpt-5-2025-08-07"` - `"gpt-5-mini-2025-08-07"` - `"gpt-5-nano-2025-08-07"` - `"gpt-5-chat-latest"` - `"gpt-4.1"` - `"gpt-4.1-mini"` - `"gpt-4.1-nano"` - `"gpt-4.1-2025-04-14"` - `"gpt-4.1-mini-2025-04-14"` - `"gpt-4.1-nano-2025-04-14"` - `"o4-mini"` - `"o4-mini-2025-04-16"` - `"o3"` - `"o3-2025-04-16"` - `"o3-mini"` - `"o3-mini-2025-01-31"` - `"o1"` - `"o1-2024-12-17"` - `"o1-preview"` - `"o1-preview-2024-09-12"` - `"o1-mini"` - `"o1-mini-2024-09-12"` - `"gpt-4o"` - `"gpt-4o-2024-11-20"` - `"gpt-4o-2024-08-06"` - `"gpt-4o-2024-05-13"` - `"gpt-4o-audio-preview"` - `"gpt-4o-audio-preview-2024-10-01"` - `"gpt-4o-audio-preview-2024-12-17"` - `"gpt-4o-audio-preview-2025-06-03"` - `"gpt-4o-mini-audio-preview"` - `"gpt-4o-mini-audio-preview-2024-12-17"` - `"gpt-4o-search-preview"` - `"gpt-4o-mini-search-preview"` - `"gpt-4o-search-preview-2025-03-11"` - `"gpt-4o-mini-search-preview-2025-03-11"` - `"chatgpt-4o-latest"` - `"codex-mini-latest"` - `"gpt-4o-mini"` - `"gpt-4o-mini-2024-07-18"` - `"gpt-4-turbo"` - `"gpt-4-turbo-2024-04-09"` - `"gpt-4-0125-preview"` - `"gpt-4-turbo-preview"` - `"gpt-4-1106-preview"` - `"gpt-4-vision-preview"` - `"gpt-4"` - `"gpt-4-0314"` - `"gpt-4-0613"` - `"gpt-4-32k"` - `"gpt-4-32k-0314"` - `"gpt-4-32k-0613"` - `"gpt-3.5-turbo"` - `"gpt-3.5-turbo-16k"` - `"gpt-3.5-turbo-0301"` - `"gpt-3.5-turbo-0613"` - `"gpt-3.5-turbo-1106"` - `"gpt-3.5-turbo-0125"` - `"gpt-3.5-turbo-16k-0613"` - `parallel_tool_calls?: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `response_format?: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `stream?: false | null` If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. - `false` - `temperature?: number | null` 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. - `thread?: Thread` Options to create a new thread. If no thread is provided when running a request, an empty thread will be created. - `messages?: Array` A list of [messages](https://platform.openai.com/docs/api-reference/messages) to start the thread with. - `content: string | Array` The text contents of the message. - `string` - `Array` - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlockParam` The text content that is part of a message. - `text: string` Text content to be sent to the model - `type: "text"` Always `text`. - `"text"` - `role: "user" | "assistant"` The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. - `"user"` - `"assistant"` - `attachments?: Array | null` A list of files attached to the message, and the tools they should be added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearch` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `tool_resources?: ToolResources | null` A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - `code_interpreter?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. - `vector_stores?: Array` A helper to create a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. - `chunking_strategy?: Auto | Static` The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. - `Auto` The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. - `type: "auto"` Always `auto`. - `"auto"` - `Static` - `static: Static` - `chunk_overlap_tokens: number` The number of tokens that overlap between chunks. The default value is `400`. Note that the overlap must not exceed half of `max_chunk_size_tokens`. - `max_chunk_size_tokens: number` The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. - `type: "static"` Always `static`. - `"static"` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files. - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `tool_choice?: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tool_resources?: ToolResources | null` 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?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. - `tools?: Array | null` Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `top_p?: number | null` 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. - `truncation_strategy?: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `ThreadCreateAndRunParamsNonStreaming extends ThreadCreateAndRunParamsBase` - `stream?: false | null` If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. - `false` - `ThreadCreateAndRunParamsStreaming extends ThreadCreateAndRunParamsBase` - `stream: true` If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. - `true` ### Returns - `Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const run = await client.beta.threads.createAndRun({ assistant_id: 'assistant_id' }); console.log(run.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "cancelled_at": 0, "completed_at": 0, "created_at": 0, "expires_at": 0, "failed_at": 0, "incomplete_details": { "reason": "max_completion_tokens" }, "instructions": "instructions", "last_error": { "code": "server_error", "message": "message" }, "max_completion_tokens": 256, "max_prompt_tokens": 256, "metadata": { "foo": "string" }, "model": "model", "object": "thread.run", "parallel_tool_calls": true, "required_action": { "submit_tool_outputs": { "tool_calls": [ { "id": "id", "function": { "arguments": "arguments", "name": "name" }, "type": "function" } ] }, "type": "submit_tool_outputs" }, "response_format": "auto", "started_at": 0, "status": "queued", "thread_id": "thread_id", "tool_choice": "none", "tools": [ { "type": "code_interpreter" } ], "truncation_strategy": { "type": "auto", "last_messages": 1 }, "usage": { "completion_tokens": 0, "prompt_tokens": 0, "total_tokens": 0 }, "temperature": 0, "top_p": 0 } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const run = await openai.beta.threads.createAndRun({ assistant_id: "asst_abc123", thread: { messages: [ { role: "user", content: "Explain deep learning to a 5 year old." }, ], }, }); console.log(run); } main(); ``` #### Response ```json { "id": "run_abc123", "object": "thread.run", "created_at": 1699076792, "assistant_id": "asst_abc123", "thread_id": "thread_abc123", "status": "queued", "started_at": null, "expires_at": 1699077392, "cancelled_at": null, "failed_at": null, "completed_at": null, "required_action": null, "last_error": null, "model": "gpt-4o", "instructions": "You are a helpful assistant.", "tools": [], "tool_resources": {}, "metadata": {}, "temperature": 1.0, "top_p": 1.0, "max_completion_tokens": null, "max_prompt_tokens": null, "truncation_strategy": { "type": "auto", "last_messages": null }, "incomplete_details": null, "usage": null, "response_format": "auto", "tool_choice": "auto", "parallel_tool_calls": true } ``` ### Streaming ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const stream = await openai.beta.threads.createAndRun({ assistant_id: "asst_123", thread: { messages: [ { role: "user", content: "Hello" }, ], }, stream: true }); for await (const event of stream) { console.log(event); } } main(); ``` #### Response ```json event: thread.created data: {"id":"thread_123","object":"thread","created_at":1710348075,"metadata":{}} event: thread.run.created data: {"id":"run_123","object":"thread.run","created_at":1710348075,"assistant_id":"asst_123","thread_id":"thread_123","status":"queued","started_at":null,"expires_at":1710348675,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"tool_resources":{},"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true} event: thread.run.queued data: {"id":"run_123","object":"thread.run","created_at":1710348075,"assistant_id":"asst_123","thread_id":"thread_123","status":"queued","started_at":null,"expires_at":1710348675,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"tool_resources":{},"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true} event: thread.run.in_progress data: {"id":"run_123","object":"thread.run","created_at":1710348075,"assistant_id":"asst_123","thread_id":"thread_123","status":"in_progress","started_at":null,"expires_at":1710348675,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"tool_resources":{},"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true} event: thread.run.step.created data: {"id":"step_001","object":"thread.run.step","created_at":1710348076,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710348675,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_001"}},"usage":null} event: thread.run.step.in_progress data: {"id":"step_001","object":"thread.run.step","created_at":1710348076,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710348675,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_001"}},"usage":null} event: thread.message.created data: {"id":"msg_001","object":"thread.message","created_at":1710348076,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"in_progress","incomplete_details":null,"incomplete_at":null,"completed_at":null,"role":"assistant","content":[], "metadata":{}} event: thread.message.in_progress data: {"id":"msg_001","object":"thread.message","created_at":1710348076,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"in_progress","incomplete_details":null,"incomplete_at":null,"completed_at":null,"role":"assistant","content":[], "metadata":{}} event: thread.message.delta data: {"id":"msg_001","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"Hello","annotations":[]}}]}} ... event: thread.message.delta data: {"id":"msg_001","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":" today"}}]}} event: thread.message.delta data: {"id":"msg_001","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"?"}}]}} event: thread.message.completed data: {"id":"msg_001","object":"thread.message","created_at":1710348076,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"completed","incomplete_details":null,"incomplete_at":null,"completed_at":1710348077,"role":"assistant","content":[{"type":"text","text":{"value":"Hello! How can I assist you today?","annotations":[]}}], "metadata":{}} event: thread.run.step.completed data: {"id":"step_001","object":"thread.run.step","created_at":1710348076,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"completed","cancelled_at":null,"completed_at":1710348077,"expires_at":1710348675,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_001"}},"usage":{"prompt_tokens":20,"completion_tokens":11,"total_tokens":31}} event: thread.run.completed {"id":"run_123","object":"thread.run","created_at":1710348076,"assistant_id":"asst_123","thread_id":"thread_123","status":"completed","started_at":1713226836,"expires_at":null,"cancelled_at":null,"failed_at":null,"completed_at":1713226837,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":{"prompt_tokens":345,"completion_tokens":11,"total_tokens":356},"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true} event: done data: [DONE] ``` ### Streaming with Functions ```typescript import OpenAI from "openai"; const openai = new OpenAI(); const tools = [ { "type": "function", "function": { "name": "get_current_weather", "description": "Get the current weather in a given location", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA", }, "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]}, }, "required": ["location"], }, } } ]; async function main() { const stream = await openai.beta.threads.createAndRun({ assistant_id: "asst_123", thread: { messages: [ { role: "user", content: "What is the weather like in San Francisco?" }, ], }, tools: tools, stream: true }); for await (const event of stream) { console.log(event); } } main(); ``` #### Response ```json event: thread.created data: {"id":"thread_123","object":"thread","created_at":1710351818,"metadata":{}} event: thread.run.created data: {"id":"run_123","object":"thread.run","created_at":1710351818,"assistant_id":"asst_123","thread_id":"thread_123","status":"queued","started_at":null,"expires_at":1710352418,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}}],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.queued data: {"id":"run_123","object":"thread.run","created_at":1710351818,"assistant_id":"asst_123","thread_id":"thread_123","status":"queued","started_at":null,"expires_at":1710352418,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}}],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.in_progress data: {"id":"run_123","object":"thread.run","created_at":1710351818,"assistant_id":"asst_123","thread_id":"thread_123","status":"in_progress","started_at":1710351818,"expires_at":1710352418,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}}],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.step.created data: {"id":"step_001","object":"thread.run.step","created_at":1710351819,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"tool_calls","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710352418,"failed_at":null,"last_error":null,"step_details":{"type":"tool_calls","tool_calls":[]},"usage":null} event: thread.run.step.in_progress data: {"id":"step_001","object":"thread.run.step","created_at":1710351819,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"tool_calls","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710352418,"failed_at":null,"last_error":null,"step_details":{"type":"tool_calls","tool_calls":[]},"usage":null} event: thread.run.step.delta data: {"id":"step_001","object":"thread.run.step.delta","delta":{"step_details":{"type":"tool_calls","tool_calls":[{"index":0,"id":"call_XXNp8YGaFrjrSjgqxtC8JJ1B","type":"function","function":{"name":"get_current_weather","arguments":"","output":null}}]}}} event: thread.run.step.delta data: {"id":"step_001","object":"thread.run.step.delta","delta":{"step_details":{"type":"tool_calls","tool_calls":[{"index":0,"type":"function","function":{"arguments":"{\""}}]}}} event: thread.run.step.delta data: {"id":"step_001","object":"thread.run.step.delta","delta":{"step_details":{"type":"tool_calls","tool_calls":[{"index":0,"type":"function","function":{"arguments":"location"}}]}}} ... event: thread.run.step.delta data: {"id":"step_001","object":"thread.run.step.delta","delta":{"step_details":{"type":"tool_calls","tool_calls":[{"index":0,"type":"function","function":{"arguments":"ahrenheit"}}]}}} event: thread.run.step.delta data: {"id":"step_001","object":"thread.run.step.delta","delta":{"step_details":{"type":"tool_calls","tool_calls":[{"index":0,"type":"function","function":{"arguments":"\"}"}}]}}} event: thread.run.requires_action data: {"id":"run_123","object":"thread.run","created_at":1710351818,"assistant_id":"asst_123","thread_id":"thread_123","status":"requires_action","started_at":1710351818,"expires_at":1710352418,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":{"type":"submit_tool_outputs","submit_tool_outputs":{"tool_calls":[{"id":"call_XXNp8YGaFrjrSjgqxtC8JJ1B","type":"function","function":{"name":"get_current_weather","arguments":"{\"location\":\"San Francisco, CA\",\"unit\":\"fahrenheit\"}"}}]}},"last_error":null,"model":"gpt-4o","instructions":null,"tools":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}}],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":{"prompt_tokens":345,"completion_tokens":11,"total_tokens":356},"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: done data: [DONE] ``` ## Retrieve thread `client.beta.threads.retrieve(stringthreadID, RequestOptionsoptions?): Thread` **get** `/threads/{thread_id}` Retrieves a thread. ### Parameters - `threadID: string` ### Returns - `Thread` Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/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 | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread"` The object type, which is always `thread`. - `"thread"` - `tool_resources: ToolResources | null` A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - `code_interpreter?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const thread = await client.beta.threads.retrieve('thread_id'); console.log(thread.id); ``` #### Response ```json { "id": "id", "created_at": 0, "metadata": { "foo": "string" }, "object": "thread", "tool_resources": { "code_interpreter": { "file_ids": [ "string" ] }, "file_search": { "vector_store_ids": [ "string" ] } } } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const myThread = await openai.beta.threads.retrieve( "thread_abc123" ); console.log(myThread); } main(); ``` #### Response ```json { "id": "thread_abc123", "object": "thread", "created_at": 1699014083, "metadata": {}, "tool_resources": { "code_interpreter": { "file_ids": [] } } } ``` ## Modify thread `client.beta.threads.update(stringthreadID, ThreadUpdateParamsbody, RequestOptionsoptions?): Thread` **post** `/threads/{thread_id}` Modifies a thread. ### Parameters - `threadID: string` - `body: ThreadUpdateParams` - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `tool_resources?: ToolResources | null` A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - `code_interpreter?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. ### Returns - `Thread` Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/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 | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread"` The object type, which is always `thread`. - `"thread"` - `tool_resources: ToolResources | null` A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - `code_interpreter?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const thread = await client.beta.threads.update('thread_id'); console.log(thread.id); ``` #### Response ```json { "id": "id", "created_at": 0, "metadata": { "foo": "string" }, "object": "thread", "tool_resources": { "code_interpreter": { "file_ids": [ "string" ] }, "file_search": { "vector_store_ids": [ "string" ] } } } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const updatedThread = await openai.beta.threads.update( "thread_abc123", { metadata: { modified: "true", user: "abc123" }, } ); console.log(updatedThread); } main(); ``` #### Response ```json { "id": "thread_abc123", "object": "thread", "created_at": 1699014083, "metadata": { "modified": "true", "user": "abc123" }, "tool_resources": {} } ``` ## Delete thread `client.beta.threads.delete(stringthreadID, RequestOptionsoptions?): ThreadDeleted` **delete** `/threads/{thread_id}` Delete a thread. ### Parameters - `threadID: string` ### Returns - `ThreadDeleted` - `id: string` - `deleted: boolean` - `object: "thread.deleted"` - `"thread.deleted"` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const threadDeleted = await client.beta.threads.delete('thread_id'); console.log(threadDeleted.id); ``` #### Response ```json { "id": "id", "deleted": true, "object": "thread.deleted" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const response = await openai.beta.threads.delete("thread_abc123"); console.log(response); } main(); ``` #### Response ```json { "id": "thread_abc123", "object": "thread.deleted", "deleted": true } ``` ## Domain Types ### Assistant Response Format Option - `AssistantResponseFormatOption = "auto" | ResponseFormatText | ResponseFormatJSONObject | ResponseFormatJSONSchema` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` ### Assistant Tool Choice - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. ### Assistant Tool Choice Function - `AssistantToolChoiceFunction` - `name: string` The name of the function to call. ### Assistant Tool Choice Option - `AssistantToolChoiceOption = "none" | "auto" | "required" | AssistantToolChoice` 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. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. ### Thread - `Thread` Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/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 | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread"` The object type, which is always `thread`. - `"thread"` - `tool_resources: ToolResources | null` A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. - `code_interpreter?: CodeInterpreter` - `file_ids?: Array` A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. - `file_search?: FileSearch` - `vector_store_ids?: Array` The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. ### Thread Deleted - `ThreadDeleted` - `id: string` - `deleted: boolean` - `object: "thread.deleted"` - `"thread.deleted"` # Runs ## List runs `client.beta.threads.runs.list(stringthreadID, RunListParamsquery?, RequestOptionsoptions?): CursorPage` **get** `/threads/{thread_id}/runs` Returns a list of runs belonging to a thread. ### Parameters - `threadID: string` - `query: RunListParams` - `after?: string` A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - `before?: string` A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - `limit?: number` A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - `order?: "asc" | "desc"` Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. - `"asc"` - `"desc"` ### Returns - `Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const run of client.beta.threads.runs.list('thread_id')) { console.log(run.id); } ``` #### Response ```json { "data": [ { "id": "id", "assistant_id": "assistant_id", "cancelled_at": 0, "completed_at": 0, "created_at": 0, "expires_at": 0, "failed_at": 0, "incomplete_details": { "reason": "max_completion_tokens" }, "instructions": "instructions", "last_error": { "code": "server_error", "message": "message" }, "max_completion_tokens": 256, "max_prompt_tokens": 256, "metadata": { "foo": "string" }, "model": "model", "object": "thread.run", "parallel_tool_calls": true, "required_action": { "submit_tool_outputs": { "tool_calls": [ { "id": "id", "function": { "arguments": "arguments", "name": "name" }, "type": "function" } ] }, "type": "submit_tool_outputs" }, "response_format": "auto", "started_at": 0, "status": "queued", "thread_id": "thread_id", "tool_choice": "none", "tools": [ { "type": "code_interpreter" } ], "truncation_strategy": { "type": "auto", "last_messages": 1 }, "usage": { "completion_tokens": 0, "prompt_tokens": 0, "total_tokens": 0 }, "temperature": 0, "top_p": 0 } ], "first_id": "run_abc123", "has_more": false, "last_id": "run_abc456", "object": "list" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const runs = await openai.beta.threads.runs.list( "thread_abc123" ); console.log(runs); } main(); ``` #### Response ```json { "object": "list", "data": [ { "id": "run_abc123", "object": "thread.run", "created_at": 1699075072, "assistant_id": "asst_abc123", "thread_id": "thread_abc123", "status": "completed", "started_at": 1699075072, "expires_at": null, "cancelled_at": null, "failed_at": null, "completed_at": 1699075073, "last_error": null, "model": "gpt-4o", "instructions": null, "incomplete_details": null, "tools": [ { "type": "code_interpreter" } ], "tool_resources": { "code_interpreter": { "file_ids": [ "file-abc123", "file-abc456" ] } }, "metadata": {}, "usage": { "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 }, "temperature": 1.0, "top_p": 1.0, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { "type": "auto", "last_messages": null }, "response_format": "auto", "tool_choice": "auto", "parallel_tool_calls": true }, { "id": "run_abc456", "object": "thread.run", "created_at": 1699063290, "assistant_id": "asst_abc123", "thread_id": "thread_abc123", "status": "completed", "started_at": 1699063290, "expires_at": null, "cancelled_at": null, "failed_at": null, "completed_at": 1699063291, "last_error": null, "model": "gpt-4o", "instructions": null, "incomplete_details": null, "tools": [ { "type": "code_interpreter" } ], "tool_resources": { "code_interpreter": { "file_ids": [ "file-abc123", "file-abc456" ] } }, "metadata": {}, "usage": { "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 }, "temperature": 1.0, "top_p": 1.0, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { "type": "auto", "last_messages": null }, "response_format": "auto", "tool_choice": "auto", "parallel_tool_calls": true } ], "first_id": "run_abc123", "last_id": "run_abc456", "has_more": false } ``` ## Create run `client.beta.threads.runs.create(stringthreadID, RunCreateParamsparams, RequestOptionsoptions?): Run | Stream` **post** `/threads/{thread_id}/runs` Create a run. ### Parameters - `threadID: string` - `RunCreateParams = RunCreateParamsNonStreaming | RunCreateParamsStreaming` - `RunCreateParamsBase` - `assistant_id: string` Body param: The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to execute this run. - `include?: Array` Query param: A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `"step_details.tool_calls[*].file_search.results[*].content"` - `additional_instructions?: string | null` Body param: Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions. - `additional_messages?: Array | null` Body param: Adds additional messages to the thread before creating the run. - `content: string | Array` The text contents of the message. - `string` - `Array` - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlockParam` The text content that is part of a message. - `text: string` Text content to be sent to the model - `type: "text"` Always `text`. - `"text"` - `role: "user" | "assistant"` The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. - `"user"` - `"assistant"` - `attachments?: Array | null` A list of files attached to the message, and the tools they should be added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearch` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `instructions?: string | null` Body param: Overrides the [instructions](https://platform.openai.com/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis. - `max_completion_tokens?: number | null` Body param: The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. - `max_prompt_tokens?: number | null` Body param: The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. - `metadata?: Metadata | null` Body param: 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 & {}) | ChatModel | null` Body param: The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. - `(string & {})` - `ChatModel = "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | 75 more` - `"gpt-5.4"` - `"gpt-5.4-mini"` - `"gpt-5.4-nano"` - `"gpt-5.4-mini-2026-03-17"` - `"gpt-5.4-nano-2026-03-17"` - `"gpt-5.3-chat-latest"` - `"gpt-5.2"` - `"gpt-5.2-2025-12-11"` - `"gpt-5.2-chat-latest"` - `"gpt-5.2-pro"` - `"gpt-5.2-pro-2025-12-11"` - `"gpt-5.1"` - `"gpt-5.1-2025-11-13"` - `"gpt-5.1-codex"` - `"gpt-5.1-mini"` - `"gpt-5.1-chat-latest"` - `"gpt-5"` - `"gpt-5-mini"` - `"gpt-5-nano"` - `"gpt-5-2025-08-07"` - `"gpt-5-mini-2025-08-07"` - `"gpt-5-nano-2025-08-07"` - `"gpt-5-chat-latest"` - `"gpt-4.1"` - `"gpt-4.1-mini"` - `"gpt-4.1-nano"` - `"gpt-4.1-2025-04-14"` - `"gpt-4.1-mini-2025-04-14"` - `"gpt-4.1-nano-2025-04-14"` - `"o4-mini"` - `"o4-mini-2025-04-16"` - `"o3"` - `"o3-2025-04-16"` - `"o3-mini"` - `"o3-mini-2025-01-31"` - `"o1"` - `"o1-2024-12-17"` - `"o1-preview"` - `"o1-preview-2024-09-12"` - `"o1-mini"` - `"o1-mini-2024-09-12"` - `"gpt-4o"` - `"gpt-4o-2024-11-20"` - `"gpt-4o-2024-08-06"` - `"gpt-4o-2024-05-13"` - `"gpt-4o-audio-preview"` - `"gpt-4o-audio-preview-2024-10-01"` - `"gpt-4o-audio-preview-2024-12-17"` - `"gpt-4o-audio-preview-2025-06-03"` - `"gpt-4o-mini-audio-preview"` - `"gpt-4o-mini-audio-preview-2024-12-17"` - `"gpt-4o-search-preview"` - `"gpt-4o-mini-search-preview"` - `"gpt-4o-search-preview-2025-03-11"` - `"gpt-4o-mini-search-preview-2025-03-11"` - `"chatgpt-4o-latest"` - `"codex-mini-latest"` - `"gpt-4o-mini"` - `"gpt-4o-mini-2024-07-18"` - `"gpt-4-turbo"` - `"gpt-4-turbo-2024-04-09"` - `"gpt-4-0125-preview"` - `"gpt-4-turbo-preview"` - `"gpt-4-1106-preview"` - `"gpt-4-vision-preview"` - `"gpt-4"` - `"gpt-4-0314"` - `"gpt-4-0613"` - `"gpt-4-32k"` - `"gpt-4-32k-0314"` - `"gpt-4-32k-0613"` - `"gpt-3.5-turbo"` - `"gpt-3.5-turbo-16k"` - `"gpt-3.5-turbo-0301"` - `"gpt-3.5-turbo-0613"` - `"gpt-3.5-turbo-1106"` - `"gpt-3.5-turbo-0125"` - `"gpt-3.5-turbo-16k-0613"` - `parallel_tool_calls?: boolean` Body param: Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `reasoning_effort?: ReasoningEffort | null` Body param: Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - `"none"` - `"minimal"` - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `response_format?: AssistantResponseFormatOption | null` Body param: Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `stream?: false | null` Body param: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. - `false` - `temperature?: number | null` Body param: 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. - `tool_choice?: AssistantToolChoiceOption | null` Body param: 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. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools?: Array | null` Body param: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `top_p?: number | null` Body param: 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. - `truncation_strategy?: TruncationStrategy | null` Body param: Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "last_messages"` The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `RunCreateParamsNonStreaming extends RunCreateParamsBase` - `stream?: false | null` Body param: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. - `false` - `RunCreateParamsStreaming extends RunCreateParamsBase` - `stream: true` Body param: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. - `true` ### Returns - `Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const run = await client.beta.threads.runs.create('thread_id', { assistant_id: 'assistant_id' }); console.log(run.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "cancelled_at": 0, "completed_at": 0, "created_at": 0, "expires_at": 0, "failed_at": 0, "incomplete_details": { "reason": "max_completion_tokens" }, "instructions": "instructions", "last_error": { "code": "server_error", "message": "message" }, "max_completion_tokens": 256, "max_prompt_tokens": 256, "metadata": { "foo": "string" }, "model": "model", "object": "thread.run", "parallel_tool_calls": true, "required_action": { "submit_tool_outputs": { "tool_calls": [ { "id": "id", "function": { "arguments": "arguments", "name": "name" }, "type": "function" } ] }, "type": "submit_tool_outputs" }, "response_format": "auto", "started_at": 0, "status": "queued", "thread_id": "thread_id", "tool_choice": "none", "tools": [ { "type": "code_interpreter" } ], "truncation_strategy": { "type": "auto", "last_messages": 1 }, "usage": { "completion_tokens": 0, "prompt_tokens": 0, "total_tokens": 0 }, "temperature": 0, "top_p": 0 } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const run = await openai.beta.threads.runs.create( "thread_abc123", { assistant_id: "asst_abc123" } ); console.log(run); } main(); ``` #### Response ```json { "id": "run_abc123", "object": "thread.run", "created_at": 1699063290, "assistant_id": "asst_abc123", "thread_id": "thread_abc123", "status": "queued", "started_at": 1699063290, "expires_at": null, "cancelled_at": null, "failed_at": null, "completed_at": 1699063291, "last_error": null, "model": "gpt-4o", "instructions": null, "incomplete_details": null, "tools": [ { "type": "code_interpreter" } ], "metadata": {}, "usage": null, "temperature": 1.0, "top_p": 1.0, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { "type": "auto", "last_messages": null }, "response_format": "auto", "tool_choice": "auto", "parallel_tool_calls": true } ``` ### Streaming ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const stream = await openai.beta.threads.runs.create( "thread_123", { assistant_id: "asst_123", stream: true } ); for await (const event of stream) { console.log(event); } } main(); ``` #### Response ```json event: thread.run.created data: {"id":"run_123","object":"thread.run","created_at":1710330640,"assistant_id":"asst_123","thread_id":"thread_123","status":"queued","started_at":null,"expires_at":1710331240,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.queued data: {"id":"run_123","object":"thread.run","created_at":1710330640,"assistant_id":"asst_123","thread_id":"thread_123","status":"queued","started_at":null,"expires_at":1710331240,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.in_progress data: {"id":"run_123","object":"thread.run","created_at":1710330640,"assistant_id":"asst_123","thread_id":"thread_123","status":"in_progress","started_at":1710330641,"expires_at":1710331240,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.step.created data: {"id":"step_001","object":"thread.run.step","created_at":1710330641,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710331240,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_001"}},"usage":null} event: thread.run.step.in_progress data: {"id":"step_001","object":"thread.run.step","created_at":1710330641,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710331240,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_001"}},"usage":null} event: thread.message.created data: {"id":"msg_001","object":"thread.message","created_at":1710330641,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"in_progress","incomplete_details":null,"incomplete_at":null,"completed_at":null,"role":"assistant","content":[],"metadata":{}} event: thread.message.in_progress data: {"id":"msg_001","object":"thread.message","created_at":1710330641,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"in_progress","incomplete_details":null,"incomplete_at":null,"completed_at":null,"role":"assistant","content":[],"metadata":{}} event: thread.message.delta data: {"id":"msg_001","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"Hello","annotations":[]}}]}} ... event: thread.message.delta data: {"id":"msg_001","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":" today"}}]}} event: thread.message.delta data: {"id":"msg_001","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"?"}}]}} event: thread.message.completed data: {"id":"msg_001","object":"thread.message","created_at":1710330641,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"completed","incomplete_details":null,"incomplete_at":null,"completed_at":1710330642,"role":"assistant","content":[{"type":"text","text":{"value":"Hello! How can I assist you today?","annotations":[]}}],"metadata":{}} event: thread.run.step.completed data: {"id":"step_001","object":"thread.run.step","created_at":1710330641,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"completed","cancelled_at":null,"completed_at":1710330642,"expires_at":1710331240,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_001"}},"usage":{"prompt_tokens":20,"completion_tokens":11,"total_tokens":31}} event: thread.run.completed data: {"id":"run_123","object":"thread.run","created_at":1710330640,"assistant_id":"asst_123","thread_id":"thread_123","status":"completed","started_at":1710330641,"expires_at":null,"cancelled_at":null,"failed_at":null,"completed_at":1710330642,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":{"prompt_tokens":20,"completion_tokens":11,"total_tokens":31},"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: done data: [DONE] ``` ### Streaming with Functions ```typescript import OpenAI from "openai"; const openai = new OpenAI(); const tools = [ { "type": "function", "function": { "name": "get_current_weather", "description": "Get the current weather in a given location", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA", }, "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]}, }, "required": ["location"], }, } } ]; async function main() { const stream = await openai.beta.threads.runs.create( "thread_abc123", { assistant_id: "asst_abc123", tools: tools, stream: true } ); for await (const event of stream) { console.log(event); } } main(); ``` #### Response ```json event: thread.run.created data: {"id":"run_123","object":"thread.run","created_at":1710348075,"assistant_id":"asst_123","thread_id":"thread_123","status":"queued","started_at":null,"expires_at":1710348675,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.queued data: {"id":"run_123","object":"thread.run","created_at":1710348075,"assistant_id":"asst_123","thread_id":"thread_123","status":"queued","started_at":null,"expires_at":1710348675,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.in_progress data: {"id":"run_123","object":"thread.run","created_at":1710348075,"assistant_id":"asst_123","thread_id":"thread_123","status":"in_progress","started_at":1710348075,"expires_at":1710348675,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.step.created data: {"id":"step_001","object":"thread.run.step","created_at":1710348076,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710348675,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_001"}},"usage":null} event: thread.run.step.in_progress data: {"id":"step_001","object":"thread.run.step","created_at":1710348076,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710348675,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_001"}},"usage":null} event: thread.message.created data: {"id":"msg_001","object":"thread.message","created_at":1710348076,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"in_progress","incomplete_details":null,"incomplete_at":null,"completed_at":null,"role":"assistant","content":[],"metadata":{}} event: thread.message.in_progress data: {"id":"msg_001","object":"thread.message","created_at":1710348076,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"in_progress","incomplete_details":null,"incomplete_at":null,"completed_at":null,"role":"assistant","content":[],"metadata":{}} event: thread.message.delta data: {"id":"msg_001","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"Hello","annotations":[]}}]}} ... event: thread.message.delta data: {"id":"msg_001","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":" today"}}]}} event: thread.message.delta data: {"id":"msg_001","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"?"}}]}} event: thread.message.completed data: {"id":"msg_001","object":"thread.message","created_at":1710348076,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"completed","incomplete_details":null,"incomplete_at":null,"completed_at":1710348077,"role":"assistant","content":[{"type":"text","text":{"value":"Hello! How can I assist you today?","annotations":[]}}],"metadata":{}} event: thread.run.step.completed data: {"id":"step_001","object":"thread.run.step","created_at":1710348076,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"completed","cancelled_at":null,"completed_at":1710348077,"expires_at":1710348675,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_001"}},"usage":{"prompt_tokens":20,"completion_tokens":11,"total_tokens":31}} event: thread.run.completed data: {"id":"run_123","object":"thread.run","created_at":1710348075,"assistant_id":"asst_123","thread_id":"thread_123","status":"completed","started_at":1710348075,"expires_at":null,"cancelled_at":null,"failed_at":null,"completed_at":1710348077,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":{"prompt_tokens":20,"completion_tokens":11,"total_tokens":31},"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: done data: [DONE] ``` ## Retrieve run `client.beta.threads.runs.retrieve(stringrunID, RunRetrieveParamsparams, RequestOptionsoptions?): Run` **get** `/threads/{thread_id}/runs/{run_id}` Retrieves a run. ### Parameters - `runID: string` - `params: RunRetrieveParams` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. ### Returns - `Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const run = await client.beta.threads.runs.retrieve('run_id', { thread_id: 'thread_id' }); console.log(run.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "cancelled_at": 0, "completed_at": 0, "created_at": 0, "expires_at": 0, "failed_at": 0, "incomplete_details": { "reason": "max_completion_tokens" }, "instructions": "instructions", "last_error": { "code": "server_error", "message": "message" }, "max_completion_tokens": 256, "max_prompt_tokens": 256, "metadata": { "foo": "string" }, "model": "model", "object": "thread.run", "parallel_tool_calls": true, "required_action": { "submit_tool_outputs": { "tool_calls": [ { "id": "id", "function": { "arguments": "arguments", "name": "name" }, "type": "function" } ] }, "type": "submit_tool_outputs" }, "response_format": "auto", "started_at": 0, "status": "queued", "thread_id": "thread_id", "tool_choice": "none", "tools": [ { "type": "code_interpreter" } ], "truncation_strategy": { "type": "auto", "last_messages": 1 }, "usage": { "completion_tokens": 0, "prompt_tokens": 0, "total_tokens": 0 }, "temperature": 0, "top_p": 0 } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const run = await openai.beta.threads.runs.retrieve( "run_abc123", { thread_id: "thread_abc123" } ); console.log(run); } main(); ``` #### Response ```json { "id": "run_abc123", "object": "thread.run", "created_at": 1699075072, "assistant_id": "asst_abc123", "thread_id": "thread_abc123", "status": "completed", "started_at": 1699075072, "expires_at": null, "cancelled_at": null, "failed_at": null, "completed_at": 1699075073, "last_error": null, "model": "gpt-4o", "instructions": null, "incomplete_details": null, "tools": [ { "type": "code_interpreter" } ], "metadata": {}, "usage": { "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 }, "temperature": 1.0, "top_p": 1.0, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { "type": "auto", "last_messages": null }, "response_format": "auto", "tool_choice": "auto", "parallel_tool_calls": true } ``` ## Modify run `client.beta.threads.runs.update(stringrunID, RunUpdateParamsparams, RequestOptionsoptions?): Run` **post** `/threads/{thread_id}/runs/{run_id}` Modifies a run. ### Parameters - `runID: string` - `params: RunUpdateParams` - `thread_id: string` Path param: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `metadata?: Metadata | null` Body param: 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. ### Returns - `Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const run = await client.beta.threads.runs.update('run_id', { thread_id: 'thread_id' }); console.log(run.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "cancelled_at": 0, "completed_at": 0, "created_at": 0, "expires_at": 0, "failed_at": 0, "incomplete_details": { "reason": "max_completion_tokens" }, "instructions": "instructions", "last_error": { "code": "server_error", "message": "message" }, "max_completion_tokens": 256, "max_prompt_tokens": 256, "metadata": { "foo": "string" }, "model": "model", "object": "thread.run", "parallel_tool_calls": true, "required_action": { "submit_tool_outputs": { "tool_calls": [ { "id": "id", "function": { "arguments": "arguments", "name": "name" }, "type": "function" } ] }, "type": "submit_tool_outputs" }, "response_format": "auto", "started_at": 0, "status": "queued", "thread_id": "thread_id", "tool_choice": "none", "tools": [ { "type": "code_interpreter" } ], "truncation_strategy": { "type": "auto", "last_messages": 1 }, "usage": { "completion_tokens": 0, "prompt_tokens": 0, "total_tokens": 0 }, "temperature": 0, "top_p": 0 } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const run = await openai.beta.threads.runs.update( "run_abc123", { thread_id: "thread_abc123", metadata: { user_id: "user_abc123", }, } ); console.log(run); } main(); ``` #### Response ```json { "id": "run_abc123", "object": "thread.run", "created_at": 1699075072, "assistant_id": "asst_abc123", "thread_id": "thread_abc123", "status": "completed", "started_at": 1699075072, "expires_at": null, "cancelled_at": null, "failed_at": null, "completed_at": 1699075073, "last_error": null, "model": "gpt-4o", "instructions": null, "incomplete_details": null, "tools": [ { "type": "code_interpreter" } ], "tool_resources": { "code_interpreter": { "file_ids": [ "file-abc123", "file-abc456" ] } }, "metadata": { "user_id": "user_abc123" }, "usage": { "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 }, "temperature": 1.0, "top_p": 1.0, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { "type": "auto", "last_messages": null }, "response_format": "auto", "tool_choice": "auto", "parallel_tool_calls": true } ``` ## Submit tool outputs to run `client.beta.threads.runs.submitToolOutputs(stringrunID, RunSubmitToolOutputsParamsparams, RequestOptionsoptions?): Run | Stream` **post** `/threads/{thread_id}/runs/{run_id}/submit_tool_outputs` When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. ### Parameters - `runID: string` - `RunSubmitToolOutputsParams = RunSubmitToolOutputsParamsNonStreaming | RunSubmitToolOutputsParamsStreaming` - `RunSubmitToolOutputsParamsBase` - `thread_id: string` Path param: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) to which this run belongs. - `tool_outputs: Array` Body param: A list of tools for which the outputs are being submitted. - `output?: string` The output of the tool call to be submitted to continue the run. - `tool_call_id?: string` The ID of the tool call in the `required_action` object within the run object the output is being submitted for. - `stream?: false | null` Body param: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. - `false` - `RunSubmitToolOutputsParamsNonStreaming extends RunSubmitToolOutputsParamsBase` - `stream?: false | null` Body param: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. - `false` - `RunSubmitToolOutputsParamsStreaming extends RunSubmitToolOutputsParamsBase` - `stream: true` Body param: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. - `true` ### Returns - `Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const run = await client.beta.threads.runs.submitToolOutputs('run_id', { thread_id: 'thread_id', tool_outputs: [{}], }); console.log(run.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "cancelled_at": 0, "completed_at": 0, "created_at": 0, "expires_at": 0, "failed_at": 0, "incomplete_details": { "reason": "max_completion_tokens" }, "instructions": "instructions", "last_error": { "code": "server_error", "message": "message" }, "max_completion_tokens": 256, "max_prompt_tokens": 256, "metadata": { "foo": "string" }, "model": "model", "object": "thread.run", "parallel_tool_calls": true, "required_action": { "submit_tool_outputs": { "tool_calls": [ { "id": "id", "function": { "arguments": "arguments", "name": "name" }, "type": "function" } ] }, "type": "submit_tool_outputs" }, "response_format": "auto", "started_at": 0, "status": "queued", "thread_id": "thread_id", "tool_choice": "none", "tools": [ { "type": "code_interpreter" } ], "truncation_strategy": { "type": "auto", "last_messages": 1 }, "usage": { "completion_tokens": 0, "prompt_tokens": 0, "total_tokens": 0 }, "temperature": 0, "top_p": 0 } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const run = await openai.beta.threads.runs.submitToolOutputs( "run_123", { thread_id: "thread_123", tool_outputs: [ { tool_call_id: "call_001", output: "70 degrees and sunny.", }, ], } ); console.log(run); } main(); ``` #### Response ```json { "id": "run_123", "object": "thread.run", "created_at": 1699075592, "assistant_id": "asst_123", "thread_id": "thread_123", "status": "queued", "started_at": 1699075592, "expires_at": 1699076192, "cancelled_at": null, "failed_at": null, "completed_at": null, "last_error": null, "model": "gpt-4o", "instructions": null, "tools": [ { "type": "function", "function": { "name": "get_current_weather", "description": "Get the current weather in a given location", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "unit": { "type": "string", "enum": ["celsius", "fahrenheit"] } }, "required": ["location"] } } } ], "metadata": {}, "usage": null, "temperature": 1.0, "top_p": 1.0, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { "type": "auto", "last_messages": null }, "response_format": "auto", "tool_choice": "auto", "parallel_tool_calls": true } ``` ### Streaming ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const stream = await openai.beta.threads.runs.submitToolOutputs( "run_123", { thread_id: "thread_123", tool_outputs: [ { tool_call_id: "call_001", output: "70 degrees and sunny.", }, ], } ); for await (const event of stream) { console.log(event); } } main(); ``` #### Response ```json event: thread.run.step.completed data: {"id":"step_001","object":"thread.run.step","created_at":1710352449,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"tool_calls","status":"completed","cancelled_at":null,"completed_at":1710352475,"expires_at":1710353047,"failed_at":null,"last_error":null,"step_details":{"type":"tool_calls","tool_calls":[{"id":"call_iWr0kQ2EaYMaxNdl0v3KYkx7","type":"function","function":{"name":"get_current_weather","arguments":"{\"location\":\"San Francisco, CA\",\"unit\":\"fahrenheit\"}","output":"70 degrees and sunny."}}]},"usage":{"prompt_tokens":291,"completion_tokens":24,"total_tokens":315}} event: thread.run.queued data: {"id":"run_123","object":"thread.run","created_at":1710352447,"assistant_id":"asst_123","thread_id":"thread_123","status":"queued","started_at":1710352448,"expires_at":1710353047,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}}],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.in_progress data: {"id":"run_123","object":"thread.run","created_at":1710352447,"assistant_id":"asst_123","thread_id":"thread_123","status":"in_progress","started_at":1710352475,"expires_at":1710353047,"cancelled_at":null,"failed_at":null,"completed_at":null,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}}],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":null,"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: thread.run.step.created data: {"id":"step_002","object":"thread.run.step","created_at":1710352476,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710353047,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_002"}},"usage":null} event: thread.run.step.in_progress data: {"id":"step_002","object":"thread.run.step","created_at":1710352476,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"in_progress","cancelled_at":null,"completed_at":null,"expires_at":1710353047,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_002"}},"usage":null} event: thread.message.created data: {"id":"msg_002","object":"thread.message","created_at":1710352476,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"in_progress","incomplete_details":null,"incomplete_at":null,"completed_at":null,"role":"assistant","content":[],"metadata":{}} event: thread.message.in_progress data: {"id":"msg_002","object":"thread.message","created_at":1710352476,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"in_progress","incomplete_details":null,"incomplete_at":null,"completed_at":null,"role":"assistant","content":[],"metadata":{}} event: thread.message.delta data: {"id":"msg_002","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"The","annotations":[]}}]}} event: thread.message.delta data: {"id":"msg_002","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":" current"}}]}} event: thread.message.delta data: {"id":"msg_002","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":" weather"}}]}} ... event: thread.message.delta data: {"id":"msg_002","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":" sunny"}}]}} event: thread.message.delta data: {"id":"msg_002","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"."}}]}} event: thread.message.completed data: {"id":"msg_002","object":"thread.message","created_at":1710352476,"assistant_id":"asst_123","thread_id":"thread_123","run_id":"run_123","status":"completed","incomplete_details":null,"incomplete_at":null,"completed_at":1710352477,"role":"assistant","content":[{"type":"text","text":{"value":"The current weather in San Francisco, CA is 70 degrees Fahrenheit and sunny.","annotations":[]}}],"metadata":{}} event: thread.run.step.completed data: {"id":"step_002","object":"thread.run.step","created_at":1710352476,"run_id":"run_123","assistant_id":"asst_123","thread_id":"thread_123","type":"message_creation","status":"completed","cancelled_at":null,"completed_at":1710352477,"expires_at":1710353047,"failed_at":null,"last_error":null,"step_details":{"type":"message_creation","message_creation":{"message_id":"msg_002"}},"usage":{"prompt_tokens":329,"completion_tokens":18,"total_tokens":347}} event: thread.run.completed data: {"id":"run_123","object":"thread.run","created_at":1710352447,"assistant_id":"asst_123","thread_id":"thread_123","status":"completed","started_at":1710352475,"expires_at":null,"cancelled_at":null,"failed_at":null,"completed_at":1710352477,"required_action":null,"last_error":null,"model":"gpt-4o","instructions":null,"tools":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}}],"metadata":{},"temperature":1.0,"top_p":1.0,"max_completion_tokens":null,"max_prompt_tokens":null,"truncation_strategy":{"type":"auto","last_messages":null},"incomplete_details":null,"usage":{"prompt_tokens":20,"completion_tokens":11,"total_tokens":31},"response_format":"auto","tool_choice":"auto","parallel_tool_calls":true}} event: done data: [DONE] ``` ## Cancel a run `client.beta.threads.runs.cancel(stringrunID, RunCancelParamsparams, RequestOptionsoptions?): Run` **post** `/threads/{thread_id}/runs/{run_id}/cancel` Cancels a run that is `in_progress`. ### Parameters - `runID: string` - `params: RunCancelParams` - `thread_id: string` The ID of the thread to which this run belongs. ### Returns - `Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const run = await client.beta.threads.runs.cancel('run_id', { thread_id: 'thread_id' }); console.log(run.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "cancelled_at": 0, "completed_at": 0, "created_at": 0, "expires_at": 0, "failed_at": 0, "incomplete_details": { "reason": "max_completion_tokens" }, "instructions": "instructions", "last_error": { "code": "server_error", "message": "message" }, "max_completion_tokens": 256, "max_prompt_tokens": 256, "metadata": { "foo": "string" }, "model": "model", "object": "thread.run", "parallel_tool_calls": true, "required_action": { "submit_tool_outputs": { "tool_calls": [ { "id": "id", "function": { "arguments": "arguments", "name": "name" }, "type": "function" } ] }, "type": "submit_tool_outputs" }, "response_format": "auto", "started_at": 0, "status": "queued", "thread_id": "thread_id", "tool_choice": "none", "tools": [ { "type": "code_interpreter" } ], "truncation_strategy": { "type": "auto", "last_messages": 1 }, "usage": { "completion_tokens": 0, "prompt_tokens": 0, "total_tokens": 0 }, "temperature": 0, "top_p": 0 } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const run = await openai.beta.threads.runs.cancel( "run_abc123", { thread_id: "thread_abc123" } ); console.log(run); } main(); ``` #### Response ```json { "id": "run_abc123", "object": "thread.run", "created_at": 1699076126, "assistant_id": "asst_abc123", "thread_id": "thread_abc123", "status": "cancelling", "started_at": 1699076126, "expires_at": 1699076726, "cancelled_at": null, "failed_at": null, "completed_at": null, "last_error": null, "model": "gpt-4o", "instructions": "You summarize books.", "tools": [ { "type": "file_search" } ], "tool_resources": { "file_search": { "vector_store_ids": ["vs_123"] } }, "metadata": {}, "usage": null, "temperature": 1.0, "top_p": 1.0, "response_format": "auto", "tool_choice": "auto", "parallel_tool_calls": true } ``` ## Domain Types ### Required Action Function Tool Call - `RequiredActionFunctionToolCall` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` ### Run - `Run` Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string` The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run was cancelled. - `completed_at: number | null` 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 | null` The Unix timestamp (in seconds) for when the run will expire. - `failed_at: number | null` The Unix timestamp (in seconds) for when the run failed. - `incomplete_details: IncompleteDetails | null` Details on why the run is incomplete. Will be `null` if the run is not incomplete. - `reason?: "max_completion_tokens" | "max_prompt_tokens"` The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. - `"max_completion_tokens"` - `"max_prompt_tokens"` - `instructions: string` The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `last_error: LastError | null` The last error associated with this run. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt"` One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. - `"server_error"` - `"rate_limit_exceeded"` - `"invalid_prompt"` - `message: string` A human-readable description of the error. - `max_completion_tokens: number | null` The maximum number of completion tokens specified to have been used over the course of the run. - `max_prompt_tokens: number | null` The maximum number of prompt tokens specified to have been used over the course of the run. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `model: string` The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `object: "thread.run"` The object type, which is always `thread.run`. - `"thread.run"` - `parallel_tool_calls: boolean` Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. - `required_action: RequiredAction | null` Details on the action required to continue the run. Will be `null` if no action is required. - `submit_tool_outputs: SubmitToolOutputs` Details on the tool outputs needed for this run to continue. - `tool_calls: Array` 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](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. - `function: Function` 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`. - `"function"` - `type: "submit_tool_outputs"` For now, this is always `submit_tool_outputs`. - `"submit_tool_outputs"` - `response_format: AssistantResponseFormatOption | null` Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), 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](https://platform.openai.com/docs/guides/structured-outputs). 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. - `"auto"` - `"auto"` - `ResponseFormatText` Default response format. Used to generate text responses. - `type: "text"` The type of response format being defined. Always `text`. - `"text"` - `ResponseFormatJSONObject` 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`. - `"json_object"` - `ResponseFormatJSONSchema` JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). - `json_schema: JSONSchema` Structured Outputs configuration options, including a JSON Schema. - `name: string` The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the response format is for, used by the model to determine how to respond in the format. - `schema?: Record` The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). - `strict?: boolean | null` 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](https://platform.openai.com/docs/guides/structured-outputs). - `type: "json_schema"` The type of response format being defined. Always `json_schema`. - `"json_schema"` - `started_at: number | null` The Unix timestamp (in seconds) for when the run was started. - `status: RunStatus` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. - `tool_choice: AssistantToolChoiceOption | null` Controls which (if any) tool is called by the model. `none` means the model will not call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. - `"none" | "auto" | "required"` - `"none"` - `"auto"` - `"required"` - `AssistantToolChoice` Specifies a tool the model should use. Use to force the model to call a specific tool. - `type: "function" | "code_interpreter" | "file_search"` The type of the tool. If type is `function`, the function name must be set - `"function"` - `"code_interpreter"` - `"file_search"` - `function?: AssistantToolChoiceFunction` - `name: string` The name of the function to call. - `tools: Array` The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearchTool` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `file_search?: FileSearch` Overrides for the file search tool. - `max_num_results?: 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `ranking_options?: RankingOptions` 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](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) 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. - `ranker?: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"auto"` - `"default_2024_08_21"` - `FunctionTool` - `function: FunctionDefinition` - `name: string` The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. - `description?: string` A description of what the function does, used by the model to choose when and how to call the function. - `parameters?: FunctionParameters` The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. - `strict?: boolean | null` Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). - `type: "function"` The type of tool being defined: `function` - `"function"` - `truncation_strategy: TruncationStrategy | null` Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. - `type: "auto" | "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`. - `"auto"` - `"last_messages"` - `last_messages?: number | null` The number of most recent messages from the thread when constructing the context for the run. - `usage: Usage | null` Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). - `completion_tokens: 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?: number | null` The sampling temperature used for this run. If not set, defaults to 1. - `top_p?: number | null` The nucleus sampling value used for this run. If not set, defaults to 1. ### Run Status - `RunStatus = "queued" | "in_progress" | "requires_action" | 6 more` The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. - `"queued"` - `"in_progress"` - `"requires_action"` - `"cancelling"` - `"cancelled"` - `"failed"` - `"completed"` - `"incomplete"` - `"expired"` # Steps ## List run steps `client.beta.threads.runs.steps.list(stringrunID, StepListParamsparams, RequestOptionsoptions?): CursorPage` **get** `/threads/{thread_id}/runs/{run_id}/steps` Returns a list of run steps belonging to a run. ### Parameters - `runID: string` - `params: StepListParams` - `thread_id: string` Path param: The ID of the thread the run and run steps belong to. - `after?: string` Query param: A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - `before?: string` Query param: A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - `include?: Array` Query param: A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `"step_details.tool_calls[*].file_search.results[*].content"` - `limit?: number` Query param: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - `order?: "asc" | "desc"` Query param: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. - `"asc"` - `"desc"` ### Returns - `RunStep` 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](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const runStep of client.beta.threads.runs.steps.list('run_id', { thread_id: 'thread_id', })) { console.log(runStep.id); } ``` #### Response ```json { "data": [ { "id": "id", "assistant_id": "assistant_id", "cancelled_at": 0, "completed_at": 0, "created_at": 0, "expired_at": 0, "failed_at": 0, "last_error": { "code": "server_error", "message": "message" }, "metadata": { "foo": "string" }, "object": "thread.run.step", "run_id": "run_id", "status": "in_progress", "step_details": { "message_creation": { "message_id": "message_id" }, "type": "message_creation" }, "thread_id": "thread_id", "type": "message_creation", "usage": { "completion_tokens": 0, "prompt_tokens": 0, "total_tokens": 0 } } ], "first_id": "step_abc123", "has_more": false, "last_id": "step_abc456", "object": "list" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const runStep = await openai.beta.threads.runs.steps.list( "run_abc123", { thread_id: "thread_abc123" } ); console.log(runStep); } main(); ``` #### Response ```json { "object": "list", "data": [ { "id": "step_abc123", "object": "thread.run.step", "created_at": 1699063291, "run_id": "run_abc123", "assistant_id": "asst_abc123", "thread_id": "thread_abc123", "type": "message_creation", "status": "completed", "cancelled_at": null, "completed_at": 1699063291, "expired_at": null, "failed_at": null, "last_error": null, "step_details": { "type": "message_creation", "message_creation": { "message_id": "msg_abc123" } }, "usage": { "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 } } ], "first_id": "step_abc123", "last_id": "step_abc456", "has_more": false } ``` ## Retrieve run step `client.beta.threads.runs.steps.retrieve(stringstepID, StepRetrieveParamsparams, RequestOptionsoptions?): RunStep` **get** `/threads/{thread_id}/runs/{run_id}/steps/{step_id}` Retrieves a run step. ### Parameters - `stepID: string` - `params: StepRetrieveParams` - `thread_id: string` Path param: The ID of the thread to which the run and run step belongs. - `run_id: string` Path param: The ID of the run to which the run step belongs. - `include?: Array` Query param: A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. - `"step_details.tool_calls[*].file_search.results[*].content"` ### Returns - `RunStep` 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](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const runStep = await client.beta.threads.runs.steps.retrieve('step_id', { thread_id: 'thread_id', run_id: 'run_id', }); console.log(runStep.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "cancelled_at": 0, "completed_at": 0, "created_at": 0, "expired_at": 0, "failed_at": 0, "last_error": { "code": "server_error", "message": "message" }, "metadata": { "foo": "string" }, "object": "thread.run.step", "run_id": "run_id", "status": "in_progress", "step_details": { "message_creation": { "message_id": "message_id" }, "type": "message_creation" }, "thread_id": "thread_id", "type": "message_creation", "usage": { "completion_tokens": 0, "prompt_tokens": 0, "total_tokens": 0 } } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const runStep = await openai.beta.threads.runs.steps.retrieve( "step_abc123", { thread_id: "thread_abc123", run_id: "run_abc123" } ); console.log(runStep); } main(); ``` #### Response ```json { "id": "step_abc123", "object": "thread.run.step", "created_at": 1699063291, "run_id": "run_abc123", "assistant_id": "asst_abc123", "thread_id": "thread_abc123", "type": "message_creation", "status": "completed", "cancelled_at": null, "completed_at": 1699063291, "expired_at": null, "failed_at": null, "last_error": null, "step_details": { "type": "message_creation", "message_creation": { "message_id": "msg_abc123" } }, "usage": { "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 } } ``` ## Domain Types ### Code Interpreter Logs - `CodeInterpreterLogs` 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"` - `logs?: string` The text output from the Code Interpreter tool call. ### Code Interpreter Output Image - `CodeInterpreterOutputImage` - `index: number` The index of the output in the outputs array. - `type: "image"` Always `image`. - `"image"` - `image?: Image` - `file_id?: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. ### Code Interpreter Tool Call - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` ### Code Interpreter Tool Call Delta - `CodeInterpreterToolCallDelta` 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. - `"code_interpreter"` - `id?: string` The ID of the tool call. - `code_interpreter?: CodeInterpreter` The Code Interpreter tool call definition. - `input?: string` The input to the Code Interpreter tool call. - `outputs?: Array` 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. - `CodeInterpreterLogs` 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"` - `logs?: string` The text output from the Code Interpreter tool call. - `CodeInterpreterOutputImage` - `index: number` The index of the output in the outputs array. - `type: "image"` Always `image`. - `"image"` - `image?: Image` - `file_id?: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. ### File Search Tool Call - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` ### File Search Tool Call Delta - `FileSearchToolCallDelta` - `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. - `"file_search"` - `id?: string` The ID of the tool call object. ### Function Tool Call - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` ### Function Tool Call Delta - `FunctionToolCallDelta` - `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. - `"function"` - `id?: string` The ID of the tool call object. - `function?: Function` The definition of the function that was called. - `arguments?: string` The arguments passed to the function. - `name?: string` The name of the function. - `output?: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. ### Message Creation Step Details - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` ### Run Step - `RunStep` 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](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. - `cancelled_at: number | null` The Unix timestamp (in seconds) for when the run step was cancelled. - `completed_at: number | null` 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 | null` 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 | null` The Unix timestamp (in seconds) for when the run step failed. - `last_error: LastError | null` The last error associated with this run step. Will be `null` if there are no errors. - `code: "server_error" | "rate_limit_exceeded"` One of `server_error` or `rate_limit_exceeded`. - `"server_error"` - `"rate_limit_exceeded"` - `message: string` A human-readable description of the error. - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.run.step"` The object type, which is always `thread.run.step`. - `"thread.run.step"` - `run_id: string` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. - `status: "in_progress" | "cancelled" | "failed" | 2 more` The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. - `"in_progress"` - `"cancelled"` - `"failed"` - `"completed"` - `"expired"` - `step_details: MessageCreationStepDetails | ToolCallsStepDetails` The details of the run step. - `MessageCreationStepDetails` Details of the message creation by the run step. - `message_creation: MessageCreation` - `message_id: string` The ID of the message that was created by this run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. - `type: "message_creation" | "tool_calls"` The type of run step, which can be either `message_creation` or `tool_calls`. - `"message_creation"` - `"tool_calls"` - `usage: Usage | null` 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). ### Run Step Delta - `RunStepDelta` The delta containing the fields that have changed on the run step. - `step_details?: RunStepDeltaMessageDelta | ToolCallDeltaObject` The details of the run step. - `RunStepDeltaMessageDelta` Details of the message creation by the run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `message_creation?: MessageCreation` - `message_id?: string` The ID of the message that was created by this run step. - `ToolCallDeltaObject` Details of the tool call. - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `tool_calls?: Array` 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`. - `CodeInterpreterToolCallDelta` 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. - `"code_interpreter"` - `id?: string` The ID of the tool call. - `code_interpreter?: CodeInterpreter` The Code Interpreter tool call definition. - `input?: string` The input to the Code Interpreter tool call. - `outputs?: Array` 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. - `CodeInterpreterLogs` 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"` - `logs?: string` The text output from the Code Interpreter tool call. - `CodeInterpreterOutputImage` - `index: number` The index of the output in the outputs array. - `type: "image"` Always `image`. - `"image"` - `image?: Image` - `file_id?: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `FileSearchToolCallDelta` - `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. - `"file_search"` - `id?: string` The ID of the tool call object. - `FunctionToolCallDelta` - `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. - `"function"` - `id?: string` The ID of the tool call object. - `function?: Function` The definition of the function that was called. - `arguments?: string` The arguments passed to the function. - `name?: string` The name of the function. - `output?: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. ### Run Step Delta Event - `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: RunStepDelta` The delta containing the fields that have changed on the run step. - `step_details?: RunStepDeltaMessageDelta | ToolCallDeltaObject` The details of the run step. - `RunStepDeltaMessageDelta` Details of the message creation by the run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `message_creation?: MessageCreation` - `message_id?: string` The ID of the message that was created by this run step. - `ToolCallDeltaObject` Details of the tool call. - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `tool_calls?: Array` 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`. - `CodeInterpreterToolCallDelta` 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. - `"code_interpreter"` - `id?: string` The ID of the tool call. - `code_interpreter?: CodeInterpreter` The Code Interpreter tool call definition. - `input?: string` The input to the Code Interpreter tool call. - `outputs?: Array` 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. - `CodeInterpreterLogs` 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"` - `logs?: string` The text output from the Code Interpreter tool call. - `CodeInterpreterOutputImage` - `index: number` The index of the output in the outputs array. - `type: "image"` Always `image`. - `"image"` - `image?: Image` - `file_id?: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `FileSearchToolCallDelta` - `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. - `"file_search"` - `id?: string` The ID of the tool call object. - `FunctionToolCallDelta` - `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. - `"function"` - `id?: string` The ID of the tool call object. - `function?: Function` The definition of the function that was called. - `arguments?: string` The arguments passed to the function. - `name?: string` The name of the function. - `output?: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `object: "thread.run.step.delta"` The object type, which is always `thread.run.step.delta`. - `"thread.run.step.delta"` ### Run Step Delta Message Delta - `RunStepDeltaMessageDelta` Details of the message creation by the run step. - `type: "message_creation"` Always `message_creation`. - `"message_creation"` - `message_creation?: MessageCreation` - `message_id?: string` The ID of the message that was created by this run step. ### Run Step Include - `RunStepInclude = "step_details.tool_calls[*].file_search.results[*].content"` - `"step_details.tool_calls[*].file_search.results[*].content"` ### Tool Call - `ToolCall = CodeInterpreterToolCall | FileSearchToolCall | FunctionToolCall` Details of the Code Interpreter tool call the run step was involved in. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` ### Tool Call Delta - `ToolCallDelta = CodeInterpreterToolCallDelta | FileSearchToolCallDelta | FunctionToolCallDelta` Details of the Code Interpreter tool call the run step was involved in. - `CodeInterpreterToolCallDelta` 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. - `"code_interpreter"` - `id?: string` The ID of the tool call. - `code_interpreter?: CodeInterpreter` The Code Interpreter tool call definition. - `input?: string` The input to the Code Interpreter tool call. - `outputs?: Array` 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. - `CodeInterpreterLogs` 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"` - `logs?: string` The text output from the Code Interpreter tool call. - `CodeInterpreterOutputImage` - `index: number` The index of the output in the outputs array. - `type: "image"` Always `image`. - `"image"` - `image?: Image` - `file_id?: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `FileSearchToolCallDelta` - `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. - `"file_search"` - `id?: string` The ID of the tool call object. - `FunctionToolCallDelta` - `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. - `"function"` - `id?: string` The ID of the tool call object. - `function?: Function` The definition of the function that was called. - `arguments?: string` The arguments passed to the function. - `name?: string` The name of the function. - `output?: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. ### Tool Call Delta Object - `ToolCallDeltaObject` Details of the tool call. - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` - `tool_calls?: Array` 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`. - `CodeInterpreterToolCallDelta` 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. - `"code_interpreter"` - `id?: string` The ID of the tool call. - `code_interpreter?: CodeInterpreter` The Code Interpreter tool call definition. - `input?: string` The input to the Code Interpreter tool call. - `outputs?: Array` 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. - `CodeInterpreterLogs` 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"` - `logs?: string` The text output from the Code Interpreter tool call. - `CodeInterpreterOutputImage` - `index: number` The index of the output in the outputs array. - `type: "image"` Always `image`. - `"image"` - `image?: Image` - `file_id?: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `FileSearchToolCallDelta` - `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. - `"file_search"` - `id?: string` The ID of the tool call object. - `FunctionToolCallDelta` - `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. - `"function"` - `id?: string` The ID of the tool call object. - `function?: Function` The definition of the function that was called. - `arguments?: string` The arguments passed to the function. - `name?: string` The name of the function. - `output?: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. ### Tool Calls Step Details - `ToolCallsStepDetails` Details of the tool call. - `tool_calls: Array` 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`. - `CodeInterpreterToolCall` Details of the Code Interpreter tool call the run step was involved in. - `id: string` The ID of the tool call. - `code_interpreter: CodeInterpreter` The Code Interpreter tool call definition. - `input: string` The input to the Code Interpreter tool call. - `outputs: Array` 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. - `Logs` 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`. - `"logs"` - `Image` - `image: Image` - `file_id: string` The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. - `type: "image"` Always `image`. - `"image"` - `type: "code_interpreter"` The type of tool call. This is always going to be `code_interpreter` for this type of tool call. - `"code_interpreter"` - `FileSearchToolCall` - `id: string` The ID of the tool call object. - `file_search: FileSearch` For now, this is always going to be an empty object. - `ranking_options?: RankingOptions` The ranking options for the file search. - `ranker: "auto" | "default_2024_08_21"` The ranker to use for the file search. If not specified will use the `auto` ranker. - `"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. - `results?: Array` 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. - `content?: Array` The content of the result that was found. The content is only included if requested via the include query parameter. - `text?: string` The text content of the file. - `type?: "text"` The type of the content. - `"text"` - `type: "file_search"` The type of tool call. This is always going to be `file_search` for this type of tool call. - `"file_search"` - `FunctionToolCall` - `id: string` The ID of the tool call object. - `function: Function` The definition of the function that was called. - `arguments: string` The arguments passed to the function. - `name: string` The name of the function. - `output: string | null` The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. - `type: "function"` The type of tool call. This is always going to be `function` for this type of tool call. - `"function"` - `type: "tool_calls"` Always `tool_calls`. - `"tool_calls"` # Messages ## List messages `client.beta.threads.messages.list(stringthreadID, MessageListParamsquery?, RequestOptionsoptions?): CursorPage` **get** `/threads/{thread_id}/messages` Returns a list of messages for a given thread. ### Parameters - `threadID: string` - `query: MessageListParams` - `after?: string` A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - `before?: string` A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - `limit?: number` A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - `order?: "asc" | "desc"` Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. - `"asc"` - `"desc"` - `run_id?: string` Filter messages by the run ID that generated them. ### Returns - `Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const message of client.beta.threads.messages.list('thread_id')) { console.log(message.id); } ``` #### Response ```json { "data": [ { "id": "id", "assistant_id": "assistant_id", "attachments": [ { "file_id": "file_id", "tools": [ { "type": "code_interpreter" } ] } ], "completed_at": 0, "content": [ { "image_file": { "file_id": "file_id", "detail": "auto" }, "type": "image_file" } ], "created_at": 0, "incomplete_at": 0, "incomplete_details": { "reason": "content_filter" }, "metadata": { "foo": "string" }, "object": "thread.message", "role": "user", "run_id": "run_id", "status": "in_progress", "thread_id": "thread_id" } ], "first_id": "msg_abc123", "has_more": false, "last_id": "msg_abc123", "object": "list" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const threadMessages = await openai.beta.threads.messages.list( "thread_abc123" ); console.log(threadMessages.data); } main(); ``` #### Response ```json { "object": "list", "data": [ { "id": "msg_abc123", "object": "thread.message", "created_at": 1699016383, "assistant_id": null, "thread_id": "thread_abc123", "run_id": null, "role": "user", "content": [ { "type": "text", "text": { "value": "How does AI work? Explain it in simple terms.", "annotations": [] } } ], "attachments": [], "metadata": {} }, { "id": "msg_abc456", "object": "thread.message", "created_at": 1699016383, "assistant_id": null, "thread_id": "thread_abc123", "run_id": null, "role": "user", "content": [ { "type": "text", "text": { "value": "Hello, what is AI?", "annotations": [] } } ], "attachments": [], "metadata": {} } ], "first_id": "msg_abc123", "last_id": "msg_abc456", "has_more": false } ``` ## Create message `client.beta.threads.messages.create(stringthreadID, MessageCreateParamsbody, RequestOptionsoptions?): Message` **post** `/threads/{thread_id}/messages` Create a message. ### Parameters - `threadID: string` - `body: MessageCreateParams` - `content: string | Array` The text contents of the message. - `string` - `Array` - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlockParam` The text content that is part of a message. - `text: string` Text content to be sent to the model - `type: "text"` Always `text`. - `"text"` - `role: "user" | "assistant"` The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. - `"user"` - `"assistant"` - `attachments?: Array | null` A list of files attached to the message, and the tools they should be added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `FileSearch` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `metadata?: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. ### Returns - `Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const message = await client.beta.threads.messages.create('thread_id', { content: 'string', role: 'user', }); console.log(message.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "attachments": [ { "file_id": "file_id", "tools": [ { "type": "code_interpreter" } ] } ], "completed_at": 0, "content": [ { "image_file": { "file_id": "file_id", "detail": "auto" }, "type": "image_file" } ], "created_at": 0, "incomplete_at": 0, "incomplete_details": { "reason": "content_filter" }, "metadata": { "foo": "string" }, "object": "thread.message", "role": "user", "run_id": "run_id", "status": "in_progress", "thread_id": "thread_id" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const threadMessages = await openai.beta.threads.messages.create( "thread_abc123", { role: "user", content: "How does AI work? Explain it in simple terms." } ); console.log(threadMessages); } main(); ``` #### Response ```json { "id": "msg_abc123", "object": "thread.message", "created_at": 1713226573, "assistant_id": null, "thread_id": "thread_abc123", "run_id": null, "role": "user", "content": [ { "type": "text", "text": { "value": "How does AI work? Explain it in simple terms.", "annotations": [] } } ], "attachments": [], "metadata": {} } ``` ## Modify message `client.beta.threads.messages.update(stringmessageID, MessageUpdateParamsparams, RequestOptionsoptions?): Message` **post** `/threads/{thread_id}/messages/{message_id}` Modifies a message. ### Parameters - `messageID: string` - `params: MessageUpdateParams` - `thread_id: string` Path param: The ID of the thread to which this message belongs. - `metadata?: Metadata | null` Body param: 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. ### Returns - `Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const message = await client.beta.threads.messages.update('message_id', { thread_id: 'thread_id' }); console.log(message.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "attachments": [ { "file_id": "file_id", "tools": [ { "type": "code_interpreter" } ] } ], "completed_at": 0, "content": [ { "image_file": { "file_id": "file_id", "detail": "auto" }, "type": "image_file" } ], "created_at": 0, "incomplete_at": 0, "incomplete_details": { "reason": "content_filter" }, "metadata": { "foo": "string" }, "object": "thread.message", "role": "user", "run_id": "run_id", "status": "in_progress", "thread_id": "thread_id" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const message = await openai.beta.threads.messages.update( "thread_abc123", "msg_abc123", { metadata: { modified: "true", user: "abc123", }, } }' ``` #### Response ```json { "id": "msg_abc123", "object": "thread.message", "created_at": 1699017614, "assistant_id": null, "thread_id": "thread_abc123", "run_id": null, "role": "user", "content": [ { "type": "text", "text": { "value": "How does AI work? Explain it in simple terms.", "annotations": [] } } ], "file_ids": [], "metadata": { "modified": "true", "user": "abc123" } } ``` ## Retrieve message `client.beta.threads.messages.retrieve(stringmessageID, MessageRetrieveParamsparams, RequestOptionsoptions?): Message` **get** `/threads/{thread_id}/messages/{message_id}` Retrieve a message. ### Parameters - `messageID: string` - `params: MessageRetrieveParams` - `thread_id: string` The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) to which this message belongs. ### Returns - `Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const message = await client.beta.threads.messages.retrieve('message_id', { thread_id: 'thread_id', }); console.log(message.id); ``` #### Response ```json { "id": "id", "assistant_id": "assistant_id", "attachments": [ { "file_id": "file_id", "tools": [ { "type": "code_interpreter" } ] } ], "completed_at": 0, "content": [ { "image_file": { "file_id": "file_id", "detail": "auto" }, "type": "image_file" } ], "created_at": 0, "incomplete_at": 0, "incomplete_details": { "reason": "content_filter" }, "metadata": { "foo": "string" }, "object": "thread.message", "role": "user", "run_id": "run_id", "status": "in_progress", "thread_id": "thread_id" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const message = await openai.beta.threads.messages.retrieve( "msg_abc123", { thread_id: "thread_abc123" } ); console.log(message); } main(); ``` #### Response ```json { "id": "msg_abc123", "object": "thread.message", "created_at": 1699017614, "assistant_id": null, "thread_id": "thread_abc123", "run_id": null, "role": "user", "content": [ { "type": "text", "text": { "value": "How does AI work? Explain it in simple terms.", "annotations": [] } } ], "attachments": [], "metadata": {} } ``` ## Delete message `client.beta.threads.messages.delete(stringmessageID, MessageDeleteParamsparams, RequestOptionsoptions?): MessageDeleted` **delete** `/threads/{thread_id}/messages/{message_id}` Deletes a message. ### Parameters - `messageID: string` - `params: MessageDeleteParams` - `thread_id: string` The ID of the thread to which this message belongs. ### Returns - `MessageDeleted` - `id: string` - `deleted: boolean` - `object: "thread.message.deleted"` - `"thread.message.deleted"` ### Example ```typescript import OpenAI from 'openai'; const client = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted }); const messageDeleted = await client.beta.threads.messages.delete('message_id', { thread_id: 'thread_id', }); console.log(messageDeleted.id); ``` #### Response ```json { "id": "id", "deleted": true, "object": "thread.message.deleted" } ``` ### Example ```typescript import OpenAI from "openai"; const openai = new OpenAI(); async function main() { const deletedMessage = await openai.beta.threads.messages.delete( "msg_abc123", { thread_id: "thread_abc123" } ); console.log(deletedMessage); } ``` #### Response ```json { "id": "msg_abc123", "object": "thread.message.deleted", "deleted": true } ``` ## Domain Types ### Annotation - `Annotation = FileCitationAnnotation | FilePathAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` ### Annotation Delta - `AnnotationDelta = FileCitationDeltaAnnotation | FilePathDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `FileCitationDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `index: number` The index of the annotation in the text content part. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `end_index?: number` - `file_citation?: FileCitation` - `file_id?: string` The ID of the specific File the citation is from. - `quote?: string` The specific quote in the file. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `FilePathDeltaAnnotation` 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`. - `"file_path"` - `end_index?: number` - `file_path?: FilePath` - `file_id?: string` The ID of the file that was generated. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. ### File Citation Annotation - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` ### File Citation Delta Annotation - `FileCitationDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `index: number` The index of the annotation in the text content part. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `end_index?: number` - `file_citation?: FileCitation` - `file_id?: string` The ID of the specific File the citation is from. - `quote?: string` The specific quote in the file. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. ### File Path Annotation - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` ### File Path Delta Annotation - `FilePathDeltaAnnotation` 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`. - `"file_path"` - `end_index?: number` - `file_path?: FilePath` - `file_id?: string` The ID of the file that was generated. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. ### Image File - `ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` ### Image File Content Block - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` ### Image File Delta - `ImageFileDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `file_id?: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. ### Image File Delta Block - `ImageFileDeltaBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) 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"` - `image_file?: ImageFileDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `file_id?: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. ### Image URL - `ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` ### Image URL Content Block - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` ### Image URL Delta - `ImageURLDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `url?: string` The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. ### Image URL Delta Block - `ImageURLDeltaBlock` 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"` - `image_url?: ImageURLDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `url?: string` The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. ### Message - `Message` Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). - `id: string` The identifier, which can be referenced in API endpoints. - `assistant_id: string | null` If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. - `attachments: Array | null` A list of files attached to the message, and the tools they were added to. - `file_id?: string` The ID of the file to attach to the message. - `tools?: Array` The tools to add this file to. - `CodeInterpreterTool` - `type: "code_interpreter"` The type of tool being defined: `code_interpreter` - `"code_interpreter"` - `AssistantToolsFileSearchTypeOnly` - `type: "file_search"` The type of tool being defined: `file_search` - `"file_search"` - `completed_at: number | null` The Unix timestamp (in seconds) for when the message was completed. - `content: Array` The content of the message in array of text and/or images. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` - `created_at: number` The Unix timestamp (in seconds) for when the message was created. - `incomplete_at: number | null` The Unix timestamp (in seconds) for when the message was marked as incomplete. - `incomplete_details: IncompleteDetails | null` On an incomplete message, details about why the message is incomplete. - `reason: "content_filter" | "max_tokens" | "run_cancelled" | 2 more` The reason the message is incomplete. - `"content_filter"` - `"max_tokens"` - `"run_cancelled"` - `"run_expired"` - `"run_failed"` - `metadata: Metadata | null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. - `object: "thread.message"` The object type, which is always `thread.message`. - `"thread.message"` - `role: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `run_id: string | null` The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. - `status: "in_progress" | "incomplete" | "completed"` The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. - `"in_progress"` - `"incomplete"` - `"completed"` - `thread_id: string` The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. ### Message Content - `MessageContent = ImageFileContentBlock | ImageURLContentBlock | TextContentBlock | RefusalContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` ### Message Content Delta - `MessageContentDelta = ImageFileDeltaBlock | TextDeltaBlock | RefusalDeltaBlock | ImageURLDeltaBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `ImageFileDeltaBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) 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"` - `image_file?: ImageFileDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `file_id?: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `TextDeltaBlock` 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"` - `text?: TextDelta` - `annotations?: Array` - `FileCitationDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `index: number` The index of the annotation in the text content part. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `end_index?: number` - `file_citation?: FileCitation` - `file_id?: string` The ID of the specific File the citation is from. - `quote?: string` The specific quote in the file. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `FilePathDeltaAnnotation` 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`. - `"file_path"` - `end_index?: number` - `file_path?: FilePath` - `file_id?: string` The ID of the file that was generated. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `value?: string` The data that makes up the text. - `RefusalDeltaBlock` 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"` - `refusal?: string` - `ImageURLDeltaBlock` 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"` - `image_url?: ImageURLDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `url?: string` The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. ### Message Content Part Param - `MessageContentPartParam = ImageFileContentBlock | ImageURLContentBlock | TextContentBlockParam` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `ImageFileContentBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. - `image_file: ImageFile` - `file_id: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `type: "image_file"` Always `image_file`. - `"image_file"` - `ImageURLContentBlock` References an image URL in the content of a message. - `image_url: ImageURL` - `url: string` The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto` - `"auto"` - `"low"` - `"high"` - `type: "image_url"` The type of the content part. - `"image_url"` - `TextContentBlockParam` The text content that is part of a message. - `text: string` Text content to be sent to the model - `type: "text"` Always `text`. - `"text"` ### Message Deleted - `MessageDeleted` - `id: string` - `deleted: boolean` - `object: "thread.message.deleted"` - `"thread.message.deleted"` ### Message Delta - `MessageDelta` The delta containing the fields that have changed on the Message. - `content?: Array` The content of the message in array of text and/or images. - `ImageFileDeltaBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) 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"` - `image_file?: ImageFileDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `file_id?: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `TextDeltaBlock` 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"` - `text?: TextDelta` - `annotations?: Array` - `FileCitationDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `index: number` The index of the annotation in the text content part. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `end_index?: number` - `file_citation?: FileCitation` - `file_id?: string` The ID of the specific File the citation is from. - `quote?: string` The specific quote in the file. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `FilePathDeltaAnnotation` 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`. - `"file_path"` - `end_index?: number` - `file_path?: FilePath` - `file_id?: string` The ID of the file that was generated. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `value?: string` The data that makes up the text. - `RefusalDeltaBlock` 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"` - `refusal?: string` - `ImageURLDeltaBlock` 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"` - `image_url?: ImageURLDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `url?: string` The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `role?: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` ### Message Delta Event - `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?: Array` The content of the message in array of text and/or images. - `ImageFileDeltaBlock` References an image [File](https://platform.openai.com/docs/api-reference/files) 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"` - `image_file?: ImageFileDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `file_id?: string` The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. - `TextDeltaBlock` 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"` - `text?: TextDelta` - `annotations?: Array` - `FileCitationDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `index: number` The index of the annotation in the text content part. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `end_index?: number` - `file_citation?: FileCitation` - `file_id?: string` The ID of the specific File the citation is from. - `quote?: string` The specific quote in the file. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `FilePathDeltaAnnotation` 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`. - `"file_path"` - `end_index?: number` - `file_path?: FilePath` - `file_id?: string` The ID of the file that was generated. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `value?: string` The data that makes up the text. - `RefusalDeltaBlock` 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"` - `refusal?: string` - `ImageURLDeltaBlock` 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"` - `image_url?: ImageURLDelta` - `detail?: "auto" | "low" | "high"` Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. - `"auto"` - `"low"` - `"high"` - `url?: string` The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp. - `role?: "user" | "assistant"` The entity that produced the message. One of `user` or `assistant`. - `"user"` - `"assistant"` - `object: "thread.message.delta"` The object type, which is always `thread.message.delta`. - `"thread.message.delta"` ### Refusal Content Block - `RefusalContentBlock` The refusal content generated by the assistant. - `refusal: string` - `type: "refusal"` Always `refusal`. - `"refusal"` ### Refusal Delta Block - `RefusalDeltaBlock` 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"` - `refusal?: string` ### Text - `Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. ### Text Content Block - `TextContentBlock` The text content that is part of a message. - `text: Text` - `annotations: Array` - `FileCitationAnnotation` 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` - `file_citation: FileCitation` - `file_id: string` The ID of the specific File the citation is from. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `FilePathAnnotation` A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. - `end_index: number` - `file_path: FilePath` - `file_id: string` The ID of the file that was generated. - `start_index: number` - `text: string` The text in the message content that needs to be replaced. - `type: "file_path"` Always `file_path`. - `"file_path"` - `value: string` The data that makes up the text. - `type: "text"` Always `text`. - `"text"` ### Text Content Block Param - `TextContentBlockParam` The text content that is part of a message. - `text: string` Text content to be sent to the model - `type: "text"` Always `text`. - `"text"` ### Text Delta - `TextDelta` - `annotations?: Array` - `FileCitationDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `index: number` The index of the annotation in the text content part. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `end_index?: number` - `file_citation?: FileCitation` - `file_id?: string` The ID of the specific File the citation is from. - `quote?: string` The specific quote in the file. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `FilePathDeltaAnnotation` 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`. - `"file_path"` - `end_index?: number` - `file_path?: FilePath` - `file_id?: string` The ID of the file that was generated. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `value?: string` The data that makes up the text. ### Text Delta Block - `TextDeltaBlock` 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"` - `text?: TextDelta` - `annotations?: Array` - `FileCitationDeltaAnnotation` A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. - `index: number` The index of the annotation in the text content part. - `type: "file_citation"` Always `file_citation`. - `"file_citation"` - `end_index?: number` - `file_citation?: FileCitation` - `file_id?: string` The ID of the specific File the citation is from. - `quote?: string` The specific quote in the file. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `FilePathDeltaAnnotation` 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`. - `"file_path"` - `end_index?: number` - `file_path?: FilePath` - `file_id?: string` The ID of the file that was generated. - `start_index?: number` - `text?: string` The text in the message content that needs to be replaced. - `value?: string` The data that makes up the text.