Close a realtime session

DELETE

/v1/realtime/sessions/{session_id}

Idempotently closes the session, clears temporary credentials, and releases account capacity.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Realtime session closed

Bodyapplication/json

🟠404

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://api.beatapi.io/v1/realtime/sessions/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": {
        "id": "string",
        "object": "realtime.session",
        "status": "ready",
        "client_secret": "string",
        "expires_at": "2019-08-24T14:15:22.123Z",
        "max_duration_seconds": 15,
        "allowed_origins": [
            "http://example.com"
        ],
        "credits": {
            "reserved": 0,
            "settled": 0,
            "refunded": 0
        },
        "request_id": "string",
        "created_at": "2019-08-24T14:15:22.123Z",
        "connected_at": "2019-08-24T14:15:22.123Z",
        "closed_at": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-07-31 15:09:00

Get a realtime session