OpenAI/beta_cancelResponse

Online calls unavailable · details below

OpenAIOpenAI API

POST/responses/{response_id}/cancel?beta=true

Manage beta cancel Response.

Contract-preserving POST Endpoint for beta cancel Response in the OpenAI API. Model and resource-specific values are supplied by the caller at runtime.

All 288 OpenAI Platform REST endpoints from a fixed MIT-licensed official revision, including typed SSE streaming and Realtime call management. Hub provides documentation and an independent SDK/CLI, but never proxies model, account, or usage data; callers connect directly with local API keys.

Request

operationId
beta_cancelResponse
Server
https://api.openai.com/v1
Authentication
ApiKeyAuth, AdminApiKeyAuth

Request parameters

response_id

pathstringrequired

response id value in the OpenAI API contract.

resp_677efb5139a88190b512bc3fef8e535d

openai-beta

headerarray

openai beta value in the OpenAI API contract.

Responses

200

BetaResponseapplication/json

Successful supplier response.

404

BetaErrorapplication/json

Supplier response with HTTP status 404.

Properties: codemessageparamtype

429

ErrorResponseapplication/json

Supplier response with HTTP status 429.

Properties: error

{
  "completed_at": 1741476778,
  "created_at": 1741476777,
  "error": null,
  "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "metadata": {},
  "model": "gpt-4o-2024-08-06",
  "object": "response",
  "output": [
    {
      "content": [
        {
          "annotations": [],
          "text": "The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.",
          "type": "output_text"
        }
      ],
      "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",
      "role": "assistant",
      "status": "completed",
      "type": "message"
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "context": null,
    "effort": null,
    "summary": null
  },
  "status": "completed",
  "store": true,
  "temperature": 1,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [],
  "top_p": 1,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 328,
    "input_tokens_details": {
      "cache_write_tokens": 0,
      "cached_tokens": 0
    },
    "output_tokens": 52,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 380
  },
  "user": null
}