Threads

Create thread

beta.threads.create(**kwargs) -> Thread

post /threads

Create a thread.

Parameters

• messages: Array[Message{ content, role, attachments, metadata}]

  A list of messages to start the thread with.

  • content: String | Array[MessageContentPartParam]

    The text contents of the message.

    • String = String

      The text contents of the message.

    • ArrayOfContentParts = Array[MessageContentPartParam]

      An array of content parts with a defined type, each can be of type text or images can be passed with image_url or image_file. Image types are only supported on Vision-compatible models.

      • class ImageFileContentBlock

        References an image File in the content of a message.

        • image_file: ImageFile

          • file_id: String

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

          • detail: :auto | :low | :high

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

            • :auto

            • :low

            • :high

        • type: :image_file

          Always image_file.

          • :image_file

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

      • class 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[Attachment{ file_id, tools}]

    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[CodeInterpreterTool | FileSearch{ type}]

      The tools to add this file to.

      • class CodeInterpreterTool

        • type: :code_interpreter

          The type of tool being defined: code_interpreter

          • :code_interpreter

      • class FileSearch

        • type: :file_search

          The type of tool being defined: file_search

          • :file_search

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

• metadata: Metadata

  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

• tool_resources: ToolResources{ code_interpreter, file_search}

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

  • code_interpreter: CodeInterpreter{ file_ids}

    • file_ids: Array[String]

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

  • file_search: FileSearch{ vector_store_ids, vector_stores}

    • vector_store_ids: Array[String]

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

    • vector_stores: Array[VectorStore{ chunking_strategy, file_ids, metadata}]

      A helper to create a vector store 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{ type} | Static{ static, type}

        The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.

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

        • class Static

          • static: Static{ chunk_overlap_tokens, max_chunk_size_tokens}

            • chunk_overlap_tokens: Integer

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

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

        A list of file 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

        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

• class Thread

  Represents a thread that contains messages.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • created_at: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • object: :thread

    The object type, which is always thread.

    • :thread

  • tool_resources: ToolResources{ code_interpreter, file_search}

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

    • code_interpreter: CodeInterpreter{ file_ids}

      • file_ids: Array[String]

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

    • file_search: FileSearch{ vector_store_ids}

      • vector_store_ids: Array[String]

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

thread = openai.beta.threads.create

puts(thread)

Response

{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "object": "thread",
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "string"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "string"
      ]
    }
  }
}

Create thread and run

beta.threads.create_and_run(**kwargs) -> Run

post /threads/runs

Create a thread and run it in one request.

Parameters

• assistant_id: String

  The ID of the assistant to use to execute this run.

• instructions: String

  Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.

• max_completion_tokens: Integer

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

  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

  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

  The ID of the Model 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 = String

  • ChatModel = :"gpt-5.6-sol" | :"gpt-5.6-terra" | :"gpt-5.6-luna" | 78 more

    • :"gpt-5.6-sol"

    • :"gpt-5.6-terra"

    • :"gpt-5.6-luna"

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

  Whether to enable parallel function calling during tool use.

• response_format: AssistantResponseFormatOption

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

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

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

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

  • AssistantResponseFormatOption = :auto

    auto is the default value

    • :auto

  • class ResponseFormatText

    Default response format. Used to generate text responses.

    • type: :text

      The type of response format being defined. Always text.

      • :text

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

  • class ResponseFormatJSONSchema

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

    • json_schema: JSONSchema{ name, description, schema, strict}

      Structured Outputs configuration options, including a JSON Schema.

      • name: String

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

      • description: String

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

      • schema: Hash[Symbol, untyped]

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

      • strict: bool

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

    • type: :json_schema

      The type of response format being defined. Always json_schema.

      • :json_schema

• stream: bool

  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.

• temperature: Float

  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{ messages, metadata, tool_resources}

  Options to create a new thread. If no thread is provided when running a request, an empty thread will be created.

  • messages: Array[Message{ content, role, attachments, metadata}]

    A list of messages to start the thread with.

    • content: String | Array[MessageContentPartParam]

      The text contents of the message.

      • String = String

        The text contents of the message.

      • ArrayOfContentParts = Array[MessageContentPartParam]

        An array of content parts with a defined type, each can be of type text or images can be passed with image_url or image_file. Image types are only supported on Vision-compatible models.

        • class ImageFileContentBlock

          References an image File in the content of a message.

          • image_file: ImageFile

            • file_id: String

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

            • detail: :auto | :low | :high

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

              • :auto

              • :low

              • :high

          • type: :image_file

            Always image_file.

            • :image_file

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

        • class 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[Attachment{ file_id, tools}]

      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[CodeInterpreterTool | FileSearch{ type}]

        The tools to add this file to.

        • class CodeInterpreterTool

          • type: :code_interpreter

            The type of tool being defined: code_interpreter

            • :code_interpreter

        • class FileSearch

          • type: :file_search

            The type of tool being defined: file_search

            • :file_search

    • metadata: Metadata

      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • tool_resources: ToolResources{ code_interpreter, file_search}

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

    • code_interpreter: CodeInterpreter{ file_ids}

      • file_ids: Array[String]

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

    • file_search: FileSearch{ vector_store_ids, vector_stores}

      • vector_store_ids: Array[String]

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

      • vector_stores: Array[VectorStore{ chunking_strategy, file_ids, metadata}]

        A helper to create a vector store 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{ type} | Static{ static, type}

          The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.

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

          • class Static

            • static: Static{ chunk_overlap_tokens, max_chunk_size_tokens}

              • chunk_overlap_tokens: Integer

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

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

          A list of file 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

          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

  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.

  • Auto = :none | :auto | :required

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

    • :none

    • :auto

    • :required

  • class 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{ code_interpreter, file_search}

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

  • code_interpreter: CodeInterpreter{ file_ids}

    • file_ids: Array[String]

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

  • file_search: FileSearch{ vector_store_ids}

    • vector_store_ids: Array[String]

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

• tools: Array[AssistantTool]

  Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

  • class CodeInterpreterTool

  • class FileSearchTool

    • type: :file_search

      The type of tool being defined: file_search

      • :file_search

    • file_search: FileSearch{ max_num_results, ranking_options}

      Overrides for the file search tool.

      • max_num_results: Integer

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

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

      • ranking_options: RankingOptions{ score_threshold, ranker}

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

        See the file search tool documentation for more information.

        • score_threshold: Float

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

        • 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

  • class 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 for examples, and the JSON Schema reference for documentation about the format.

        Omitting parameters defines a function with an empty parameter list.

      • strict: bool

        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.

    • type: :function

      The type of tool being defined: function

      • :function

