Cancel an in-progress response

POST/v1/responses/{responseId}/cancel

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

responseId (path) *

Request Body (JSON)

Parameters

Name	In	Type	Required	Description
`responseId`	path	`string`	Yes	The response ID to cancel

Request Body

Responses

200 Cancelled response

Property	Type	Description
`success`	`boolean`
`response`	`object`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/openai/v1/responses/{responseId}/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/openai/v1/responses/{responseId}/cancel", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/openai/v1/responses/{responseId}/cancel",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "success": true,
  "response": {
    "id": "string",
    "object": "string",
    "createdAt": "string",
    "status": "string",
    "error": {
      "code": "string",
      "message": "string"
    },
    "incompleteDetails": {
      "reason": "string"
    },
    "model": "string",
    "output": [
      {
        "id": "string",
        "type": "string",
        "status": "string",
        "role": "ROLE_UNSPECIFIED",
        "content": [],
        "callId": "string",
        "name": "string",
        "arguments": "string",
        "output": "string"
      }
    ],
    "usage": {
      "inputTokens": 0,
      "outputTokens": 0,
      "totalTokens": 0,
      "inputTokensDetails": {
        "cachedTokens": 0,
        "textTokens": 0,
        "audioTokens": 0,
        "imageTokens": 0,
        "reasoningTokens": 0,
        "cacheWriteTokens": 0
      },
      "outputTokensDetails": {
        "cachedTokens": 0,
        "textTokens": 0,
        "audioTokens": 0,
        "imageTokens": 0,
        "reasoningTokens": 0,
        "cacheWriteTokens": 0
      }
    },
    "temperature": 0,
    "topP": 0,
    "maxOutputTokens": 0,
    "previousResponseId": "string",
    "reasoning": {
      "effort": "string",
      "generateSummary": "string"
    },
    "truncation": {
      "type": "string",
      "lastMessages": 0
    }
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}