foundry_response_cancel: Cancel a background Responses API response
In foundryR: Data Frame Workflows for 'Microsoft Foundry'

foundry_response_cancel

R Documentation

Cancel a background Responses API response

Description

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

## Not run: 
# Requires a configured Azure endpoint and credentials, and the ID of
# an existing background response that can be cancelled.
foundry_response_cancel("resp_abc123")

## End(Not run)

foundryR documentation built on Sept. 25, 2026, 1:10 a.m.