API Documentation

Overview

Use the Preflight API to generate screenshots and work with your account programmatically.

API requests are subject to rate limits to help maintain platform reliability. Rate limits may be increased by purchasing additional screenshot credits, or discussing your API requirements with us at hello@preflight.qa.

Base URL

Use this base URL for all API requests.

https://api.preflight.qa

Authentication

All API requests require these headers.

Authorization: Bearer <api_token>
Content-Type: application/json

API tokens can be generated by admins in the 'Manage Organisation' settings.

Libraries

Ruby library Official Ruby client for working with the Preflight API. View on GitHub