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.

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

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.

queuedprocessingcompletedorfailed

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