Getting started

Introduction

PreviewAPI turns URLs into hosted screenshot images through a small JSON API. You submit a capture job, poll its status, and read the final image URL. There are no browsers to run, no queues to manage, and no image storage to provision.

not callable yet

Direct API access is not open during the beta. API keys created in the dashboard authenticate nothing — no request anywhere is accepted with one — and screenshots are captured from the dashboard instead.

These pages describe the capture service the dashboard talks to. Read every request below as the shape of the interface that will open, not as a call you can make today.

BASE URL

https://api.previewapi.dev/api/v1

Reachable by the PreviewAPI dashboard only while the beta runs.

Endpoints

POST/screenshotsCreate a screenshot job

GET/screenshots/{job_uuid}Check job status

DEL/screenshots/{job_uuid}Delete a screenshot

Job lifecycle

Every job moves through a fixed set of states. Poll the status endpoint until it reaches a terminal state.

queued→processing→completedorfailed

A completed job consumes one credit and returns a hosted image URL. A failed job is refunded automatically during beta.

Authentication →