Get the session's video recording
Returns signed URLs for the recording’s MP4 segments, in order.
URLs expire at each segment’s expires_at (Unix seconds); fetch
this endpoint again for fresh ones.
recording_status is always present:
absent: the session has no recording.pending: the recording is still being finalized. Poll again.complete: finished. Whendatais present it is alwayscomplete.failed: finalization failed;recording_status_reasonsays why.
data is null until there is playable media. A recording follows
the workspace’s history window: past it, 402 with
reason: "history_window", unless the plan includes video replay
or the recording was made on a paid Lusor Phone plan.
curl --request GET \
--url https://api.lusor.ai/v1/sessions/{id}/recording \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.lusor.ai/v1/sessions/{id}/recording', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.lusor.ai/v1/sessions/{id}/recording"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"status": "complete",
"stop_reason": "<string>",
"started_at_ms": 123,
"duration_ms": 123,
"segments": [
{
"url": "<string>",
"start_offset_ms": 123,
"duration_ms": 123,
"width": 123,
"height": 123,
"expires_at": 123
}
]
},
"recording_status": "absent",
"recording_status_reason": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Workspace API key, created in the dashboard under Settings → API Keys.
Path Parameters
Session ID.
Query Parameters
Workspace the request is scoped to. Optional for API keys: a key is bound to one workspace when it is created, and naming any other workspace returns an opaque 404.
Response
Recording state, and its segments when playable
The playable recording, or null when there is none to play yet.
Show child attributes
Show child attributes
absent: no recording. pending: still being finalized; poll again.
complete: finished. failed: finalization failed.
absent, pending, complete, failed Why finalization failed. Present only when data is null.
Was this page helpful?
curl --request GET \
--url https://api.lusor.ai/v1/sessions/{id}/recording \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.lusor.ai/v1/sessions/{id}/recording', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.lusor.ai/v1/sessions/{id}/recording"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"status": "complete",
"stop_reason": "<string>",
"started_at_ms": 123,
"duration_ms": 123,
"segments": [
{
"url": "<string>",
"start_offset_ms": 123,
"duration_ms": 123,
"width": 123,
"height": 123,
"expires_at": 123
}
]
},
"recording_status": "absent",
"recording_status_reason": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}