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

NAME

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

DESCRIPTION

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

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

GET /threads/{thread_id}/runs/{run_id}

Retrieves a run.

Operation ID

getRun

$client->getRun( ... );

Parameters

  • thread_id (in path) (Required) - The ID of the [thread](/docs/api-reference/threads) that was run. Type: string

  • run_id (in path) (Required) - The ID of the run to retrieve. Type: string

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
   ]
}

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

Modifies a run.

Operation ID

modifyRun

$client->modifyRun( ... );

Parameters

  • thread_id (in path) (Required) - The ID of the [thread](/docs/api-reference/threads) that was run. Type: string

  • run_id (in path) (Required) - The ID of the run to modify. Type: string

Request Body

Content Type: application/json

Responses

Status Code: 200

OK

Content Types:

  • application/json

    Example:

    {
   "last_error" : null,
   "required_action" : {
      "submit_tool_outputs" : {
         "tool_calls" : [
            {
               "function" : null
            }
         ]
      }
   },
   "usage" : null,
   "tools" : [
      null
   ],
   "incomplete_details" : 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.