/ 
OpenAPI-Client-OpenAI-0.20
River stage zero No dependents
/ OpenAPI::Client::OpenAI::Path::threads-runs

NAME

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

DESCRIPTION

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

See the examples/ directory in the distribution for examples of how to use this.

POST /threads/runs

Create a thread and run it in one request.

Operation ID

createThreadAndRun

$client->createThreadAndRun( ... );

Request Body

Content Type: application/json

Example:

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

Responses

Status Code: 200

OK

Content Types:

  • application/json

    Example:

    {
   "required_action" : {
      "submit_tool_outputs" : {
         "tool_calls" : [
            {
               "function" : null
            }
         ]
      }
   },
   "usage" : null,
   "last_error" : null,
   "incomplete_details" : null,
   "tools" : [
      null
   ]
}

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.