OpenAPI::Client::OpenAI::Path::threads-runs(3)

NAME
OpenAPI::Client::OpenAI::Path::threads-runs - Documentation for the /threads/runs path.

DESCRIPTION
This document describes the API endpoint at "/threads/runs".

PATHS

  "POST /threads/runs"
Create a thread and run it in one request.

Operation ID

"createThreadAndRun"

    $client->createThreadAndRun( ... );

Parameters

Request Body

Content Type: "application/json"

Models

The ID of the Model <https://platform.openai.com/docs/api-reference/models> to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

•   "gpt-4.1"

•   "gpt-4.1-mini"

•   "gpt-4.1-nano"

•   "gpt-4.1-2025-04-14"

•   "gpt-4.1-mini-2025-04-14"

•   "gpt-4.1-nano-2025-04-14"

•   "gpt-4o"

•   "gpt-4o-2024-11-20"

•   "gpt-4o-2024-08-06"

•   "gpt-4o-2024-05-13"

•   "gpt-4o-mini"

•   "gpt-4o-mini-2024-07-18"

•   "gpt-4.5-preview"

•   "gpt-4.5-preview-2025-02-27"

•   "gpt-4-turbo"

•   "gpt-4-turbo-2024-04-09"

•   "gpt-4-0125-preview"

•   "gpt-4-turbo-preview"

•   "gpt-4-1106-preview"

•   "gpt-4-vision-preview"

•   "gpt-4"

•   "gpt-4-0314"

•   "gpt-4-0613"

•   "gpt-4-32k"

•   "gpt-4-32k-0314"

•   "gpt-4-32k-0613"

•   "gpt-3.5-turbo"

•   "gpt-3.5-turbo-16k"

•   "gpt-3.5-turbo-0613"

•   "gpt-3.5-turbo-1106"

•   "gpt-3.5-turbo-0125"

•   "gpt-3.5-turbo-16k-0613"

Example:

    {
       "model" : "gpt-4o",
       "temperature" : 1,
       "thread" : {
          "messages" : [
             {
                "attachments" : [
                   {
                      "tools" : [
                         null
                      ]
                   }
                ]
             }
          ],
          "tool_resources" : {
             "code_interpreter" : {
                "file_ids" : [
                   null
                ]
             },
             "file_search" : {
                "vector_store_ids" : [
                   null
                ],
                "vector_stores" : [
                   {
                      "file_ids" : [
                         null
                      ]
                   }
                ]
             }
          }
       },
       "tool_resources" : {
          "code_interpreter" : {
             "file_ids" : [
                null
             ]
          },
          "file_search" : {
             "vector_store_ids" : [
                null
             ]
          }
       },
       "tools" : [
          null
       ],
       "top_p" : 1
    }

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.