• top_p: Float

  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{ type, last_messages}

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

  • type: :auto | :last_messages

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

    • :auto

    • :last_messages

  • last_messages: Integer

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

Returns

• class Run

  Represents an execution run on a thread.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • assistant_id: String

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

  • cancelled_at: Integer

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

  • completed_at: Integer

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

  • created_at: Integer

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

  • expires_at: Integer

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

  • failed_at: Integer

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

  • incomplete_details: IncompleteDetails{ reason}

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

    • reason: :max_completion_tokens | :max_prompt_tokens

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

      • :max_completion_tokens

      • :max_prompt_tokens

  • instructions: String

    The instructions that the assistant used for this run.

  • last_error: LastError{ code, message}

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

    • code: :server_error | :rate_limit_exceeded | :invalid_prompt

      One of server_error, rate_limit_exceeded, or invalid_prompt.

      • :server_error

      • :rate_limit_exceeded

      • :invalid_prompt

    • message: String

      A human-readable description of the error.

  • max_completion_tokens: Integer

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

  • max_prompt_tokens: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • model: String

    The model that the assistant used for this run.

  • object: :"thread.run"

    The object type, which is always thread.run.

    • :"thread.run"

  • parallel_tool_calls: bool

    Whether to enable parallel function calling during tool use.

  • required_action: RequiredAction{ submit_tool_outputs, type}

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

    • submit_tool_outputs: SubmitToolOutputs{ tool_calls}

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

      • tool_calls: Array[RequiredActionFunctionToolCall]

        A list of the relevant tool calls.

        • id: String

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

        • function: Function{ arguments, name}

          The function definition.

          • arguments: String

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

          • name: String

            The name of the function.

        • type: :function

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

          • :function

    • type: :submit_tool_outputs

      For now, this is always submit_tool_outputs.

      • :submit_tool_outputs

  • response_format: AssistantResponseFormatOption

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

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

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

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

    • AssistantResponseFormatOption = :auto

      auto is the default value

      • :auto

    • class ResponseFormatText

      Default response format. Used to generate text responses.

      • type: :text

        The type of response format being defined. Always text.

        • :text

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

    • class ResponseFormatJSONSchema

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

      • json_schema: JSONSchema{ name, description, schema, strict}

        Structured Outputs configuration options, including a JSON Schema.

        • name: String

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

        • description: String

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

        • schema: Hash[Symbol, untyped]

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

        • strict: bool

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

      • type: :json_schema

        The type of response format being defined. Always json_schema.

        • :json_schema

  • started_at: Integer

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

  • status: RunStatus

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

    • :queued

    • :in_progress

    • :requires_action

    • :cancelling

    • :cancelled

    • :failed

    • :completed

    • :incomplete

    • :expired

  • thread_id: String

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

  • tool_choice: AssistantToolChoiceOption

    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.

    • Auto = :none | :auto | :required

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

      • :none

      • :auto

      • :required

    • class 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[AssistantTool]

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

    • class CodeInterpreterTool

      • type: :code_interpreter

        The type of tool being defined: code_interpreter

        • :code_interpreter

    • class FileSearchTool

      • type: :file_search

        The type of tool being defined: file_search

        • :file_search

      • file_search: FileSearch{ max_num_results, ranking_options}

        Overrides for the file search tool.

        • max_num_results: Integer

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

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

        • ranking_options: RankingOptions{ score_threshold, ranker}

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

          See the file search tool documentation for more information.

          • score_threshold: Float

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

          • 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

    • class 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 for examples, and the JSON Schema reference for documentation about the format.

          Omitting parameters defines a function with an empty parameter list.

        • strict: bool

          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.

      • type: :function

        The type of tool being defined: function

        • :function

  • truncation_strategy: TruncationStrategy{ type, last_messages}

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

    • type: :auto | :last_messages

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

      • :auto

      • :last_messages

    • last_messages: Integer

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

  • usage: Usage{ completion_tokens, prompt_tokens, total_tokens}

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

    • completion_tokens: Integer

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

    • prompt_tokens: Integer

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

    • total_tokens: Integer

      Total number of tokens used (prompt + completion).

  • temperature: Float

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

  • top_p: Float

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

run = openai.beta.threads.create_and_run(assistant_id: "assistant_id")

puts(run)

Response

{
  "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
}

Retrieve thread

beta.threads.retrieve(thread_id) -> Thread

get /threads/{thread_id}

Retrieves a thread.

Parameters

• thread_id: String

Returns

• class Thread

  Represents a thread that contains messages.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • created_at: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • object: :thread

    The object type, which is always thread.

    • :thread

  • tool_resources: ToolResources{ code_interpreter, file_search}

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

    • code_interpreter: CodeInterpreter{ file_ids}

      • file_ids: Array[String]

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

    • file_search: FileSearch{ vector_store_ids}

      • vector_store_ids: Array[String]

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

thread = openai.beta.threads.retrieve("thread_id")

puts(thread)

Response

{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "object": "thread",
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "string"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "string"
      ]
    }
  }
}

Modify thread

beta.threads.update(thread_id, **kwargs) -> Thread

post /threads/{thread_id}

Modifies a thread.

Parameters

• thread_id: String

• metadata: Metadata

  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

• tool_resources: ToolResources{ code_interpreter, file_search}

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

  • code_interpreter: CodeInterpreter{ file_ids}

    • file_ids: Array[String]

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

  • file_search: FileSearch{ vector_store_ids}

    • vector_store_ids: Array[String]

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

Returns

• class Thread

  Represents a thread that contains messages.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • created_at: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • object: :thread

    The object type, which is always thread.

    • :thread

  • tool_resources: ToolResources{ code_interpreter, file_search}

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

    • code_interpreter: CodeInterpreter{ file_ids}

      • file_ids: Array[String]

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

    • file_search: FileSearch{ vector_store_ids}

      • vector_store_ids: Array[String]

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

thread = openai.beta.threads.update("thread_id")

puts(thread)

Response

{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "object": "thread",
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "string"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "string"
      ]
    }
  }
}

Delete thread

beta.threads.delete(thread_id) -> ThreadDeleted

delete /threads/{thread_id}

Delete a thread.

Parameters

• thread_id: String

Returns

• class ThreadDeleted

  • id: String

  • deleted: bool

  • object: :"thread.deleted"

    • :"thread.deleted"

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

