Captr
Docs
Getting Started

Getting Started

Learn how to use Captr's powerful Image Transform and Screenshots APIs

Getting Started with Captr

Captr offers two powerful APIs:

  • Image Transform API: Process and transform images with features like resizing, format conversion, and effects
  • Screenshots API: Capture high-quality website screenshots programmatically

This guide will help you get started with integrating Captr's APIs into your applications.

Quick Start

  1. Sign up for an API key at app.captr.dev
  2. Try our APIs:
# Screenshots API
curl -X GET "https://api.captr.dev/v1/capture?url=https://example.com&apiKey=YOUR_API_KEY"
 
# Image Transform API
curl -X GET "https://api.captr.dev/v1/transform?url=https://example.com/image.jpg&width=800&format=webp&apiKey=YOUR_API_KEY"

Screenshots API

Capture website screenshots with a simple API call:

const response = await fetch(
  'https://api.captr.dev/v1/capture?url=https://example.com',
  {
    headers: {
      Authorization: 'Bearer YOUR_API_KEY'
    }
  }
);
 
const screenshot = await response.blob();

Screenshots API Options

  • format: Choose between 'png' or 'jpeg' (default: 'png')
  • width: Set viewport width in pixels (default: 1920)
  • height: Set viewport height in pixels (default: 1080)
  • fullPage: Capture entire page scrolling (default: false)
  • quality: JPEG quality 1-100 (default: 80, only for JPEG)

Image Transform API

Transform and optimize images easily:

const params = new URLSearchParams({
  url: 'https://example.com/image.jpg',
  width: '800',
  format: 'webp',
  quality: '90'
});
 
const response = await fetch(`https://api.captr.dev/v1/transform?${params}`, {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
});
 
const transformedImage = await response.blob();

Image Transform API Options

  • width: Desired width in pixels
  • height: Desired height in pixels
  • format: Output format (jpeg, png, webp)
  • quality: Output quality 1-100
  • fit: Resize mode (cover, contain, fill)
  • background: Background color for transparent images

Rate Limits and Pricing

Free Tier

  • 100 requests/month for each API
  • Basic features included
  • No credit card required

Pro Tier

  • Screenshots API: $1 per 200 requests
  • Image Transform API: $1 per 1,000 requests
  • All features included
  • Pay as you go

Enterprise

  • Custom volume pricing
  • Priority support
  • Custom features and integrations

Next Steps

Examples