OpenAI API (unofficial showcase)
POST/chatkit/sessions/{session_id}/cancel

Cancel a ChatKit session

Cancel an active ChatKit session and return its most recent metadata.

Cancelling prevents new requests from using the issued client secret.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
session_idstringrequired
Unique identifier for the ChatKit session to cancel.

4 status codes
200Success
idstringrequired
Identifier for the ChatKit session.
objectstringrequired
Type discriminator that is always `chatkit.session`.
Allowed:chatkit.sessionDefault:chatkit.session
expires_atintegerrequired
Unix timestamp (in seconds) for when the session expires.
client_secretstringrequired
Ephemeral client secret that authenticates session requests.
workflowobjectrequired
Workflow metadata for the session.
userstringrequired
User identifier associated with the session.
rate_limitsobjectrequired
Resolved rate limit values.
max_requests_per_1_minuteintegerrequired
Convenience copy of the per-minute request limit.
statusstringrequired
Current lifecycle state of the session.
Allowed:activeexpiredcancelled
chatkit_configurationobjectrequired
Resolved ChatKit feature configuration for the session.
400The request is invalid or the required ChatKit beta header is missing or invalid.
errorobjectrequired
404The session was not found or is not accessible.
errorobjectrequired
429The request rate limit has been exceeded.
errorobjectrequired

Error handling

A 400 is returned: The request is invalid or the required ChatKit beta header is missing or invalid. A 404 is returned: The session was not found or is not accessible. A 429 is returned: The request rate limit has been exceeded.