thread_deleted = openai.beta.threads.delete("thread_id")

puts(thread_deleted)

Response

{
  "id": "id",
  "deleted": true,
  "object": "thread.deleted"
}

Domain Types

Assistant Response Format Option

• AssistantResponseFormatOption = :auto | ResponseFormatText | ResponseFormatJSONObject | ResponseFormatJSONSchema

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

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

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

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

  • AssistantResponseFormatOption = :auto

    auto is the default value

    • :auto

  • class ResponseFormatText

    Default response format. Used to generate text responses.

    • type: :text

      The type of response format being defined. Always text.

      • :text

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

  • class ResponseFormatJSONSchema

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

    • json_schema: JSONSchema{ name, description, schema, strict}

      Structured Outputs configuration options, including a JSON Schema.

      • name: String

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

      • description: String

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

      • schema: Hash[Symbol, untyped]

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

      • strict: bool

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

    • type: :json_schema

      The type of response format being defined. Always json_schema.

      • :json_schema

Assistant Tool Choice

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

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

  • Auto = :none | :auto | :required

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

    • :none

    • :auto

    • :required

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

• class Thread

  Represents a thread that contains messages.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • created_at: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • object: :thread

    The object type, which is always thread.

    • :thread

  • tool_resources: ToolResources{ code_interpreter, file_search}

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

    • code_interpreter: CodeInterpreter{ file_ids}

      • file_ids: Array[String]

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

    • file_search: FileSearch{ vector_store_ids}

      • vector_store_ids: Array[String]

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

Thread Deleted

• class ThreadDeleted

  • id: String

  • deleted: bool

  • object: :"thread.deleted"

    • :"thread.deleted"

Runs

List runs

beta.threads.runs.list(thread_id, **kwargs) -> CursorPage<Run>

get /threads/{thread_id}/runs

Returns a list of runs belonging to a thread.

Parameters

• thread_id: String

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

  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

• class Run

  Represents an execution run on a thread.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • assistant_id: String

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

  • cancelled_at: Integer

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

  • completed_at: Integer

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

  • created_at: Integer

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

  • expires_at: Integer

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

  • failed_at: Integer

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

  • incomplete_details: IncompleteDetails{ reason}

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

    • reason: :max_completion_tokens | :max_prompt_tokens

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

      • :max_completion_tokens

      • :max_prompt_tokens

  • instructions: String

    The instructions that the assistant used for this run.

  • last_error: LastError{ code, message}

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

    • code: :server_error | :rate_limit_exceeded | :invalid_prompt

      One of server_error, rate_limit_exceeded, or invalid_prompt.

      • :server_error

      • :rate_limit_exceeded

      • :invalid_prompt

    • message: String

      A human-readable description of the error.

  • max_completion_tokens: Integer

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

  • max_prompt_tokens: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • model: String

    The model that the assistant used for this run.

  • object: :"thread.run"

    The object type, which is always thread.run.

    • :"thread.run"

  • parallel_tool_calls: bool

    Whether to enable parallel function calling during tool use.

  • required_action: RequiredAction{ submit_tool_outputs, type}

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

    • submit_tool_outputs: SubmitToolOutputs{ tool_calls}

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

      • tool_calls: Array[RequiredActionFunctionToolCall]

        A list of the relevant tool calls.

        • id: String

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

        • function: Function{ arguments, name}

          The function definition.

          • arguments: String

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

          • name: String

            The name of the function.

        • type: :function

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

          • :function

    • type: :submit_tool_outputs

      For now, this is always submit_tool_outputs.

      • :submit_tool_outputs

  • response_format: AssistantResponseFormatOption

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

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

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

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

    • AssistantResponseFormatOption = :auto

      auto is the default value

      • :auto

    • class ResponseFormatText

      Default response format. Used to generate text responses.

      • type: :text

        The type of response format being defined. Always text.

        • :text

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

    • class ResponseFormatJSONSchema

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

      • json_schema: JSONSchema{ name, description, schema, strict}

        Structured Outputs configuration options, including a JSON Schema.

        • name: String

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

        • description: String

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

        • schema: Hash[Symbol, untyped]

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

        • strict: bool

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

      • type: :json_schema

        The type of response format being defined. Always json_schema.

        • :json_schema

  • started_at: Integer

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

  • status: RunStatus

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

    • :queued

    • :in_progress

    • :requires_action

    • :cancelling

    • :cancelled

    • :failed

    • :completed

    • :incomplete

    • :expired

  • thread_id: String

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

  • tool_choice: AssistantToolChoiceOption

    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.

    • Auto = :none | :auto | :required

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

      • :none

      • :auto

      • :required

    • class 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[AssistantTool]

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

    • class CodeInterpreterTool

      • type: :code_interpreter

        The type of tool being defined: code_interpreter

        • :code_interpreter

    • class FileSearchTool

      • type: :file_search

        The type of tool being defined: file_search

        • :file_search

      • file_search: FileSearch{ max_num_results, ranking_options}

        Overrides for the file search tool.

        • max_num_results: Integer

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

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

        • ranking_options: RankingOptions{ score_threshold, ranker}

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

          See the file search tool documentation for more information.

          • score_threshold: Float

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

          • 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

    • class 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 for examples, and the JSON Schema reference for documentation about the format.

          Omitting parameters defines a function with an empty parameter list.

        • strict: bool

          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.

      • type: :function

        The type of tool being defined: function

        • :function

  • truncation_strategy: TruncationStrategy{ type, last_messages}

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

    • type: :auto | :last_messages

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

      • :auto

      • :last_messages

    • last_messages: Integer

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

  • usage: Usage{ completion_tokens, prompt_tokens, total_tokens}

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

    • completion_tokens: Integer

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

    • prompt_tokens: Integer

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

    • total_tokens: Integer

      Total number of tokens used (prompt + completion).

  • temperature: Float

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

  • top_p: Float

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

page = openai.beta.threads.runs.list("thread_id")

puts(page)

Response

{
  "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"
}

Create run

beta.threads.runs.create(thread_id, **kwargs) -> Run

post /threads/{thread_id}/runs

Create a run.

Parameters

• thread_id: String

• assistant_id: String

  The ID of the assistant to use to execute this run.

• include: Array[RunStepInclude]

  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 for more information.

  • :"step_details.tool_calls[*].file_search.results[*].content"

