Session Recording API

Retrieves the session recording, converts it to MP4 using specified compression type (lossless or compressed), and returns it as a downloadable binary. Requires the path parameter id and query parameter compressionType. Returns 200 for success (MP4 with Content-Disposition), or 400, 404, and 503 on errors.

Table 1. GET /ondemand/api/sessions/{id}/recording
Property Description
Summary Fetch Session Recording.
Description Retrieves the recording file, converts it to MP4 based on the chosen compression, and provides it as a downloadable binary.
Path Parameters
id (String, Required)
The unique identifier of the session.
Query Parameters
compressionType (String, Required)
Type of compression (lossless or compressed).
Responses
  • 200 OK: Returns an MP4 file (binary file).
    • Header: Content-Disposition: attachment; filename="session_1234_recording.mp4"
  • 400 Bad Request: Invalid session ID or compression type.
  • 404 Not Found: No recording file found.
  • 503 Service Unavailable: Recording conversion service is down.