IntegrationsOpenaiActions
Cancel OpenAI response
Cancel an in-progress OpenAI Responses API response.
responses.cancel · OpenAI · v1
Details
Scopes
None
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
response_id | string | Yes | minLength 1; maxLength 200 |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
id | string | Yes | minLength 1; maxLength 200 |
status | string | Yes | minLength 1; maxLength 64 |
output_text | string | Yes | maxLength 100000 |
refused | boolean | Yes | — |
refusal | string | No | maxLength 2000 |
incomplete_reason | string | No | maxLength 200 |
model | string | No | minLength 1; maxLength 200 |
usage | object | No | additionalProperties false |
usage.input_tokens | integer | No | — |
usage.output_tokens | integer | No | — |
usage.total_tokens | integer | No | — |
usage.prompt_tokens | integer | No | — |
error | object | No | additionalProperties false |
error.code | string | No | maxLength 200 |
error.message | string | No | maxLength 2000 |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"response_id": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"response_id"
]
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"output_text": {
"type": "string",
"maxLength": 100000
},
"refused": {
"type": "boolean"
},
"refusal": {
"type": "string",
"maxLength": 2000
},
"incomplete_reason": {
"type": "string",
"maxLength": 200
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"usage": {
"type": "object",
"additionalProperties": false,
"properties": {
"input_tokens": {
"type": "integer"
},
"output_tokens": {
"type": "integer"
},
"total_tokens": {
"type": "integer"
},
"prompt_tokens": {
"type": "integer"
}
}
},
"error": {
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"maxLength": 200
},
"message": {
"type": "string",
"maxLength": 2000
}
}
}
},
"required": [
"id",
"status",
"output_text",
"refused"
]
}