Preview or validate the project head
curl --request POST \
--url https://api.framelane.io/v1/projects/{project_id}/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"at": 1,
"window": {
"from": 1,
"to": 123
},
"contact_sheet": {
"detail": "balanced",
"columns": 6,
"max_cells": 32
},
"width": 1928,
"dry_run": false,
"target_duration_sec": 1,
"target_tolerance_sec": 0.5
}
'import requests
url = "https://api.framelane.io/v1/projects/{project_id}/preview"
payload = {
"at": 1,
"window": {
"from": 1,
"to": 123
},
"contact_sheet": {
"detail": "balanced",
"columns": 6,
"max_cells": 32
},
"width": 1928,
"dry_run": False,
"target_duration_sec": 1,
"target_tolerance_sec": 0.5
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
at: 1,
window: {from: 1, to: 123},
contact_sheet: {detail: 'balanced', columns: 6, max_cells: 32},
width: 1928,
dry_run: false,
target_duration_sec: 1,
target_tolerance_sec: 0.5
})
};
fetch('https://api.framelane.io/v1/projects/{project_id}/preview', 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.framelane.io/v1/projects/{project_id}/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'at' => 1,
'window' => [
'from' => 1,
'to' => 123
],
'contact_sheet' => [
'detail' => 'balanced',
'columns' => 6,
'max_cells' => 32
],
'width' => 1928,
'dry_run' => false,
'target_duration_sec' => 1,
'target_tolerance_sec' => 0.5
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.framelane.io/v1/projects/{project_id}/preview"
payload := strings.NewReader("{\n \"at\": 1,\n \"window\": {\n \"from\": 1,\n \"to\": 123\n },\n \"contact_sheet\": {\n \"detail\": \"balanced\",\n \"columns\": 6,\n \"max_cells\": 32\n },\n \"width\": 1928,\n \"dry_run\": false,\n \"target_duration_sec\": 1,\n \"target_tolerance_sec\": 0.5\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.framelane.io/v1/projects/{project_id}/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"at\": 1,\n \"window\": {\n \"from\": 1,\n \"to\": 123\n },\n \"contact_sheet\": {\n \"detail\": \"balanced\",\n \"columns\": 6,\n \"max_cells\": 32\n },\n \"width\": 1928,\n \"dry_run\": false,\n \"target_duration_sec\": 1,\n \"target_tolerance_sec\": 0.5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.framelane.io/v1/projects/{project_id}/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"at\": 1,\n \"window\": {\n \"from\": 1,\n \"to\": 123\n },\n \"contact_sheet\": {\n \"detail\": \"balanced\",\n \"columns\": 6,\n \"max_cells\": 32\n },\n \"width\": 1928,\n \"dry_run\": false,\n \"target_duration_sec\": 1,\n \"target_tolerance_sec\": 0.5\n}"
response = http.request(request)
puts response.read_body{
"kind": "<string>",
"ok": true,
"violations": [
{
"code": "<string>",
"message": "<string>",
"severity": "error",
"path": "<string>",
"bbox": [
123
],
"time": 123
}
],
"job": {
"id": "render_01J8QR2K5VKDGN2T4FBM3CZYX7",
"kind": "render",
"workspace_id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_preview": false,
"task_type": "transcribe",
"progress_percent": 0,
"progress_stage": "compositing",
"output": {
"url": "https://cdn-user.framelane.io/render_01J.../output.mp4",
"width": 1920,
"height": 1080,
"duration": 15.3,
"size_bytes": 12582912
},
"result": {
"language_code": "en",
"text": "Welcome back to the show."
},
"error": {
"code": "invalid_source",
"message": "Source URL returned 404."
},
"metadata": {
"project_id": "proj_123",
"user_ref": "usr_abc"
},
"completed_at": "2023-11-07T05:31:56Z"
},
"sheet": {
"columns": 123,
"rows": 123,
"width": 123,
"window": {
"from": 1,
"to": 123
},
"cells": [
{
"index": 123,
"at": 123,
"reason": "first_frame"
}
]
}
}{
"kind": "<string>",
"ok": true,
"violations": [
{
"code": "<string>",
"message": "<string>",
"severity": "error",
"path": "<string>",
"bbox": [
123
],
"time": 123
}
],
"job": {
"id": "render_01J8QR2K5VKDGN2T4FBM3CZYX7",
"kind": "render",
"workspace_id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_preview": false,
"task_type": "transcribe",
"progress_percent": 0,
"progress_stage": "compositing",
"output": {
"url": "https://cdn-user.framelane.io/render_01J.../output.mp4",
"width": 1920,
"height": 1080,
"duration": 15.3,
"size_bytes": 12582912
},
"result": {
"language_code": "en",
"text": "Welcome back to the show."
},
"error": {
"code": "invalid_source",
"message": "Source URL returned 404."
},
"metadata": {
"project_id": "proj_123",
"user_ref": "usr_abc"
},
"completed_at": "2023-11-07T05:31:56Z"
},
"sheet": {
"columns": 123,
"rows": 123,
"width": 123,
"window": {
"from": 1,
"to": 123
},
"cells": [
{
"index": 123,
"at": 123,
"reason": "first_frame"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}Projects
Preview or validate the project head
Validate the project head cheaply, or preview it at a frame or window without a full render. Same free linter and faithful sliced preview as POST /v1/preview, against the stored head instead of an inline request.
POST
/
v1
/
projects
/
{project_id}
/
preview
Preview or validate the project head
curl --request POST \
--url https://api.framelane.io/v1/projects/{project_id}/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"at": 1,
"window": {
"from": 1,
"to": 123
},
"contact_sheet": {
"detail": "balanced",
"columns": 6,
"max_cells": 32
},
"width": 1928,
"dry_run": false,
"target_duration_sec": 1,
"target_tolerance_sec": 0.5
}
'import requests
url = "https://api.framelane.io/v1/projects/{project_id}/preview"
payload = {
"at": 1,
"window": {
"from": 1,
"to": 123
},
"contact_sheet": {
"detail": "balanced",
"columns": 6,
"max_cells": 32
},
"width": 1928,
"dry_run": False,
"target_duration_sec": 1,
"target_tolerance_sec": 0.5
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
at: 1,
window: {from: 1, to: 123},
contact_sheet: {detail: 'balanced', columns: 6, max_cells: 32},
width: 1928,
dry_run: false,
target_duration_sec: 1,
target_tolerance_sec: 0.5
})
};
fetch('https://api.framelane.io/v1/projects/{project_id}/preview', 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.framelane.io/v1/projects/{project_id}/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'at' => 1,
'window' => [
'from' => 1,
'to' => 123
],
'contact_sheet' => [
'detail' => 'balanced',
'columns' => 6,
'max_cells' => 32
],
'width' => 1928,
'dry_run' => false,
'target_duration_sec' => 1,
'target_tolerance_sec' => 0.5
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.framelane.io/v1/projects/{project_id}/preview"
payload := strings.NewReader("{\n \"at\": 1,\n \"window\": {\n \"from\": 1,\n \"to\": 123\n },\n \"contact_sheet\": {\n \"detail\": \"balanced\",\n \"columns\": 6,\n \"max_cells\": 32\n },\n \"width\": 1928,\n \"dry_run\": false,\n \"target_duration_sec\": 1,\n \"target_tolerance_sec\": 0.5\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.framelane.io/v1/projects/{project_id}/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"at\": 1,\n \"window\": {\n \"from\": 1,\n \"to\": 123\n },\n \"contact_sheet\": {\n \"detail\": \"balanced\",\n \"columns\": 6,\n \"max_cells\": 32\n },\n \"width\": 1928,\n \"dry_run\": false,\n \"target_duration_sec\": 1,\n \"target_tolerance_sec\": 0.5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.framelane.io/v1/projects/{project_id}/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"at\": 1,\n \"window\": {\n \"from\": 1,\n \"to\": 123\n },\n \"contact_sheet\": {\n \"detail\": \"balanced\",\n \"columns\": 6,\n \"max_cells\": 32\n },\n \"width\": 1928,\n \"dry_run\": false,\n \"target_duration_sec\": 1,\n \"target_tolerance_sec\": 0.5\n}"
response = http.request(request)
puts response.read_body{
"kind": "<string>",
"ok": true,
"violations": [
{
"code": "<string>",
"message": "<string>",
"severity": "error",
"path": "<string>",
"bbox": [
123
],
"time": 123
}
],
"job": {
"id": "render_01J8QR2K5VKDGN2T4FBM3CZYX7",
"kind": "render",
"workspace_id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_preview": false,
"task_type": "transcribe",
"progress_percent": 0,
"progress_stage": "compositing",
"output": {
"url": "https://cdn-user.framelane.io/render_01J.../output.mp4",
"width": 1920,
"height": 1080,
"duration": 15.3,
"size_bytes": 12582912
},
"result": {
"language_code": "en",
"text": "Welcome back to the show."
},
"error": {
"code": "invalid_source",
"message": "Source URL returned 404."
},
"metadata": {
"project_id": "proj_123",
"user_ref": "usr_abc"
},
"completed_at": "2023-11-07T05:31:56Z"
},
"sheet": {
"columns": 123,
"rows": 123,
"width": 123,
"window": {
"from": 1,
"to": 123
},
"cells": [
{
"index": 123,
"at": 123,
"reason": "first_frame"
}
]
}
}{
"kind": "<string>",
"ok": true,
"violations": [
{
"code": "<string>",
"message": "<string>",
"severity": "error",
"path": "<string>",
"bbox": [
123
],
"time": 123
}
],
"job": {
"id": "render_01J8QR2K5VKDGN2T4FBM3CZYX7",
"kind": "render",
"workspace_id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_preview": false,
"task_type": "transcribe",
"progress_percent": 0,
"progress_stage": "compositing",
"output": {
"url": "https://cdn-user.framelane.io/render_01J.../output.mp4",
"width": 1920,
"height": 1080,
"duration": 15.3,
"size_bytes": 12582912
},
"result": {
"language_code": "en",
"text": "Welcome back to the show."
},
"error": {
"code": "invalid_source",
"message": "Source URL returned 404."
},
"metadata": {
"project_id": "proj_123",
"user_ref": "usr_abc"
},
"completed_at": "2023-11-07T05:31:56Z"
},
"sheet": {
"columns": 123,
"rows": 123,
"width": 123,
"window": {
"from": 1,
"to": 123
},
"cells": [
{
"index": 123,
"at": 123,
"reason": "first_frame"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
The knobs shared by a standalone preview and a stored-project preview.
Everything except which composition to preview: an at frame or a
window clip (mutually exclusive), the draft width, dry_run for
validate-only, and an optional target-duration check.
Timeline seconds for a single-frame preview, snapped to the frame grid. Returns an unlabelled PNG, viewable inline via get_render_preview; a window preview is video and is not. Mutually exclusive with 'window' and 'contact_sheet'.
Required range:
x >= 0Time range for a short clip preview (with audio), or the range a contact_sheet spans.
Show child attributes
Show child attributes
Produce a contact sheet (grid of composition-aware frames) instead of a single frame or clip.
Show child attributes
Show child attributes
Preview width in px; height derives from the aspect ratio. Defaults to a small draft width.
Required range:
16 <= x <= 3840Validate only: run the linter and return violations, no render.
Optional target timeline length; emits TARGET_DURATION_MISSED when outside tolerance.
Required range:
x > 0Required range:
x >= 0Response
Validation result (dry-run).
'validation' (dry-run), 'frame', 'window', or 'contact_sheet'.
True when there are no error-severity violations.
Show child attributes
Show child attributes
For a pixel preview: the preview render job to poll via GET /v1/renders/{id} (is_preview=true, not billed). Absent for a dry-run.
Show child attributes
Show child attributes
For a contact_sheet: the sampling plan (cells + grid shape). Present even on a dry-run.
Show child attributes
Show child attributes