Get a recording playlist

Returns an HLS VOD playlist (.m3u8) for a recorded session. Each segment URL is presigned and fetched directly from storage. A session is recorded when its model turns recording on (runtime.recording in its reactor.yaml); for any other session the answer is 404.

start and end select a window in seconds. Without start, the playlist begins at the start of the recording; without end, it runs to the last uploaded segment. One request returns at most 10,000 segments, so a longer window is shortened rather than refused. A segment that could not be recorded appears as an #EXT-X-GAP entry, so the timeline stays intact.

While the session runs, a window the recording has not reached yet answers 202. The recording advances with the model’s output, not with time. About 15 minutes after the session closes, the same request answers 200 or 410, so polling always ends.

Callable by a developer, account_admin, or user of the account that ran the session or of the account that owns the model; billing_admin is not allowed. A session token reads only the sessions bound to it, open or closed. Bind a session before it ends, or read with an API key.

GET

clips

Get a recording playlist

curl --request GET \
  --url https://api.reactor.inc/clips \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.reactor.inc/clips', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.reactor.inc/clips",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.reactor.inc/clips"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.reactor.inc/clips")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"#EXTM3U\n#EXT-X-VERSION:7\n#EXT-X-TARGETDURATION:10\n#EXT-X-PLAYLIST-TYPE:VOD\n#EXT-X-MAP:URI=\"https://storage.example.com/chunks/init.mp4?signature=abc\"\n#EXTINF:10.000,\nhttps://storage.example.com/chunks/12.m4s?signature=def\n#EXT-X-GAP\n#EXTINF:10.000,\ngap-13.m4s\n#EXTINF:10.000,\nhttps://storage.example.com/chunks/14.m4s?signature=ghi\n#EXT-X-ENDLIST\n"

{
  "status": "recording_in_progress",
  "message": "the recording has not reached this range yet; retry after Retry-After"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "recording_range_not_recorded",
  "message": "the recording ended before this range"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

Authorizations

Authorization

string

header

required

A Reactor API key (rk_...), sent as Authorization: Bearer rk_.... Keep it on a server.

Query Parameters

session_id

string<uuid>

required

The recorded session's ID.

start

number

Start of the window in seconds, at least 0. Defaults to the start of the recording.

Required range: x >= 0

end

number

End of the window in seconds; greater than start when both are set. Defaults to the end of the uploaded recording.

Required range: x >= 0

Response

The playlist.

The response is of type string.

⌘I

Get a recording playlist

curl --request GET \
  --url https://api.reactor.inc/clips \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.reactor.inc/clips', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.reactor.inc/clips",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.reactor.inc/clips"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.reactor.inc/clips")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"#EXTM3U\n#EXT-X-VERSION:7\n#EXT-X-TARGETDURATION:10\n#EXT-X-PLAYLIST-TYPE:VOD\n#EXT-X-MAP:URI=\"https://storage.example.com/chunks/init.mp4?signature=abc\"\n#EXTINF:10.000,\nhttps://storage.example.com/chunks/12.m4s?signature=def\n#EXT-X-GAP\n#EXTINF:10.000,\ngap-13.m4s\n#EXTINF:10.000,\nhttps://storage.example.com/chunks/14.m4s?signature=ghi\n#EXT-X-ENDLIST\n"

{
  "status": "recording_in_progress",
  "message": "the recording has not reached this range yet; retry after Retry-After"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "recording_range_not_recorded",
  "message": "the recording ended before this range"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "reason": "<string>"
}

Get started

SDK Reference

CLI Reference

Platform API Reference

Endpoints

Get a recording playlist

Authorizations

Query Parameters

Response