Skip to main content
GET
Get a Version's Preview

Authorizations

Authorization
string
header
required

Personal access token with the streams:read scope. Only needed for private projects.

Path Parameters

streamId
string
required

The project id.

commitId
string
required

The version id.

Query Parameters

postprocess
enum<string>

og returns a 1200×627 Open Graph image with the project name over the preview.

Available options:
og

Response

The preview: a PNG, or a WebM video for the spin key. A placeholder PNG when there is no preview yet.

The response is of type file.