Extract Metadata
curl --request POST \
--url https://api.usenarrative.ai/api/v1/sports/extract-metadata \
--header 'Content-Type: multipart/form-data' \
--form 'roi_config={}' \
--form 'output_schema={}' \
--form video='@example-file' \
--form 'video_url=<string>' \
--form skip_frames=2import requests
url = "https://api.usenarrative.ai/api/v1/sports/extract-metadata"
files = { "video": ("example-file", open("example-file", "rb")) }
payload = {
"roi_config": "{}",
"output_schema": "{}",
"video_url": "<string>",
"skip_frames": "2"
}
response = requests.post(url, data=payload, files=files)
print(response.text)const form = new FormData();
form.append('roi_config', '{}');
form.append('output_schema', '{}');
form.append('video', '<string>');
form.append('video_url', '<string>');
form.append('skip_frames', '2');
const options = {method: 'POST'};
options.body = form;
fetch('https://api.usenarrative.ai/api/v1/sports/extract-metadata', 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.usenarrative.ai/api/v1/sports/extract-metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"roi_config\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_schema\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_frames\"\r\n\r\n2\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.usenarrative.ai/api/v1/sports/extract-metadata"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"roi_config\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_schema\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_frames\"\r\n\r\n2\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.usenarrative.ai/api/v1/sports/extract-metadata")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"roi_config\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_schema\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_frames\"\r\n\r\n2\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenarrative.ai/api/v1/sports/extract-metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"roi_config\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_schema\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_frames\"\r\n\r\n2\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"task_id": "task_abc123xyz",
"status": "pending",
"created_at": "2024-01-15T10:30:00Z"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Metadata Extraction
Extract Metadata
Start async task to extract structured metadata from video
POST
/
api
/
v1
/
sports
/
extract-metadata
Extract Metadata
curl --request POST \
--url https://api.usenarrative.ai/api/v1/sports/extract-metadata \
--header 'Content-Type: multipart/form-data' \
--form 'roi_config={}' \
--form 'output_schema={}' \
--form video='@example-file' \
--form 'video_url=<string>' \
--form skip_frames=2import requests
url = "https://api.usenarrative.ai/api/v1/sports/extract-metadata"
files = { "video": ("example-file", open("example-file", "rb")) }
payload = {
"roi_config": "{}",
"output_schema": "{}",
"video_url": "<string>",
"skip_frames": "2"
}
response = requests.post(url, data=payload, files=files)
print(response.text)const form = new FormData();
form.append('roi_config', '{}');
form.append('output_schema', '{}');
form.append('video', '<string>');
form.append('video_url', '<string>');
form.append('skip_frames', '2');
const options = {method: 'POST'};
options.body = form;
fetch('https://api.usenarrative.ai/api/v1/sports/extract-metadata', 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.usenarrative.ai/api/v1/sports/extract-metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"roi_config\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_schema\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_frames\"\r\n\r\n2\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.usenarrative.ai/api/v1/sports/extract-metadata"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"roi_config\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_schema\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_frames\"\r\n\r\n2\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.usenarrative.ai/api/v1/sports/extract-metadata")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"roi_config\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_schema\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_frames\"\r\n\r\n2\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenarrative.ai/api/v1/sports/extract-metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"roi_config\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_schema\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_frames\"\r\n\r\n2\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"task_id": "task_abc123xyz",
"status": "pending",
"created_at": "2024-01-15T10:30:00Z"
}{
"detail": "<string>"
}{
"detail": "<string>"
}POST /api/v1/sports/extract-metadata
Start an async task to extract structured metadata from video using ROI configuration. Returns a task ID for polling. This is an asynchronous endpoint - use the task ID to poll for results.Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| video | File | No* | Video file to process |
| video_url | URL | No* | URL to video file |
| roi_config | object | Yes | ROI configuration from detect-rois endpoint |
| output_schema | object | Yes | JSON Schema defining the event structure to extract |
| skip_frames | integer | No | Process every Nth frame (default: 2) |
video or video_url is required.
Response
| Field | Description |
|---|---|
| task_id | Unique identifier for polling |
| status | Initial status (pending) |
| created_at | When the task was created |
Example Request
curl -X POST https://api.usenarrative.ai/api/v1/sports/extract-metadata \
-H "Content-Type: multipart/form-data" \
-F "video=@football_game.mp4" \
-F 'roi_config={
"play_clock": {"y_min": 45, "x_min": 580, "y_max": 75, "x_max": 640},
"game_clock": {"y_min": 45, "x_min": 480, "y_max": 75, "x_max": 560},
"home_score": {"y_min": 45, "x_min": 200, "y_max": 75, "x_max": 250},
"away_score": {"y_min": 45, "x_min": 300, "y_max": 75, "x_max": 350}
}' \
-F 'output_schema={
"type": "object",
"properties": {
"event_type": {"type": "string", "enum": ["play_start", "play_end", "score_change"]},
"timestamp_sec": {"type": "number"},
"game_clock": {"type": "string"},
"home_score": {"type": "integer"},
"away_score": {"type": "integer"}
}
}'
Example Response
{
"task_id": "task_abc123xyz",
"status": "pending",
"created_at": "2024-01-15T10:30:00Z"
}
Next Step
Poll the task status usingGET /api/v1/sports/extract-metadata/{task_id}:
curl https://api.usenarrative.ai/api/v1/sports/extract-metadata/task_abc123xyz
Get Metadata Task
Poll task status and retrieve results
Body
multipart/form-data
ROI configuration from detect-rois endpoint
Show child attributes
Show child attributes
JSON Schema defining the structure of events to extract
Video file to process
Alternative: URL to video file
Process every Nth frame for faster processing
Example:
2

