NAME

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

DESCRIPTION

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

PATHS

DELETE /responses/{response_id}

Deletes a model response with the given ID.

Operation ID

deleteResponse

$client->deleteResponse( ... );

Parameters

• response_id (in path) (Required) - The ID of the response to delete.

  Type: string

Responses

Status Code: 200

OK

Status Code: 404

Not Found

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

GET /responses/{response_id}

Retrieves a model response with the given ID.

Operation ID

getResponse

$client->getResponse( ... );

Parameters

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

  Type: string

• include (in query) (Optional) - Specify additional output data to include in the response. Currently supported values are: - `file_search_call.results`: Include the search results of the file search tool call. - `message.input_image.image_url`: Include image urls from the input message. - `computer_call_output.output.image_url`: Include image urls from the computer call output.

  Type: array

Responses

Status Code: 200

OK

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

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.

cpanm OpenAPI::Client::OpenAI

perl -MCPAN -e shell
install OpenAPI::Client::OpenAI