Get Recap
curl --request GET \
--url https://api.narrative-sports.com/v1/recaps/{recap_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.narrative-sports.com/v1/recaps/{recap_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.narrative-sports.com/v1/recaps/{recap_id}', 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.narrative-sports.com/v1/recaps/{recap_id}",
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.narrative-sports.com/v1/recaps/{recap_id}"
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))
}HttpResponse<String> response = Unirest.get("https://api.narrative-sports.com/v1/recaps/{recap_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.narrative-sports.com/v1/recaps/{recap_id}")
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{
"id": 123,
"status": "<string>",
"project_id": 123,
"name": "<string>",
"editor_project_id": "<string>",
"target_duration_seconds": 123,
"render_video": "<string>",
"exclude_event_types": [
"<string>"
],
"video_url": "<string>",
"otio_timeline": {},
"duration": 123,
"num_clips": 123,
"selected_edit_ids": [
"<string>"
],
"render_job_id": "<string>",
"thumbnail_url": "<string>",
"failure_reason": "<string>",
"task_id": "<string>",
"created_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Recaps
Get Recap
Get details of a game recap
GET
/
v1
/
recaps
/
{recap_id}
Get Recap
curl --request GET \
--url https://api.narrative-sports.com/v1/recaps/{recap_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.narrative-sports.com/v1/recaps/{recap_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.narrative-sports.com/v1/recaps/{recap_id}', 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.narrative-sports.com/v1/recaps/{recap_id}",
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.narrative-sports.com/v1/recaps/{recap_id}"
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))
}HttpResponse<String> response = Unirest.get("https://api.narrative-sports.com/v1/recaps/{recap_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.narrative-sports.com/v1/recaps/{recap_id}")
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{
"id": 123,
"status": "<string>",
"project_id": 123,
"name": "<string>",
"editor_project_id": "<string>",
"target_duration_seconds": 123,
"render_video": "<string>",
"exclude_event_types": [
"<string>"
],
"video_url": "<string>",
"otio_timeline": {},
"duration": 123,
"num_clips": 123,
"selected_edit_ids": [
"<string>"
],
"render_job_id": "<string>",
"thumbnail_url": "<string>",
"failure_reason": "<string>",
"task_id": "<string>",
"created_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Overview
Retrieve the current status and details of a game recap. Poll this endpoint after creating a recap to check processing status. The response includesotio_timeline once clip selection has completed. When render_video is "ffmpeg", video_url is added after rendering completes.
Request
curl -X GET "https://api.narrative-sports.com/v1/recaps/43" \
-H "Authorization: Bearer YOUR_API_KEY"
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
recap_id | integer | Yes | The recap ID |
Response
{
"id": 43,
"status": "complete",
"project_id": 1,
"target_duration_seconds": 60,
"render_video": "ffmpeg",
"exclude_event_types": ["kickoff", "final_whistle", "player_walk_on"],
"video_url": "https://cdn.narrative-sports.com/recaps/43/recap.mp4?X-Goog-Signature=...",
"otio_timeline": {
"OTIO_SCHEMA": "Timeline.1",
"name": "Highlight package (3 clips)"
},
"duration": 58.2,
"num_clips": 3,
"selected_edit_ids": ["edit-1", "edit-2", "edit-3"],
"thumbnail_url": "https://cdn.narrative-sports.com/recaps/43/thumbnail.jpg?X-Goog-Signature=...",
"created_at": "2025-01-15T14:00:00Z"
}
Response Fields
| Field | Type | Description |
|---|---|---|
id | integer | Recap ID |
status | string | "queued", "processing", "complete", or "failed" |
project_id | integer | Project this recap was created from |
target_duration_seconds | integer | Requested target duration |
render_video | string | "ffmpeg" or "none" |
exclude_event_types | string[]? | Event types excluded from selection |
video_url | string? | Signed download URL for the rendered video when render_video is "ffmpeg" and rendering is complete |
otio_timeline | object? | Merged OTIO Timeline.1 EDL built from selected highlights’ otio_edit. Present after clip selection succeeds; null while queued/processing or when creation failed. See OTIO Format. |
duration | float? | Actual duration of the recap in seconds |
num_clips | integer? | Number of highlight clips selected |
selected_edit_ids | string[]? | IDs of the highlights selected for the recap; each package OTIO clip includes a matching metadata.edit_id |
thumbnail_url | string? | Signed thumbnail image URL |
failure_reason | string? | Error description when status is "failed" |
task_id | string? | Background task ID |
created_at | string? | ISO 8601 creation timestamp |
Errors
| Status | Description |
|---|---|
401 | Invalid or missing API key |
404 | Recap not found or does not belong to the authenticated customer |
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Success

