POST /threads/{thread_id}/runs/{run_id}/submit_tool_outputs

Servers

Path parameters

Name Type Required Description
thread_id String Yes

The ID of the thread to which this run belongs.

run_id String Yes

The ID of the run that requires the tool output submission.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
stream Boolean No

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.

tool_outputs[] Array Yes

A list of tools for which the outputs are being submitted.

tool_outputs[].output String No

The output of the tool call to be submitted to continue the run.

tool_outputs[].tool_call_id String No

The ID of the tool call in the required_action object within the run object the output is being submitted for.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.