responses
Cancel a response
GoModel API reference for POST /v1/responses//cancel: Cancel a response.
POST
{base_url}
/
v1
/
responses
/
{id}
/
cancel
Error
A valid request URL is required to generate request examples{
"created_at": 123,
"error": {
"code": "<string>",
"message": "<string>"
},
"id": "<string>",
"model": "<string>",
"object": "<string>",
"output": [
{
"arguments": "<string>",
"call_id": "<string>",
"content": [
{
"annotations": [
{}
],
"file_data": "<string>",
"file_id": "<string>",
"file_url": "<string>",
"filename": "<string>",
"image_url": {
"detail": "<string>",
"media_type": "<string>",
"url": "<string>"
},
"input_audio": {
"data": "<string>",
"format": "<string>"
},
"text": "<string>",
"type": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"role": "<string>",
"status": "<string>",
"type": "<string>",
"extra_content": {}
}
],
"previous_response_id": "<string>",
"provider": "<string>",
"status": "<string>",
"usage": {
"completion_tokens_details": {
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"reasoning_tokens": 123,
"rejected_prediction_tokens": 123
},
"input_tokens": 123,
"output_tokens": 123,
"prompt_tokens_details": {
"audio_tokens": 123,
"cached_tokens": 123,
"image_tokens": 123,
"text_tokens": 123
},
"raw_usage": {},
"total_tokens": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response ID
Query Parameters
Provider override for native cancellation
Response
OK
Show child attributes
Show child attributes
"response"
Show child attributes
Show child attributes
PreviousResponseID names the response this one was chained from, as OpenAI echoes it; stored snapshots follow it to rebuild the history.
"completed", "failed", "in_progress"
Show child attributes
Show child attributes
Last modified on September 12, 2026
Was this page helpful?
⌘I
Error
A valid request URL is required to generate request examples{
"created_at": 123,
"error": {
"code": "<string>",
"message": "<string>"
},
"id": "<string>",
"model": "<string>",
"object": "<string>",
"output": [
{
"arguments": "<string>",
"call_id": "<string>",
"content": [
{
"annotations": [
{}
],
"file_data": "<string>",
"file_id": "<string>",
"file_url": "<string>",
"filename": "<string>",
"image_url": {
"detail": "<string>",
"media_type": "<string>",
"url": "<string>"
},
"input_audio": {
"data": "<string>",
"format": "<string>"
},
"text": "<string>",
"type": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"role": "<string>",
"status": "<string>",
"type": "<string>",
"extra_content": {}
}
],
"previous_response_id": "<string>",
"provider": "<string>",
"status": "<string>",
"usage": {
"completion_tokens_details": {
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"reasoning_tokens": 123,
"rejected_prediction_tokens": 123
},
"input_tokens": 123,
"output_tokens": 123,
"prompt_tokens_details": {
"audio_tokens": 123,
"cached_tokens": 123,
"image_tokens": 123,
"text_tokens": 123
},
"raw_usage": {},
"total_tokens": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"type": "provider_error",
"provider": "<string>"
}
}