Cancel a response

POST https://api.fastapi.ai/v1/responses/{response_id}/cancel

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

Path parameters

---

response_id string Required
The ID of the response to cancel.

Returns

---

A Response object.

Returns the Response object.

Example

curl -X POST https://api.fastapi.ai/v1/responses/resp_123/cancel \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FAST_API_KEY"