End an embed session

DELETE /v1/embed-sessions/{id}

Ends the session at once, for example when the person using your page signs out. The embed asks for a new token the next time it needs one.

Authentication

Send Authorization: Bearer $KEY from your server. Create or rotate keys.

Example request

bash
curl -X DELETE https://play.fellowverse.app/v1/embed-sessions/es_Hk3vQ9xTmP2a \
  -H "Authorization: Bearer $KEY"

Example IDs are placeholders. Use the IDs from your own requests.

Parameters

Name In Required Type Description and constraints
id path Yes string The session's id.

Responses

Status Meaning
204 The session has ended.
401 The key is missing, wrong, revoked, or past the end of its grace period after a roll. The code is api_unauthorized, and the reason says which.
403 The account is suspended (api_suspended), or a live key was used on an account that has test keys only (api_live_locked).
500 Something went wrong on our side. The code is internal.

Errors and limits

JSON errors contain error.code, error.problem, error.reason and error.fix. Handle errors and retries and check test and live limits.


Need the contract? Download OpenAPI. Manage keys and account access in the developer console.

Start here · Guides · API reference