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}

Delete a model response

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}

Get a model response

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) - Additional fields to include in the response. See the `include` parameter for Response creation above for more information.

  Type: array

• stream (in query) (Optional) - If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming) for more information.

  Type: boolean

• starting_after (in query) (Optional) - The sequence number of the event after which to start streaming.

  Type: integer

• include_obfuscation (in query) (Optional) - When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an `obfuscation` field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set `include_obfuscation` to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

  Type: boolean

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