Path parameters

• thread_id string Required

  The ID of the thread that was run.

• run_id string Required

  The ID of the run to retrieve.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id string Required

    The identifier, which can be referenced in API endpoints.

  • object string Required

    The object type, which is always thread.run.

    Value is thread.run.

  • created_at integer Required

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

  • thread_id string Required

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

  • assistant_id string Required

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

  • status string Required

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

    Values are queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

  • required_action object | null Required

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

    Hide required_action attributes Show required_action attributes object | null

    • type string Required

      For now, this is always submit_tool_outputs.

      Value is submit_tool_outputs.

    • submit_tool_outputs object Required

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

      Hide submit_tool_outputs attribute Show submit_tool_outputs attribute object

      • tool_calls array[object] Required

        A list of the relevant tool calls.

        Tool call objects

        Hide tool_calls attributes Show tool_calls attributes object

        • id string Required

          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.

        • type string Required

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

          Value is function.

        • function object Required

          The function definition.

          Hide function attributes Show function attributes object

          • name string Required

            The name of the function.

          • arguments string Required

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

  • last_error object | null Required

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

    Hide last_error attributes Show last_error attributes object | null

    • code string Required

      One of server_error, rate_limit_exceeded, or invalid_prompt.

      Values are server_error, rate_limit_exceeded, or invalid_prompt.

    • message string Required

      A human-readable description of the error.

  • expires_at integer | null Required

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

  • started_at integer | null Required

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

  • cancelled_at integer | null Required

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

  • failed_at integer | null Required

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

  • completed_at integer | null Required

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

  • incomplete_details object | null Required

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

    Hide incomplete_details attribute Show incomplete_details attribute object | null

    • reason string

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

      Values are max_completion_tokens or max_prompt_tokens.

  • model string Required

    The model that the assistant used for this run.

  • instructions string Required

    The instructions that the assistant used for this run.

  • tools array[object] Required

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

    Not more than 20 elements. Default value is [] (empty).

    One of:

    AssistantToolsCode object AssistantToolsFileSearch object AssistantToolsFunction object

    Hide attribute Show attribute

    • type string Required

      The type of tool being defined: code_interpreter

      Value is code_interpreter.

    Hide attributes Show attributes

    • type string Required

      The type of tool being defined: file_search

      Value is file_search.

    • file_search object

      Overrides for the file search tool.

      Hide file_search attributes Show file_search attributes object

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

        Minimum value is 1, maximum value is 50.

      • ranking_options object

        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.

        Hide ranking_options attributes Show ranking_options attributes object

        • ranker string

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

          Values are auto or default_2024_08_21.

        • score_threshold number Required

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

          Minimum value is 0, maximum value is 1.

    Hide attributes Show attributes

    • type string Required

      The type of tool being defined: function

      Value is function.

    • function object Required
      Hide function attributes Show function attributes object

      • description string

        A description of what the function does, used by the model to choose when and how to call the function.

      • name string Required

        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.

      • parameters object

        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.

        Additional properties are allowed.

      • strict boolean | null

        Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the function calling guide.

        Default value is false.

  • metadata object | null Required

    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.

    Hide metadata attribute Show metadata attribute object | null

    • * string Additional properties
  • usage object | null Required

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

    Hide usage attributes Show usage attributes object | null

    • completion_tokens integer Required

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

    • prompt_tokens integer Required

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

    • total_tokens integer Required

      Total number of tokens used (prompt + completion).

  • temperature number | null

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

  • top_p number | null

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

  • max_prompt_tokens integer | null Required

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

    Minimum value is 256.

  • max_completion_tokens integer | null Required

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

    Minimum value is 256.

  • truncation_strategy object Required

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

    Hide truncation_strategy attributes Show truncation_strategy attributes object

    • type string Required

      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.

      Values are auto or last_messages.

    • last_messages integer | null

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

      Minimum value is 1.

  • tool_choice string | object Required

    One of:

    string-1 string AssistantsNamedToolChoice object

    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.

    Values are none, auto, or required.

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

    Hide attributes Show attributes

    • type string Required

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

      Values are function, code_interpreter, or file_search.

    • function object
      Hide function attribute Show function attribute object

      • name string Required

        The name of the function to call.

  • parallel_tool_calls boolean Required

    Whether to enable parallel function calling during tool use.

    Default value is true.

  • response_format string | null | object Required

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

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

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

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

    One of:

    string-1 string | null ResponseFormatText object | null ResponseFormatJsonObject object | null ResponseFormatJsonSchema object | null

    auto is the default value

    Value is auto.

    Default response format. Used to generate text responses.

    Hide attribute Show attribute

    • type string Required

      The type of response format being defined. Always text.

      Value is text.

    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.

    Hide attribute Show attribute

    • type string Required

      The type of response format being defined. Always json_object.

      Value is json_object.

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

    Hide attributes Show attributes

    • type string Required

      The type of response format being defined. Always json_schema.

      Value is json_schema.

    • json_schema object Required

      Structured Outputs configuration options, including a JSON Schema.

      Hide json_schema attributes Show json_schema attributes object

      • description string

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

      • name string Required

        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.

      • schema object

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

        Additional properties are allowed.

      • strict boolean | null

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

        Default value is false.