Cancel a background Responses API response — foundry_response_cancel • foundryR

Cancel a background Responses API response

Usage

foundry_response_cancel(
  response_id,
  api_key = NULL,
  endpoint = NULL,
  project_endpoint = NULL
)

Arguments

response_id: Character. The response ID to retrieve.
api_key: Character. Optional API key override.
endpoint: Character. Optional resource endpoint override.
project_endpoint: Character. Optional project endpoint override. Supply this for a response created through the project-scoped API.

Value

A one-row tibble parsed like foundry_response().

Examples

if (FALSE) { # \dontrun{
# Requires a configured Azure endpoint and credentials, and the ID of
# an existing background response that can be cancelled.
foundry_response_cancel("resp_abc123")
} # }