# Documentation

- [Overview](/): Welcome to Urlbox, an API for converting URLs and HTML into screenshots, PDFs, videos, and extracting text, html and metadata with ease.
- [Quick Start](/quickstart): Quickly learn how to use Urlbox's website screenshot API
- Urlbox CLI
  - [Overview](/cli): Render screenshots, PDFs and videos from your terminal with the Urlbox CLI, or hand it to an AI agent and have a screenshot saved in under a minute.
  - [Quickstart](/cli/quickstart): Install the Urlbox CLI and render screenshots, PDFs and more from your terminal.
  - [Install & update](/cli/install): Install the Urlbox CLI with npm, Homebrew or Scoop, verify it with urlbox doctor, and keep it current with urlbox upgrade.
  - [Authentication](/cli/authentication): Sign in to the Urlbox CLI with urlbox login, switch orgs and projects, and authenticate CI and headless environments with an env var.
  - [Rendering](/cli/rendering): Capture screenshots, PDFs and videos from the terminal with the Urlbox CLI, covering formats, presets, viewport, full-page, and the common render flags.
  - [Saving files & output](/cli/output-and-scripting): Control where the Urlbox CLI saves renders with the --output sandbox, and choose how each command's result is printed.
  - [Any option with --json](/cli/json-and-schema): Use --json to pass any Urlbox API option through the CLI, even ones without a dedicated flag.
  - [Signed render links](/cli/signed-links): Generate signed Urlbox render URLs locally with urlbox link, with no API call and no credit spent, to embed in templates, emails and websites.
  - [Async renders & webhooks](/cli/async-and-webhooks): Queue heavy Urlbox renders with --async and receive the result by webhook, or check on a render with urlbox status.
  - [Screenshots from a CSV](/cli/batch-csv): Render a whole list of URLs from a CSV into a folder with the Urlbox CLI, by asking an AI agent or with a short shell loop.
  - [Using the CLI from an AI agent](/cli/ai-agents): Install the Urlbox agent skill so Claude Code, Cursor, Codex or opencode can drive the CLI for you and render in plain English.
  - [Storage, proxies & LLMs](/cli/org-resources): Manage your organisation's storage credentials, proxies and LLM credentials from the Urlbox CLI, and assign them to projects.
  - [Configuration](/cli/configuration): Where the Urlbox CLI stores its configuration, how to read and change it, and how env vars fit in.
  - [Troubleshooting](/cli/troubleshooting): Diagnose Urlbox CLI problems with urlbox doctor and understand the error codes it reports.
  - [Command reference](/cli/command-reference): Every Urlbox CLI command and global flag in one place, from render, screenshot and link to login, projects, storage and doctor.
- [Projects](/projects): Learn about Projects and how to use them.
- Common Problems
  - [Common Problems](/common-problems): Solutions to the most common rendering problems, and the options most people set.
  - [Most-used options](/common-problems/most-used-options): The options most people set on almost every render.
  - [Avoiding blocks](/common-problems/avoiding-blocks): Fix blank or blocked screenshots caused by bot detection, Cloudflare, or 403s.
  - [Getting complete renders](/common-problems/getting-complete-renders): Fix screenshots captured too early that miss late-loading content.
  - [Full-page gotchas](/common-problems/full-page-gotchas): Fix full-page screenshots that are cut off, stretched, or have duplicated headers.
  - [Saving to your storage](/common-problems/saving-to-storage): Send renders to your own bucket, or get notified with a webhook.
- Guides
  - [Guides](/guides): Step-by-step recipes for common rendering tasks.
  - [Taking screenshots of all pages on a website](/guides/bulk-website-screenshots)
  - [Proxies](/guides/proxies): Learn how to configure a proxy with Urlbox
  - [Avoiding Being Blocked](/guides/avoiding-being-blocked): Detect block pages and CAPTCHAs, retry blocked renders automatically, and use stealth and proxies to capture the real content
  - [Setting the User Agent](/guides/setting-the-user-agent): How to override the default user agent
  - [Saving to S3](/guides/s3)
  - [Sandbox](/guides/sandbox): The Urlbox sandbox is a place for you to play around with the various options available in the API before coding your integration.
  - [Side Renders](/guides/side-renders): Generate extra artifacts - HTML, MHTML, markdown, metadata, extracted content and thumbnails - from the same page load as your main render
  - [Rendering thumbnails](/guides/thumbnails): Generate multiple thumbnail images from a single render using the thumbnails option
  - [Rendering Behind a Login](/guides/rendering-behind-login): How to screenshot pages that require you to be logged in, using session cookies or auth headers
  - [Rendering Local URLs](/guides/rendering-local-urls): How to render sites running on localhost or a private network by exposing them through a tunnel
