Urlbox

Urlbox is a website screenshot and rendering API that captures pixel-perfect screenshots, PDFs, and video (MP4/WebM) of any web page or raw HTML. Renders are requested synchronously, asynchronously (with polling or webhooks), or via signed HMAC render links, with hundreds of options for full-page capture, element selectors, PDF layout, ad/cookie-banner blocking, waiting, and S3 storage.

6 APIs 0 Features

ScreenshotsRenderingPDFVideoWeb Capture

APIs

Urlbox Synchronous Render API

POST /render/sync renders a screenshot, PDF, or video of a URL or HTML and blocks until the asset is ready, returning a temporary renderUrl plus size, renderTime, queueTime, and...

Urlbox Asynchronous Render API

POST /render/async accepts the same render options and returns immediately with a renderId and statusUrl (201 Created); the render is processed in the background and results are...

Urlbox Render Status API

GET /render/{renderId} polls the status of an asynchronous render, returning created, retrying, succeeded, failed, or not-found, along with the renderUrl and size once the rende...

Urlbox Render Links API

GET /{api_key}/{token}/{format} returns a render directly from a stateless, cacheable URL, where token is an HMAC-SHA256 signature of the URL-encoded options query string genera...

Urlbox Webhooks API

Async renders configured with a webhook_url receive a POST callback carrying render.succeeded or render.failed events with the result payload, verified via the X-Urlbox-Signatur...

Urlbox Usage API

Reports renders used, allowed, and remaining for the current billing period; usage is also surfaced on every render response via x-renders-used, x-renders-allowed, and x-renders...

Collections

Urlbox API

OPEN

Pricing Plans

Urlbox Plans Pricing

5 plans

PLANS

Rate Limits

Urlbox Rate Limits

6 limits

RATE LIMITS

FinOps

Urlbox Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Urlbox API
  version: '1.0'
  description: Website screenshot and rendering API for screenshots, PDFs, and video of any URL or HTML. Renders run synchronously,
    asynchronously (poll or webhook), or via signed HMAC render links.
request:
  auth:
    type: bearer
    token: '{{urlbox_secret}}'
items:
- info:
    name: Render
    type: folder
  items:
  - info:
      name: Create a synchronous render
      type: http
    http:
      method: POST
      url: https://api.urlbox.com/v1/render/sync
      body:
        type: json
        data: '{"url":"https://example.com","format":"png","full_page":true}'
    docs: Render a screenshot, PDF, or video and block until the asset is ready. Returns 200 OK with renderUrl, size, renderTime,
      queueTime, and bandwidth.
  - info:
      name: Create an asynchronous render
      type: http
    http:
      method: POST
      url: https://api.urlbox.com/v1/render/async
      body:
        type: json
        data: '{"url":"https://example.com","format":"pdf","webhook_url":"https://your-app.example.com/urlbox/webhook"}'
    docs: Queue a render and return immediately with 201 Created, a renderId, and a statusUrl. Results are retrieved by polling
      or via the webhook_url callback.
- info:
    name: Status
    type: folder
  items:
  - info:
      name: Check render status
      type: http
    http:
      method: GET
      url: https://api.urlbox.com/v1/render/{{renderId}}
    docs: 'Poll the status of an asynchronous render: created, retrying, succeeded, failed, or not-found. Returns renderUrl
      and size once succeeded.'
- info:
    name: Render Links
    type: folder
  items:
  - info:
      name: Render via signed link
      type: http
    http:
      method: GET
      url: https://api.urlbox.com/v1/{{urlbox_api_key}}/{{token}}/png?url=https://example.com
      auth:
        type: none
    docs: Return a render directly from a stateless, cacheable URL. The token is an HMAC-SHA256 signature of the URL-encoded
      options query string, generated server-side with the project secret.
- info:
    name: Usage
    type: folder
  items:
  - info:
      name: Get usage
      type: http
    http:
      method: GET
      url: https://api.urlbox.com/v1/usage
    docs: Return renders used, allowed, and remaining for the current billing period.