← Back to Docs|

introduction Docs

LLM-Optimized: This page contains the introduction documentation in plain markdown. Share this URL directly with AI assistants.

# DevThumbs API Documentation

**High-performance screenshot API running on Cloudflare's global edge network.**

DevThumbs captures website screenshots at scale with intelligent caching, automatic scrolling, and advanced features like element capture, custom JavaScript injection, and PDF generation.

---

## Quick Start

Get started with a simple screenshot capture in seconds:

```bash
curl "https://api.devthumbs.com/v1/screenshot?url=https://www.apple.com" \
  -H "x-api-key: YOUR_API_KEY"
```

> **Tip:** Check the Authentication section to get your API key, then explore the Screenshots API for advanced options.

---

## API Endpoints Overview

| Endpoint | Method | Description |
|:---------|:-------|:------------|
| `/v1/screenshot` | GET, POST | Capture a screenshot |
| `/v1/screenshot/status/:hash` | GET | Check capture status |
| `/v1/batch` | POST | Submit batch job (PRO+) |
| `/v1/batch/:id/status` | GET | Check batch status |
| `/v1/schedules` | GET, POST | Manage scheduled captures (PRO+) |
| `/v1/account/me` | GET | Get account details |

---

## Base URL

All API requests should be made to:

```
https://api.devthumbs.com
```

All endpoints are versioned under `/v1`.

---

## Asynchronous Processing

Screenshot captures are asynchronous. When you submit a request:
1. You receive a `PENDING` status with a unique `hash`.
2. The job is queued and processed in the background.
3. You poll the status endpoint or receive a webhook when complete.
4. The result is cached for 24 hours. The generated image URL is valid for 3 days.

---

## Request ID Tracing

Every API response includes an `x-request-id` header. Include this ID when contacting support for debugging.

```
x-request-id: 550e8400-e29b-41d4-a716-446655440000
```

---

## Documentation Sections

- **Authentication** - API keys and security
- **Screenshots** - Core capture API
- **Batch Operations** - Multiple URLs at once
- **Schedules API** - Recurring captures
- **WebSocket API** - Real-time progress
- **Webhooks** - Async notifications
- **Account & Keys** - Account management
- **Pricing & Credits** - Cost estimation
- **Errors & Rate Limits** - Troubleshooting