• additional_instructions: String

  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[AdditionalMessage{ content, role, attachments, metadata}]

  Adds additional messages to the thread before creating the run.

  • content: String | Array[MessageContentPartParam]

    The text contents of the message.

    • String = String

      The text contents of the message.

    • ArrayOfContentParts = Array[MessageContentPartParam]

      An array of content parts with a defined type, each can be of type text or images can be passed with image_url or image_file. Image types are only supported on Vision-compatible models.

      • class ImageFileContentBlock

        References an image File in the content of a message.

        • image_file: ImageFile

          • file_id: String

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

          • detail: :auto | :low | :high

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

            • :auto

            • :low

            • :high

        • type: :image_file

          Always image_file.

          • :image_file

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

      • class 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[Attachment{ file_id, tools}]

    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[CodeInterpreterTool | FileSearch{ type}]

      The tools to add this file to.

      • class CodeInterpreterTool

        • type: :code_interpreter

          The type of tool being defined: code_interpreter

          • :code_interpreter

      • class FileSearch

        • type: :file_search

          The type of tool being defined: file_search

          • :file_search

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

• instructions: String

  Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.

• max_completion_tokens: Integer

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

  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

  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

  The ID of the Model 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 = String

  • ChatModel = :"gpt-5.6-sol" | :"gpt-5.6-terra" | :"gpt-5.6-luna" | 78 more

    • :"gpt-5.6-sol"

    • :"gpt-5.6-terra"

    • :"gpt-5.6-luna"

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

  Whether to enable parallel function calling during tool use.

• reasoning_effort: ReasoningEffort

  Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, xhigh, and max. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the reasoning guide for model-specific support.

  • :none

  • :minimal

  • :low

  • :medium

  • :high

  • :xhigh

  • :max

• response_format: AssistantResponseFormatOption

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

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

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

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

  • AssistantResponseFormatOption = :auto

    auto is the default value

    • :auto

  • class ResponseFormatText

    Default response format. Used to generate text responses.

    • type: :text

      The type of response format being defined. Always text.

      • :text

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

  • class ResponseFormatJSONSchema

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

    • json_schema: JSONSchema{ name, description, schema, strict}

      Structured Outputs configuration options, including a JSON Schema.

      • name: String

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

      • description: String

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

      • schema: Hash[Symbol, untyped]

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

      • strict: bool

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

    • type: :json_schema

      The type of response format being defined. Always json_schema.

      • :json_schema

• stream: bool

  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.

• temperature: Float

  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

  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.

  • Auto = :none | :auto | :required

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

    • :none

    • :auto

    • :required

  • class 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[AssistantTool]

  Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

  • class CodeInterpreterTool

  • class FileSearchTool

    • type: :file_search

      The type of tool being defined: file_search

      • :file_search

    • file_search: FileSearch{ max_num_results, ranking_options}

      Overrides for the file search tool.

      • max_num_results: Integer

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

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

      • ranking_options: RankingOptions{ score_threshold, ranker}

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

        See the file search tool documentation for more information.

        • score_threshold: Float

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

        • 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

  • class 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 for examples, and the JSON Schema reference for documentation about the format.

        Omitting parameters defines a function with an empty parameter list.

      • strict: bool

        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.

    • type: :function

      The type of tool being defined: function

      • :function

• top_p: Float

  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{ type, last_messages}

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

  • type: :auto | :last_messages

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

    • :auto

    • :last_messages

  • last_messages: Integer

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

Returns

• class Run

  Represents an execution run on a thread.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • assistant_id: String

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

  • cancelled_at: Integer

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

  • completed_at: Integer

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

  • created_at: Integer

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

  • expires_at: Integer

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

  • failed_at: Integer

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

  • incomplete_details: IncompleteDetails{ reason}

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

    • reason: :max_completion_tokens | :max_prompt_tokens

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

      • :max_completion_tokens

      • :max_prompt_tokens

  • instructions: String

    The instructions that the assistant used for this run.

  • last_error: LastError{ code, message}

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

    • code: :server_error | :rate_limit_exceeded | :invalid_prompt

      One of server_error, rate_limit_exceeded, or invalid_prompt.

      • :server_error

      • :rate_limit_exceeded

      • :invalid_prompt

    • message: String

      A human-readable description of the error.

  • max_completion_tokens: Integer

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

  • max_prompt_tokens: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • model: String

    The model that the assistant used for this run.

  • object: :"thread.run"

    The object type, which is always thread.run.

    • :"thread.run"

  • parallel_tool_calls: bool

    Whether to enable parallel function calling during tool use.

  • required_action: RequiredAction{ submit_tool_outputs, type}

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

    • submit_tool_outputs: SubmitToolOutputs{ tool_calls}

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

      • tool_calls: Array[RequiredActionFunctionToolCall]

        A list of the relevant tool calls.

        • id: String

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

        • function: Function{ arguments, name}

          The function definition.

          • arguments: String

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

          • name: String

            The name of the function.

        • type: :function

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

          • :function

    • type: :submit_tool_outputs

      For now, this is always submit_tool_outputs.

      • :submit_tool_outputs

  • response_format: AssistantResponseFormatOption

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

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

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

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

    • AssistantResponseFormatOption = :auto

      auto is the default value

      • :auto

    • class ResponseFormatText

      Default response format. Used to generate text responses.

      • type: :text

        The type of response format being defined. Always text.

        • :text

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

    • class ResponseFormatJSONSchema

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

      • json_schema: JSONSchema{ name, description, schema, strict}

        Structured Outputs configuration options, including a JSON Schema.

        • name: String

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

        • description: String

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

        • schema: Hash[Symbol, untyped]

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

        • strict: bool

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

      • type: :json_schema

        The type of response format being defined. Always json_schema.

        • :json_schema

  • started_at: Integer

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

  • status: RunStatus

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

    • :queued

    • :in_progress

    • :requires_action

    • :cancelling

    • :cancelled

    • :failed

    • :completed

    • :incomplete

    • :expired

  • thread_id: String

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

  • tool_choice: AssistantToolChoiceOption

    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.

    • Auto = :none | :auto | :required

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

      • :none

      • :auto

      • :required

    • class 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[AssistantTool]

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

    • class CodeInterpreterTool

      • type: :code_interpreter

        The type of tool being defined: code_interpreter

        • :code_interpreter

    • class FileSearchTool

      • type: :file_search

        The type of tool being defined: file_search

        • :file_search

      • file_search: FileSearch{ max_num_results, ranking_options}

        Overrides for the file search tool.

        • max_num_results: Integer

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

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

        • ranking_options: RankingOptions{ score_threshold, ranker}

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

          See the file search tool documentation for more information.

          • score_threshold: Float

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

          • 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

    • class 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 for examples, and the JSON Schema reference for documentation about the format.

          Omitting parameters defines a function with an empty parameter list.

        • strict: bool

          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.

      • type: :function

        The type of tool being defined: function

        • :function

  • truncation_strategy: TruncationStrategy{ type, last_messages}

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

    • type: :auto | :last_messages

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

      • :auto

      • :last_messages

    • last_messages: Integer

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

  • usage: Usage{ completion_tokens, prompt_tokens, total_tokens}

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

    • completion_tokens: Integer

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

    • prompt_tokens: Integer

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

    • total_tokens: Integer

      Total number of tokens used (prompt + completion).

  • temperature: Float

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

  • top_p: Float

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

run = openai.beta.threads.runs.create("thread_id", assistant_id: "assistant_id")

puts(run)

Response

{
  "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
}

Retrieve run

beta.threads.runs.retrieve(run_id, **kwargs) -> Run

get /threads/{thread_id}/runs/{run_id}

Retrieves a run.

Parameters

• thread_id: String

• run_id: String

Returns

• class Run

  Represents an execution run on a thread.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • assistant_id: String

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

  • cancelled_at: Integer

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

  • completed_at: Integer

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

  • created_at: Integer

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

  • expires_at: Integer

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

  • failed_at: Integer

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

  • incomplete_details: IncompleteDetails{ reason}

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

    • reason: :max_completion_tokens | :max_prompt_tokens

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

      • :max_completion_tokens

      • :max_prompt_tokens

  • instructions: String

    The instructions that the assistant used for this run.

  • last_error: LastError{ code, message}

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

    • code: :server_error | :rate_limit_exceeded | :invalid_prompt

      One of server_error, rate_limit_exceeded, or invalid_prompt.

      • :server_error

      • :rate_limit_exceeded

      • :invalid_prompt

    • message: String

      A human-readable description of the error.

  • max_completion_tokens: Integer

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

  • max_prompt_tokens: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • model: String

    The model that the assistant used for this run.

  • object: :"thread.run"

    The object type, which is always thread.run.

    • :"thread.run"

  • parallel_tool_calls: bool

    Whether to enable parallel function calling during tool use.

  • required_action: RequiredAction{ submit_tool_outputs, type}

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

    • submit_tool_outputs: SubmitToolOutputs{ tool_calls}

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

      • tool_calls: Array[RequiredActionFunctionToolCall]

        A list of the relevant tool calls.

        • id: String

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

        • function: Function{ arguments, name}

          The function definition.

          • arguments: String

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

          • name: String

            The name of the function.

        • type: :function

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

          • :function

    • type: :submit_tool_outputs

      For now, this is always submit_tool_outputs.

      • :submit_tool_outputs

  • response_format: AssistantResponseFormatOption

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

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

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

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

    • AssistantResponseFormatOption = :auto

      auto is the default value

      • :auto

    • class ResponseFormatText

      Default response format. Used to generate text responses.

      • type: :text

        The type of response format being defined. Always text.

        • :text

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

    • class ResponseFormatJSONSchema

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

      • json_schema: JSONSchema{ name, description, schema, strict}

        Structured Outputs configuration options, including a JSON Schema.

        • name: String

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

        • description: String

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

        • schema: Hash[Symbol, untyped]

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

        • strict: bool

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

      • type: :json_schema

        The type of response format being defined. Always json_schema.

        • :json_schema

  • started_at: Integer

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

  • status: RunStatus

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

    • :queued

    • :in_progress

    • :requires_action

    • :cancelling

    • :cancelled

    • :failed

    • :completed

    • :incomplete

    • :expired

  • thread_id: String

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

  • tool_choice: AssistantToolChoiceOption

    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.

    • Auto = :none | :auto | :required

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

      • :none

      • :auto

      • :required

    • class 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[AssistantTool]

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

    • class CodeInterpreterTool

      • type: :code_interpreter

        The type of tool being defined: code_interpreter

        • :code_interpreter

    • class FileSearchTool

      • type: :file_search

        The type of tool being defined: file_search

        • :file_search

      • file_search: FileSearch{ max_num_results, ranking_options}

        Overrides for the file search tool.

        • max_num_results: Integer

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

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

        • ranking_options: RankingOptions{ score_threshold, ranker}

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

          See the file search tool documentation for more information.

          • score_threshold: Float

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

          • 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

    • class 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 for examples, and the JSON Schema reference for documentation about the format.

          Omitting parameters defines a function with an empty parameter list.

        • strict: bool

          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.

      • type: :function

        The type of tool being defined: function

        • :function

  • truncation_strategy: TruncationStrategy{ type, last_messages}

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

    • type: :auto | :last_messages

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

      • :auto

      • :last_messages

    • last_messages: Integer

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

  • usage: Usage{ completion_tokens, prompt_tokens, total_tokens}

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

    • completion_tokens: Integer

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

    • prompt_tokens: Integer

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

    • total_tokens: Integer

      Total number of tokens used (prompt + completion).

  • temperature: Float

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

  • top_p: Float

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

run = openai.beta.threads.runs.retrieve("run_id", thread_id: "thread_id")

puts(run)

Response

{
  "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
}

Modify run

beta.threads.runs.update(run_id, **kwargs) -> Run

post /threads/{thread_id}/runs/{run_id}

Modifies a run.

Parameters

• thread_id: String

• run_id: String

• metadata: Metadata

  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

Returns

• class Run

  Represents an execution run on a thread.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • assistant_id: String

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

  • cancelled_at: Integer

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

  • completed_at: Integer

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

  • created_at: Integer

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

  • expires_at: Integer

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

  • failed_at: Integer

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

  • incomplete_details: IncompleteDetails{ reason}

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

    • reason: :max_completion_tokens | :max_prompt_tokens

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

      • :max_completion_tokens

      • :max_prompt_tokens

  • instructions: String

    The instructions that the assistant used for this run.

  • last_error: LastError{ code, message}

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

    • code: :server_error | :rate_limit_exceeded | :invalid_prompt

      One of server_error, rate_limit_exceeded, or invalid_prompt.

      • :server_error

      • :rate_limit_exceeded

      • :invalid_prompt

    • message: String

      A human-readable description of the error.

  • max_completion_tokens: Integer

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

  • max_prompt_tokens: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • model: String

    The model that the assistant used for this run.

  • object: :"thread.run"

    The object type, which is always thread.run.

    • :"thread.run"

  • parallel_tool_calls: bool

    Whether to enable parallel function calling during tool use.

  • required_action: RequiredAction{ submit_tool_outputs, type}

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

    • submit_tool_outputs: SubmitToolOutputs{ tool_calls}

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

      • tool_calls: Array[RequiredActionFunctionToolCall]

        A list of the relevant tool calls.

        • id: String

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

        • function: Function{ arguments, name}

          The function definition.

          • arguments: String

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

          • name: String

            The name of the function.

        • type: :function

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

          • :function

    • type: :submit_tool_outputs

      For now, this is always submit_tool_outputs.

      • :submit_tool_outputs

  • response_format: AssistantResponseFormatOption

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

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

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

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

    • AssistantResponseFormatOption = :auto

      auto is the default value

      • :auto

    • class ResponseFormatText

      Default response format. Used to generate text responses.

      • type: :text

        The type of response format being defined. Always text.

        • :text

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

    • class ResponseFormatJSONSchema

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

      • json_schema: JSONSchema{ name, description, schema, strict}

        Structured Outputs configuration options, including a JSON Schema.

        • name: String

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

        • description: String

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

        • schema: Hash[Symbol, untyped]

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

        • strict: bool

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

      • type: :json_schema

        The type of response format being defined. Always json_schema.

        • :json_schema

  • started_at: Integer

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

  • status: RunStatus

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

    • :queued

    • :in_progress

    • :requires_action

    • :cancelling

    • :cancelled

    • :failed

    • :completed

    • :incomplete

    • :expired

  • thread_id: String

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

  • tool_choice: AssistantToolChoiceOption

    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.

    • Auto = :none | :auto | :required

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

      • :none

      • :auto

      • :required

    • class 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[AssistantTool]

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

    • class CodeInterpreterTool

      • type: :code_interpreter

        The type of tool being defined: code_interpreter

        • :code_interpreter

    • class FileSearchTool

      • type: :file_search

        The type of tool being defined: file_search

        • :file_search

      • file_search: FileSearch{ max_num_results, ranking_options}

        Overrides for the file search tool.

        • max_num_results: Integer

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

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

        • ranking_options: RankingOptions{ score_threshold, ranker}

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

          See the file search tool documentation for more information.

          • score_threshold: Float

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

          • 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

    • class 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 for examples, and the JSON Schema reference for documentation about the format.

          Omitting parameters defines a function with an empty parameter list.

        • strict: bool

          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.

      • type: :function

        The type of tool being defined: function

        • :function

  • truncation_strategy: TruncationStrategy{ type, last_messages}

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

    • type: :auto | :last_messages

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

      • :auto

      • :last_messages

    • last_messages: Integer

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

  • usage: Usage{ completion_tokens, prompt_tokens, total_tokens}

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

    • completion_tokens: Integer

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

    • prompt_tokens: Integer

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

    • total_tokens: Integer

      Total number of tokens used (prompt + completion).

  • temperature: Float

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

  • top_p: Float

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

run = openai.beta.threads.runs.update("run_id", thread_id: "thread_id")

puts(run)

Response

{
  "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
}

Submit tool outputs to run

beta.threads.runs.submit_tool_outputs(run_id, **kwargs) -> Run

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

• thread_id: String

• run_id: String

• tool_outputs: Array[ToolOutput{ output, tool_call_id}]

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

  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.

Returns

• class Run

  Represents an execution run on a thread.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • assistant_id: String

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

  • cancelled_at: Integer

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

  • completed_at: Integer

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

  • created_at: Integer

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

  • expires_at: Integer

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

  • failed_at: Integer

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

  • incomplete_details: IncompleteDetails{ reason}

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

    • reason: :max_completion_tokens | :max_prompt_tokens

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

      • :max_completion_tokens

      • :max_prompt_tokens

  • instructions: String

    The instructions that the assistant used for this run.

  • last_error: LastError{ code, message}

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

    • code: :server_error | :rate_limit_exceeded | :invalid_prompt

      One of server_error, rate_limit_exceeded, or invalid_prompt.

      • :server_error

      • :rate_limit_exceeded

      • :invalid_prompt

    • message: String

      A human-readable description of the error.

  • max_completion_tokens: Integer

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

  • max_prompt_tokens: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • model: String

    The model that the assistant used for this run.

  • object: :"thread.run"

    The object type, which is always thread.run.

    • :"thread.run"

  • parallel_tool_calls: bool

    Whether to enable parallel function calling during tool use.

  • required_action: RequiredAction{ submit_tool_outputs, type}

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

    • submit_tool_outputs: SubmitToolOutputs{ tool_calls}

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

      • tool_calls: Array[RequiredActionFunctionToolCall]

        A list of the relevant tool calls.

        • id: String

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

        • function: Function{ arguments, name}

          The function definition.

          • arguments: String

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

          • name: String

            The name of the function.

        • type: :function

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

          • :function

    • type: :submit_tool_outputs

      For now, this is always submit_tool_outputs.

      • :submit_tool_outputs

  • response_format: AssistantResponseFormatOption

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

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

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

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

    • AssistantResponseFormatOption = :auto

      auto is the default value

      • :auto

    • class ResponseFormatText

      Default response format. Used to generate text responses.

      • type: :text

        The type of response format being defined. Always text.

        • :text

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

    • class ResponseFormatJSONSchema

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

      • json_schema: JSONSchema{ name, description, schema, strict}

        Structured Outputs configuration options, including a JSON Schema.

        • name: String

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

        • description: String

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

        • schema: Hash[Symbol, untyped]

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

        • strict: bool

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

      • type: :json_schema

        The type of response format being defined. Always json_schema.

        • :json_schema

  • started_at: Integer

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

  • status: RunStatus

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

    • :queued

    • :in_progress

    • :requires_action

    • :cancelling

    • :cancelled

    • :failed

    • :completed

    • :incomplete

    • :expired

  • thread_id: String

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

  • tool_choice: AssistantToolChoiceOption

    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.

    • Auto = :none | :auto | :required

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

      • :none

      • :auto

      • :required

    • class 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[AssistantTool]

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

    • class CodeInterpreterTool

      • type: :code_interpreter

        The type of tool being defined: code_interpreter

        • :code_interpreter

    • class FileSearchTool

      • type: :file_search

        The type of tool being defined: file_search

        • :file_search

      • file_search: FileSearch{ max_num_results, ranking_options}

        Overrides for the file search tool.

        • max_num_results: Integer

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

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

        • ranking_options: RankingOptions{ score_threshold, ranker}

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

          See the file search tool documentation for more information.

          • score_threshold: Float

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

          • 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

    • class 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 for examples, and the JSON Schema reference for documentation about the format.

          Omitting parameters defines a function with an empty parameter list.

        • strict: bool

          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.

      • type: :function

        The type of tool being defined: function

        • :function

  • truncation_strategy: TruncationStrategy{ type, last_messages}

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

    • type: :auto | :last_messages

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

      • :auto

      • :last_messages

    • last_messages: Integer

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

  • usage: Usage{ completion_tokens, prompt_tokens, total_tokens}

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

    • completion_tokens: Integer

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

    • prompt_tokens: Integer

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

    • total_tokens: Integer

      Total number of tokens used (prompt + completion).

  • temperature: Float

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

  • top_p: Float

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

run = openai.beta.threads.runs.submit_tool_outputs("run_id", thread_id: "thread_id", tool_outputs: [{}])

puts(run)

Response

{
  "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
}

Cancel a run

beta.threads.runs.cancel(run_id, **kwargs) -> Run

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

Cancels a run that is in_progress.

Parameters

• thread_id: String

• run_id: String

Returns

• class Run

  Represents an execution run on a thread.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • assistant_id: String

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

  • cancelled_at: Integer

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

  • completed_at: Integer

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

  • created_at: Integer

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

  • expires_at: Integer

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

  • failed_at: Integer

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

  • incomplete_details: IncompleteDetails{ reason}

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

    • reason: :max_completion_tokens | :max_prompt_tokens

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

      • :max_completion_tokens

      • :max_prompt_tokens

  • instructions: String

    The instructions that the assistant used for this run.

  • last_error: LastError{ code, message}

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

    • code: :server_error | :rate_limit_exceeded | :invalid_prompt

      One of server_error, rate_limit_exceeded, or invalid_prompt.

      • :server_error

      • :rate_limit_exceeded

      • :invalid_prompt

    • message: String

      A human-readable description of the error.

  • max_completion_tokens: Integer

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

  • max_prompt_tokens: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • model: String

    The model that the assistant used for this run.

  • object: :"thread.run"

    The object type, which is always thread.run.

    • :"thread.run"

  • parallel_tool_calls: bool

    Whether to enable parallel function calling during tool use.

  • required_action: RequiredAction{ submit_tool_outputs, type}

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

    • submit_tool_outputs: SubmitToolOutputs{ tool_calls}

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

      • tool_calls: Array[RequiredActionFunctionToolCall]

        A list of the relevant tool calls.

        • id: String

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

        • function: Function{ arguments, name}

          The function definition.

          • arguments: String

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

          • name: String

            The name of the function.

        • type: :function

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

          • :function

    • type: :submit_tool_outputs

      For now, this is always submit_tool_outputs.

      • :submit_tool_outputs

  • response_format: AssistantResponseFormatOption

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

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

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

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

    • AssistantResponseFormatOption = :auto

      auto is the default value

      • :auto

    • class ResponseFormatText

      Default response format. Used to generate text responses.

      • type: :text

        The type of response format being defined. Always text.

        • :text

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

    • class ResponseFormatJSONSchema

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

      • json_schema: JSONSchema{ name, description, schema, strict}

        Structured Outputs configuration options, including a JSON Schema.

        • name: String

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

        • description: String

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

        • schema: Hash[Symbol, untyped]

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

        • strict: bool

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

      • type: :json_schema

        The type of response format being defined. Always json_schema.

        • :json_schema

  • started_at: Integer

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

  • status: RunStatus

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

    • :queued

    • :in_progress

    • :requires_action

    • :cancelling

    • :cancelled

    • :failed

    • :completed

    • :incomplete

    • :expired

  • thread_id: String

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

  • tool_choice: AssistantToolChoiceOption

    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.

    • Auto = :none | :auto | :required

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

      • :none

      • :auto

      • :required

    • class 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[AssistantTool]

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

    • class CodeInterpreterTool

      • type: :code_interpreter

        The type of tool being defined: code_interpreter

        • :code_interpreter

    • class FileSearchTool

      • type: :file_search

        The type of tool being defined: file_search

        • :file_search

      • file_search: FileSearch{ max_num_results, ranking_options}

        Overrides for the file search tool.

        • max_num_results: Integer

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

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

        • ranking_options: RankingOptions{ score_threshold, ranker}

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

          See the file search tool documentation for more information.

          • score_threshold: Float

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

          • 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

    • class 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 for examples, and the JSON Schema reference for documentation about the format.

          Omitting parameters defines a function with an empty parameter list.

        • strict: bool

          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.

      • type: :function

        The type of tool being defined: function

        • :function

  • truncation_strategy: TruncationStrategy{ type, last_messages}

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

    • type: :auto | :last_messages

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

      • :auto

      • :last_messages

    • last_messages: Integer

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

  • usage: Usage{ completion_tokens, prompt_tokens, total_tokens}

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

    • completion_tokens: Integer

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

    • prompt_tokens: Integer

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

    • total_tokens: Integer

      Total number of tokens used (prompt + completion).

  • temperature: Float

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

  • top_p: Float

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

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

run = openai.beta.threads.runs.cancel("run_id", thread_id: "thread_id")

puts(run)

Response

{
  "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
}

Domain Types

Required Action Function Tool Call

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

  • function: Function{ arguments, name}

    The function definition.

    • arguments: String

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

    • name: String

      The name of the function.

  • type: :function

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

    • :function

Run

• class Run

  Represents an execution run on a thread.

  • id: String

    The identifier, which can be referenced in API endpoints.

  • assistant_id: String

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

  • cancelled_at: Integer

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

  • completed_at: Integer

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

  • created_at: Integer

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

  • expires_at: Integer

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

  • failed_at: Integer

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

  • incomplete_details: IncompleteDetails{ reason}

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

    • reason: :max_completion_tokens | :max_prompt_tokens

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

      • :max_completion_tokens

      • :max_prompt_tokens

  • instructions: String

    The instructions that the assistant used for this run.

  • last_error: LastError{ code, message}

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

    • code: :server_error | :rate_limit_exceeded | :invalid_prompt

      One of server_error, rate_limit_exceeded, or invalid_prompt.

      • :server_error

      • :rate_limit_exceeded

      • :invalid_prompt

    • message: String

      A human-readable description of the error.

  • max_completion_tokens: Integer

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

  • max_prompt_tokens: Integer

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

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • model: String

    The model that the assistant used for this run.

  • object: :"thread.run"

    The object type, which is always thread.run.

    • :"thread.run"

  • parallel_tool_calls: bool

    Whether to enable parallel function calling during tool use.

  • required_action: RequiredAction{ submit_tool_outputs, type}

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

    • submit_tool_outputs: SubmitToolOutputs{ tool_calls}

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

      • tool_calls: Array[RequiredActionFunctionToolCall]

        A list of the relevant tool calls.

        • id: String

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

        • function: Function{ arguments, name}

          The function definition.

          • arguments: String

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

          • name: String

            The name of the function.

        • type: :function

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

          • :function

    • type: :submit_tool_outputs

      For now, this is always submit_tool_outputs.

      • :submit_tool_outputs

  • response_format: AssistantResponseFormatOption

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

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

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

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

    • AssistantResponseFormatOption = :auto

      auto is the default value

      • :auto

    • class ResponseFormatText

      Default response format. Used to generate text responses.

      • type: :text

        The type of response format being defined. Always text.

        • :text

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

    • class ResponseFormatJSONSchema

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

      • json_schema: JSONSchema{ name, description, schema, strict}

        Structured Outputs configuration options, including a JSON Schema.

        • name: String

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

        • description: String

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

        • schema: Hash[Symbol, untyped]

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

        • strict: bool

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

      • type: :json_schema

        The type of response format being defined. Always json_schema.

        • :json_schema

  • started_at: Integer

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

  • status: RunStatus

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

    • :queued

    • :in_progress

    • :requires_action

    • :cancelling

    • :cancelled

    • :failed

    • :completed

    • :incomplete

    • :expired

  • thread_id: String

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

  • tool_choice: AssistantToolChoiceOption

    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.

    • Auto = :none | :auto | :required

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

      • :none

      • :auto

      • :required

    • class 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[AssistantTool]

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

    • class CodeInterpreterTool

      • type: :code_interpreter

        The type of tool being defined: code_interpreter

        • :code_interpreter

    • class FileSearchTool

      • type: :file_search

        The type of tool being defined: file_search

        • :file_search

      • file_search: FileSearch{ max_num_results, ranking_options}

        Overrides for the file search tool.

        • max_num_results: Integer

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

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

        • ranking_options: RankingOptions{ score_threshold, ranker}

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

          See the file search tool documentation for more information.

          • score_threshold: Float

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

          • 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

    • class 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 for examples, and the JSON Schema reference for documentation about the format.

          Omitting parameters defines a function with an empty parameter list.

        • strict: bool

          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.

      • type: :function

        The type of tool being defined: function

        • :function

  • truncation_strategy: TruncationStrategy{ type, last_messages}

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

    • type: :auto | :last_messages

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

      • :auto

      • :last_messages

    • last_messages: Integer

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

  • usage: Usage{ completion_tokens, prompt_tokens, total_tokens}

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

    • completion_tokens: Integer

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

    • prompt_tokens: Integer

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

    • total_tokens: Integer

      Total number of tokens used (prompt + completion).

  • temperature: Float

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

  • top_p: Float

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

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

beta.threads.runs.steps.list(run_id, **kwargs) -> CursorPage<RunStep>

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

Returns a list of run steps belonging to a run.

Parameters

• thread_id: String

• run_id: String

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

• include: Array[RunStepInclude]

  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 for more information.

  • :"step_details.tool_calls[*].file_search.results[*].content"

• limit: Integer

  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

• class 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 associated with the run step.

  • cancelled_at: Integer

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

  • completed_at: Integer

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

  • created_at: Integer

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

  • expired_at: Integer

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

  • failed_at: Integer

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

  • last_error: LastError{ code, message}

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

    • code: :server_error | :rate_limit_exceeded

      One of server_error or rate_limit_exceeded.

      • :server_error

      • :rate_limit_exceeded

    • message: String

      A human-readable description of the error.

  • metadata: Metadata

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

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

  • object: :"thread.run.step"

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

    • :"thread.run.step"

  • run_id: String

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

  • status: :in_progress | :cancelled | :failed | 2 more

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

    • :in_progress

    • :cancelled

    • :failed

    • :completed

    • :expired

  • step_details: MessageCreationStepDetails | ToolCallsStepDetails

    The details of the run step.

    • class MessageCreationStepDetails

      Details of the message creation by the run step.

      • message_creation: MessageCreation{ message_id}

        • message_id: String

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

      • type: :message_creation

        Always message_creation.

        • :message_creation

    • class ToolCallsStepDetails

      Details of the tool call.

      • tool_calls: Array[ToolCall]

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

        • class 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{ input, outputs}

            The Code Interpreter tool call definition.

            • input: String

              The input to the Code Interpreter tool call.

            • outputs: Array[Logs{ logs, type} | Image{ image, type}]

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

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

              • class Image

                • image: Image{ file_id}

                  • file_id: String

                    The file 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

        • class FileSearchToolCall

          • id: String

            The ID of the tool call object.

          • file_search: FileSearch{ ranking_options, results}

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

            • ranking_options: RankingOptions{ ranker, score_threshold}

              The ranking options for the file search.

              • ranker: :auto | :default_2024_08_21

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

                • :auto

                • :default_2024_08_21

              • score_threshold: Float

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

            • results: Array[Result{ file_id, file_name, score, content}]

              The results of the file search.

              • file_id: String

                The ID of the file that result was found in.

              • file_name: String

                The name of the file that result was found in.

              • score: Float

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

              • content: Array[Content{ text, type}]

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

                • text: String

                  The text content of the file.

                • type: :text

                  The type of the content.

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

        • class FunctionToolCall

          • id: String

            The ID of the tool call object.

          • function: Function{ arguments, name, output}

            The definition of the function that was called.

            • arguments: String

              The arguments passed to the function.

            • name: String

              The name of the function.

            • output: String

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

          • type: :function

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

            • :function

      • type: :tool_calls

        Always tool_calls.

        • :tool_calls

  • thread_id: String

    The ID of the thread that was run.

  • type: :message_creation | :tool_calls

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

    • :message_creation

    • :tool_calls

  • usage: Usage{ completion_tokens, prompt_tokens, total_tokens}

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

    • completion_tokens: Integer

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

    • prompt_tokens: Integer

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

    • total_tokens: Integer

      Total number of tokens used (prompt + completion).