v4

latestOpenAPI 3.1.02026-08-086635375.7 KB
Sessions

stop session

Force-terminates a running session. The engine hosting the session disconnects the client and shuts the session down immediately.

Termination is asynchronous on the engine side: the session's endTime, exit status and session report are delivered through the normal end-of-session flow shortly after the stop, so the session may briefly still appear active on GET /v1/sessions/{id}.

Sessions that never reached an engine, or that run over the LiveKit or Agora integrations, have no engine host to terminate and return 404. If the engine rejects the stop (for example the session has already ended), the engine's error status is passed through.

post/v1/sessions/{id}/stop

Path parameters

idstring uuid required

Session ID

Response

The engine accepted the stop request

object required