OpenAI/CancelChatSessionMethod

Online calls unavailable · details below

OpenAIOpenAI API

POST/chatkit/sessions/{session_id}/cancel

Manage Cancel Chat Session Method.

Contract-preserving POST Endpoint for Cancel Chat Session Method 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
CancelChatSessionMethod
Server
https://api.openai.com/v1
Authentication
ApiKeyAuth, AdminApiKeyAuth

Request parameters

session_id

pathstringrequired

session id value in the OpenAI API contract.

cksess_123

Responses

200

ChatSessionResourceapplication/json

Successful supplier response.

Properties: chatkit_configurationclient_secretexpires_atidmax_requests_per_1_minuteobjectrate_limitsstatususerworkflow

{
  "chatkit_configuration": {
    "automatic_thread_titling": {
      "enabled": true
    },
    "file_upload": {
      "enabled": true,
      "max_file_size": 16,
      "max_files": 20
    },
    "history": {
      "enabled": true,
      "recent_threads": 10
    }
  },
  "client_secret": "ek_token_123",
  "expires_at": 1712349876,
  "id": "cksess_123",
  "max_requests_per_1_minute": 60,
  "object": "chatkit.session",
  "rate_limits": {
    "max_requests_per_1_minute": 60
  },
  "status": "cancelled",
  "user": "user_789",
  "workflow": {
    "id": "workflow_alpha",
    "version": "2024-10-01"
  }
}