Skip to content
Primary navigation
API Dashboard
API Reference
Beta
Threads
Runs

Modify run

Deprecated
client.Beta.Threads.Runs.Update(ctx, threadID, runID, body) (*Run, error)
POST/threads/{thread_id}/runs/{run_id}

Modifies a run.

ParametersExpand Collapse
threadID string
runID string
body BetaThreadRunUpdateParams
Metadata param.Field[Metadata]optional

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.

ReturnsExpand Collapse
type Run struct{…}

Represents an execution run on a thread.

ID string

The identifier, which can be referenced in API endpoints.

AssistantID string

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

CancelledAt int64

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

CompletedAt int64

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

CreatedAt int64

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

ExpiresAt int64

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

FailedAt int64

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

IncompleteDetails RunIncompleteDetails

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

Reason stringoptional

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

Accepts one of the following:
const RunIncompleteDetailsReasonMaxCompletionTokens RunIncompleteDetailsReason = "max_completion_tokens"
const RunIncompleteDetailsReasonMaxPromptTokens RunIncompleteDetailsReason = "max_prompt_tokens"
Instructions string

The instructions that the assistant used for this run.

LastError RunLastError

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

Code string

One of server_error, rate_limit_exceeded, or invalid_prompt.

Accepts one of the following:
const RunLastErrorCodeServerError RunLastErrorCode = "server_error"
const RunLastErrorCodeRateLimitExceeded RunLastErrorCode = "rate_limit_exceeded"
const RunLastErrorCodeInvalidPrompt RunLastErrorCode = "invalid_prompt"
Message string

A human-readable description of the error.

MaxCompletionTokens int64

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

minimum256
MaxPromptTokens int64

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

minimum256
Metadata Metadata

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

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

Model string

The model that the assistant used for this run.

Object ThreadRun

The object type, which is always thread.run.

ParallelToolCalls bool

Whether to enable parallel function calling during tool use.

RequiredAction RunRequiredAction

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

SubmitToolOutputs RunRequiredActionSubmitToolOutputs

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

ToolCalls []RequiredActionFunctionToolCall

A list of the relevant tool calls.

ID string

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

Function RequiredActionFunctionToolCallFunction

The function definition.

Arguments string

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

Name string

The name of the function.

Type Function

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

Type SubmitToolOutputs

For now, this is always submit_tool_outputs.

ResponseFormat AssistantResponseFormatOptionUnion

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

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

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

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

Accepts one of the following:
type Auto string

auto is the default value

type ResponseFormatText struct{…}

Default response format. Used to generate text responses.

Type Text

The type of response format being defined. Always text.

type ResponseFormatJSONObject struct{…}

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

Type JSONObject

The type of response format being defined. Always json_object.

type ResponseFormatJSONSchema struct{…}

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

JSONSchema ResponseFormatJSONSchemaJSONSchema

Structured Outputs configuration options, including a JSON Schema.

Name string

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

Description stringoptional

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

Schema map[string, any]optional

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

Strict booloptional

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

Type JSONSchema

The type of response format being defined. Always json_schema.

StartedAt int64

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

Status RunStatus

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

Accepts one of the following:
const RunStatusQueued RunStatus = "queued"
const RunStatusInProgress RunStatus = "in_progress"
const RunStatusRequiresAction RunStatus = "requires_action"
const RunStatusCancelling RunStatus = "cancelling"
const RunStatusCancelled RunStatus = "cancelled"
const RunStatusFailed RunStatus = "failed"
const RunStatusCompleted RunStatus = "completed"
const RunStatusIncomplete RunStatus = "incomplete"
const RunStatusExpired RunStatus = "expired"
ThreadID string

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

ToolChoice AssistantToolChoiceOptionUnion

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

Accepts one of the following:
type AssistantToolChoiceOptionAuto string

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

Accepts one of the following:
const AssistantToolChoiceOptionAutoNone AssistantToolChoiceOptionAuto = "none"
const AssistantToolChoiceOptionAutoAuto AssistantToolChoiceOptionAuto = "auto"
const AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"
type AssistantToolChoice struct{…}

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

Type AssistantToolChoiceType

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

Accepts one of the following:
const AssistantToolChoiceTypeFunction AssistantToolChoiceType = "function"
const AssistantToolChoiceTypeCodeInterpreter AssistantToolChoiceType = "code_interpreter"
const AssistantToolChoiceTypeFileSearch AssistantToolChoiceType = "file_search"
Name string

The name of the function to call.

Tools []AssistantToolUnion

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

Accepts one of the following:
type CodeInterpreterTool struct{…}
Type CodeInterpreter

The type of tool being defined: code_interpreter

type FileSearchTool struct{…}
Type FileSearch

The type of tool being defined: file_search

Accepts one of the following:
type FunctionTool struct{…}
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 stringoptional

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

Parameters FunctionParametersoptional

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 booloptional

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

TruncationStrategy RunTruncationStrategy

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

Type string

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

Accepts one of the following:
const RunTruncationStrategyTypeAuto RunTruncationStrategyType = "auto"
const RunTruncationStrategyTypeLastMessages RunTruncationStrategyType = "last_messages"
LastMessages int64optional

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

minimum1
Usage RunUsage

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

CompletionTokens int64

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

PromptTokens int64

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

TotalTokens int64

Total number of tokens used (prompt + completion).

Temperature float64optional

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

TopP float64optional

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

Modify run

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  run, err := client.Beta.Threads.Runs.Update(
    context.TODO(),
    "thread_id",
    "run_id",
    openai.BetaThreadRunUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", run.ID)
}

{
  "id": "run_abc123",
  "object": "thread.run",
  "created_at": 1699075072,
  "assistant_id": "asst_abc123",
  "thread_id": "thread_abc123",
  "status": "completed",
  "started_at": 1699075072,
  "expires_at": null,
  "cancelled_at": null,
  "failed_at": null,
  "completed_at": 1699075073,
  "last_error": null,
  "model": "gpt-4o",
  "instructions": null,
  "incomplete_details": null,
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "file-abc123",
        "file-abc456"
      ]
    }
  },
  "metadata": {
    "user_id": "user_abc123"
  },
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 456,
    "total_tokens": 579
  },
  "temperature": 1.0,
  "top_p": 1.0,
  "max_prompt_tokens": 1000,
  "max_completion_tokens": 1000,
  "truncation_strategy": {
    "type": "auto",
    "last_messages": null
  },
  "response_format": "auto",
  "tool_choice": "auto",
  "parallel_tool_calls": true
}
Returns Examples
{
  "id": "run_abc123",
  "object": "thread.run",
  "created_at": 1699075072,
  "assistant_id": "asst_abc123",
  "thread_id": "thread_abc123",
  "status": "completed",
  "started_at": 1699075072,
  "expires_at": null,
  "cancelled_at": null,
  "failed_at": null,
  "completed_at": 1699075073,
  "last_error": null,
  "model": "gpt-4o",
  "instructions": null,
  "incomplete_details": null,
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "file-abc123",
        "file-abc456"
      ]
    }
  },
  "metadata": {
    "user_id": "user_abc123"
  },
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 456,
    "total_tokens": 579
  },
  "temperature": 1.0,
  "top_p": 1.0,
  "max_prompt_tokens": 1000,
  "max_completion_tokens": 1000,
  "truncation_strategy": {
    "type": "auto",
    "last_messages": null
  },
  "response_format": "auto",
  "tool_choice": "auto",
  "parallel_tool_calls": true
}