Submit Tool Ouputs to Run

Go to Product

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.

Options

OpenAI Beta
Calls to the Assistants API require that you pass a beta HTTP header.
Thread Id
The ID of the thread to which this run belongs.
Run Id
The ID of the run that requires the tool output submission.
Body

Request body which must comply to the following JSON Schema:

{
  "required" : [ "tool_outputs" ],
  "type" : "object",
  "properties" : {
    "tool_outputs" : {
      "type" : "array",
      "description" : "A list of tools for which the outputs are being submitted.",
      "items" : {
        "type" : "object",
        "properties" : {
          "tool_call_id" : {
            "type" : "string",
            "description" : "The ID of the tool call in the `required_action` object within the run object the output is being submitted for."
          },
          "output" : {
            "type" : "string",
            "description" : "The output of the tool call to be submitted to continue the run."
          }
        }
      }
    },
    "stream" : {
      "type" : "boolean",
      "description" : "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.\n",
      "nullable" : true
    }
  },
  "additionalProperties" : false
}
Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

  • body: Response body
  • status: HTTP status code

Input Ports

Icon
Configuration data.

Output Ports

Icon
Result of the request depending on the selected Result Format.
Icon
Configuration data (this is the same as the input port; it is provided as passthrough for sequentially chaining nodes to declutter your workflow connections).

Popular Predecessors

  • No recommendations found

Popular Successors

  • No recommendations found

Views

This node has no views

Workflows

  • No workflows found

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.