Microshot API
  • Introduction
  • Authentication
  • Endpoints
    • Screenshot
Powered by GitBook
On this page
  • Microshot API Reference
  • REST API
  • Start exploring API

Was this helpful?

Introduction

NextAuthentication

Last updated 2 years ago

Was this helpful?

Microshot API Reference

The Microshot API is organized around REST. Our API has predictable resource-oriented URLs, uses JSON format for request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

REST API

The Microshot API adheres to REST conventions. Our API communicates in JSON format and uses API tokens to authenticate requests.

The server-side REST API is available at:

https://api.microshot.io

By default, the API returns the screenshot image data directly, along with the relevant headers. However, if you set the response_type parameter to json the response will be in the form of a JSON which contains a link to the generated screenshot hosted on our CDN.

All the screenshots are cached for 24 hours. It means that after that time, the image won't be available anymore on our CDN. Cached screenshots don't count in your monthly quota.

Start exploring API

Dive a little deeper and start exploring our API endpoints to get an idea of everything that's possible with the API:

Endpoints