waypoints API Documentation

Modules

Quick Start

npm install @waypoints/sdk

import waypoints from "@waypoints/sdk";

const wp = new waypoints({
  apiKey: process.env.WAYPOINTS_API_KEY, // wp_live_...
});

// Screenshot any URL
const result = await wp.render.screenshot({
  url: "https://example.com",
  width: 1280,
  format: "png",
});

console.log(result.url); // presigned MinIO URL (24h TTL)
console.log(result.credits_used); // 2

Authentication

All API requests must include your API key in the x-api-key header. You can create and manage API keys from the dashboard.

curl -X POST https://api.waypoints.tech/v1/render/screenshot \
  -H "x-api-key: wp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com" }'

Error Format

All errors follow a consistent JSON envelope with a machine-readable code, human-readable message, and a link to the relevant documentation.

{
  "error": {
    "code": "INSUFFICIENT_CREDITS",
    "message": "You have 3 credits remaining. This call costs 5.",
    "docs": "https://waypoints.sh/docs/errors#insufficient-credits"
  }
}