- [Screenshots](/screenshots): Capture full-page screenshots and target specific elements on a page.
- Videos
  - [Recording videos](/videos/recording-videos): How to record MP4 and WebM videos of any website with Urlbox, including scrolling videos and section-controlled scrolling
- [PDFs](/pdfs): Render web pages and HTML to PDF.
- Saving to S3
  - [Saving to S3](/storage): Persist renders directly into your own cloud storage bucket.
  - [Configuring S3](/storage/configure-s3): Save your screenshots, PDFs and other renders to an S3 bucket from Urlbox
  - [Configuring a private S3 bucket](/storage/configure-s3-private): Save your screenshots, PDFs and other renders to a private S3 bucket from Urlbox
  - [Configuring Cloudflare R2](/storage/configure-cloudflare-r2): Save your screenshots, PDFs and other renders to a Cloudflare R2 bucket from Urlbox
  - [Configuring Google Cloud Storage](/storage/configure-google-cloud-storage): Save your screenshots, PDFs and other renders to Google Cloud Storage from Urlbox
  - [Configuring Digital Ocean Spaces](/storage/configure-digitalocean-spaces): Save your screenshots, PDFs and other renders to a Digital Ocean Spaces bucket from Urlbox
  - [Configuring Backblaze B2](/storage/configure-backblaze-b2): Save your screenshots, PDFs and other renders to a Backblaze B2 bucket from Urlbox
  - [Configuring Azure Blob Storage](/storage/configure-azure-blob-storage): Save your screenshots, PDFs and other renders to an Azure Blob Storage container from Urlbox
- Example Code
  - [Example Code](/examplecode): Code samples for using Urlbox in various languages
  - [Nodejs website screenshots](/examplecode/node): Generate website screenshots with nodejs
  - [Ruby website screenshots](/examplecode/ruby): Generate website screenshots with Ruby and Rails
  - [Python website screenshots](/examplecode/python): Generate website screenshots with Python and Django
  - [PHP website screenshots](/examplecode/php): Generate website screenshots with PHP and Laravel
  - [Java website screenshots](/examplecode/java): URL to image with Java
  - [C# website screenshots](/examplecode/csharp): Generate website screenshots with C#
- API Reference
  - [Urlbox API Reference](/api): Technical reference for the Urlbox API
  - [Sync vs Async](/guides/sync-vs-async)
  - [Webhooks](/webhooks)
  - [Usage Info](/api/get-usage)
  - [Rate Limits](/api/rate-limits)
  - [REST API vs Render Links](/api/rest-api-vs-render-links): Explaining differences between generating renders using render links and via the REST API
- [Render Links](/render-links): Create screenshots, PDFs and other renders by embedding a single link in your HTML or emails.
- Render Options
  - [Render Options](/options): Every render option the Urlbox API accepts, grouped by area, with examples.
  - [Basic options](/options#basic)
  - [Blocking options](/options#blocking)
  - [Customize options](/options#customize)
  - [Screenshot options](/options#screenshot)
  - [PDF options](/options#pdf)
  - [Cache options](/options#cache)
  - [Request options](/options#request)
  - [Wait options](/options#wait)
  - [Fail options](/options#fail)
  - [Page options](/options#page)
  - [Full page options](/options#full-page)
  - [Highlighting options](/options#highlighting)
  - [Geolocation options](/options#geolocation)
  - [Storage options](/options#storage)
  - [LLM options](/options#llm)
  - [Extraction options](/options#extraction)
  - [Webhook options](/options#webhook)
- [LLMs.txt](/llms.txt)