OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-submit_tool_outputs(3)

NAME
OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-submit_tool_outputs - Documentation for the /threads/{thread_id}/runs/{run_id}/submit_tool_outputs path.

DESCRIPTION
This document describes the API endpoint at "/threads/{thread_id}/runs/{run_id}/submit_tool_outputs".

PATHS

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

Operation ID

"submitToolOuputsToRun"

    $client->submitToolOuputsToRun( ... );

Parameters

•   "thread_id" (in path) (Required) - The ID of the [thread](/docs/api-reference/threads) to which this run belongs.

    Type: "string"

•   "run_id" (in path) (Required) - The ID of the run that requires the tool output submission.

    Type: "string"

Request Body

Content Type: "application/json"

Example:

    {
       "tool_outputs" : [
          null
       ]
    }

Responses

Status Code: 200

OK

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
          "id": "run_abc123",
          "object": "thread.run",
          "created_at": 1698107661,
          "assistant_id": "asst_abc123",
          "thread_id": "thread_abc123",
          "status": "completed",
          "started_at": 1699073476,
          "expires_at": null,
          "cancelled_at": null,
          "failed_at": null,
          "completed_at": 1699073498,
          "last_error": null,
          "model": "gpt-4o",
          "instructions": null,
          "tools": [{"type": "file_search"}, {"type": "code_interpreter"}],
          "metadata": {},
          "incomplete_details": null,
          "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
        }

SEE ALSO
OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.