Get a preview output

Retrieve a public preview playlist or timeline, or redirect to its poster. Follow the URLs returned by the Asset API. No API token is required. Signed media URLs expire within one hour; reload to refresh them.

GET

/assets/{assetId}/preview/{objectPath}

Path Parameters

assetId

string

required

Asset ID from the Asset API.

objectPath

string

required

Recorded rendition playlist, poster, or timeline VTT path relative to the Asset prefix. May contain slash-separated path segments. Raw video and arbitrary storage paths are not accepted.

Responses

application/vnd.apple.mpegurl

text/vtt

Rewritten HLS rendition playlist or timeline WebVTT. Media URLs are presigned storage URLs; byte ranges and sprite coordinates are preserved.

Poster redirect to a temporary signed storage URL. The response body is empty.

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Asset unavailable, preview disabled, expired, deleted, or output not recorded.

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Preview rate limit exceeded.

application/json

error

object

required

status

"error"

string

required

Preview storage or playlist processing failed.

curl 'https://stream.chunkify.dev/ast_example/thumbnails/images.vtt'

#EXTM3U
#EXT-X-VERSION:7
#EXT-X-MAP:URI="https://storage.example/video.mp4?signature=example",BYTERANGE="32@0"
#EXTINF:4,
#EXT-X-BYTERANGE:1000@32
https://storage.example/video.mp4?signature=example
#EXT-X-ENDLIST
WEBVTT

00:00:00.000 --> 00:00:04.000
https://storage.example/sprite-00000.jpg?signature=example#xywh=0,0,256,144
No content
{
  "error": {
    "code": 404,
    "message": "Ressource not found",
    "type": "NotFoundError"
  },
  "status": "error"
}
{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded",
    "type": "TooManyRequestsError"
  },
  "status": "error"
}
{
  "error": {
    "code": 500,
    "message": "Internal server error",
    "type": "UnexpectedError"
  },
  "status": "error"
}

# Get a preview output > Retrieve a public preview playlist or timeline, or redirect to its poster. Follow the URLs returned by the Asset API. No API token is required. Signed media URLs expire within one hour; reload to refresh them. ```json { "path": "/assets/{assetId}/preview/{objectPath}", "method": "get", "schema": { "description": "Retrieve a public preview playlist or timeline, or redirect to its poster. Follow the URLs returned by the Asset API. No API token is required. Signed media URLs expire within one hour; reload to refresh them.", "operationId": "getAssetPreviewObject", "parameters": [ { "description": "Asset ID from the Asset API.", "in": "path", "name": "assetId", "required": true, "schema": { "type": "string" } }, { "description": "Recorded rendition playlist, poster, or timeline VTT path relative to the Asset prefix. May contain slash-separated path segments. Raw video and arbitrary storage paths are not accepted.", "in": "path", "name": "objectPath", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.apple.mpegurl": { "example": "#EXTM3U\n#EXT-X-VERSION:7\n#EXT-X-MAP:URI=\"https://storage.example/video.mp4?signature=example\",BYTERANGE=\"32@0\"\n#EXTINF:4,\n#EXT-X-BYTERANGE:1000@32\nhttps://storage.example/video.mp4?signature=example\n#EXT-X-ENDLIST\n", "schema": { "type": "string" } }, "text/vtt": { "example": "WEBVTT\n\n00:00:00.000 --\u003e 00:00:04.000\nhttps://storage.example/sprite-00000.jpg?signature=example#xywh=0,0,256,144\n", "schema": { "type": "string" } } }, "description": "Rewritten HLS rendition playlist or timeline WebVTT. Media URLs are presigned storage URLs; byte ranges and sprite coordinates are preserved.", "headers": { "Access-Control-Allow-Origin": { "schema": { "const": "*", "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } } } }, "307": { "description": "Poster redirect to a temporary signed storage URL. The response body is empty.", "headers": { "Access-Control-Allow-Origin": { "schema": { "const": "*", "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Location": { "description": "Presigned GET URL for the recorded poster.", "schema": { "format": "uri", "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorNotFound" } } }, "description": "Asset unavailable, preview disabled, expired, deleted, or output not recorded." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorTooManyRequests" } } }, "description": "Preview rate limit exceeded." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorUnexpected" } } }, "description": "Preview storage or playlist processing failed." } }, "security": [], "summary": "Get a preview output", "tags": [ "Assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "curl 'https://stream.chunkify.dev/ast_example/thumbnails/images.vtt'" } ] } } ``` ```json #/components/schemas/ResponseErrorNotFound { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 404, "description": "Code is the HTTP status code", "examples": [ 404 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Ressource not found" ], "type": "string" }, "type": { "const": "NotFoundError", "description": "Type indicates the error category", "enum": [ "NotFoundError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorTooManyRequests { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 429, "description": "Code is the HTTP status code", "examples": [ 429 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Rate limit exceeded" ], "type": "string" }, "type": { "const": "TooManyRequestsError", "description": "Type indicates the error category", "enum": [ "TooManyRequestsError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorUnexpected { "description": "Unexpected preview processing or storage failure.", "properties": { "error": { "properties": { "code": { "const": 500, "type": "integer" }, "message": { "examples": [ "Internal server error" ], "type": "string" }, "type": { "const": "UnexpectedError", "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ```