stop session
Changed onForce-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}.
Stopping a session that has already ended returns 200 without contacting the engine, so repeating a stop is safe. That includes a session whose end reaches Lab while the stop is in flight.
Running 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 does not confirm the stop of a running session, the request fails with 502.
Request
- Base URLhttps://api.anam.ai
- URLhttps://api.anam.ai/v1/sessions/{id}/stop
- AuthHTTP bearer
Path parameters
Session ID
Response
The engine accepted the stop request, or the session had already ended
Changes
- info
added the non-success response with the status
- info
- info
added the non-success response with the status
- info