OpenAPI::Client::OpenAI::Path::responses-response_id-input_items(3)

NAME
OpenAPI::Client::OpenAI::Path::responses-response_id-input_items - Documentation for the /responses/{response_id}/input_items path.

DESCRIPTION
This document describes the API endpoint at "/responses/{response_id}/input_items".

PATHS

  "GET /responses/{response_id}/input_items"
Returns a list of input items for a given response.

Operation ID

"listInputItems"

    $client->listInputItems( ... );

Parameters

•   "response_id" (in path) (Required) - The ID of the response to retrieve input items for.

    Type: "string"

•   "limit" (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

    Type: "integer"

    Default: 20

•   "order" (in query) (Optional) - The order to return the input items in. Default is `desc`. - `asc`: Return the input items in ascending order. - `desc`: Return the input items in descending order.

    Type: "string"

    Allowed values: "asc, desc"

•   "after" (in query) (Optional) - An item ID to list items after, used in pagination.

    Type: "string"

•   "before" (in query) (Optional) - An item ID to list items before, used in pagination.

    Type: "string"

•   "include" (in query) (Optional) - Additional fields to include in the response. See the `include` parameter for Response creation above for more information.

    Type: "array"

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>):

        {
          "object": "list",
          "data": [
            {
              "id": "msg_abc123",
              "type": "message",
              "role": "user",
              "content": [
                {
                  "type": "input_text",
                  "text": "Tell me a three sentence bedtime story about a unicorn."
                }
              ]
            }
          ],
          "first_id": "msg_abc123",
          "last_id": "msg_abc123",
          "has_more": false
        }

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.