runs

Get a recording URL

Check recording availability and obtain a short-lived playback URL when it is ready.

get/api/v1/runs/{run_id}/recording

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/runs/{run_id}/recording
  • Auth: HTTP bearer

Path parameters

run_idstring uuid required

Response

Get a short-lived recording URL

run_idstring uuid required
state'pending' | 'recording' | 'processing' | 'ready' | 'partial' | 'failed' | 'not_required' | 'expired' required
urlstring uri nullable required

Link to play or share the recording: a signed URL, or the agent's unsigned public link when it opted out of signed URLs

url_expires_atstring date-time nullable required
media_urlstring uri nullable required

Direct signed URL of the recording bytes, for your own clients to read the audio (for example to draw a waveform): valid for at most five minutes and pinned to the recorded version. Do not share it; read runs.recording again for a fresh one when it expires

media_url_expires_atstring date-time nullable required

When media_url stops working

Changes

No recorded changes to this operation across all 1 revision of this API.