NAME

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

DESCRIPTION

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

PATHS

POST /responses/{response_id}/cancel

Cancel a response

Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. Learn more.

Operation ID

cancelResponse

$client->cancelResponse( ... );

Parameters

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

  Type: string

Responses

Status Code: 200

OK

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

Status Code: 404

Not Found

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.