Screenshot Studio Developer Portal

Screenshot Studio is an open-source screenshot editor and workspace platform with anonymous utility endpoints and an authenticated tenant REST API. Scalar provides an interactive reference, the contract is published as OpenAPI 3.1, and the application is Apache 2.0 on GitHub.

Start here

Interactive API reference

Explore every REST operation, copy examples, and send requests through Scalar.

API guides

Authentication, rate limits, request and response examples, and the error-code table.

OpenAPI 3.1 specification

Machine-readable contract with operationIds, typed parameters, and response schemas.

Authentication and rate limits

Anonymous utilities, tenant API keys, signed-in sessions, and rate limits.

llms.txt

Markdown site overview for AI agents and LLM crawlers.

llms-full.txt

Long-form Markdown reference covering features and the API.

Source code on GitHub

Apache 2.0. Issues, discussions, and self-hosting instructions.

API keys

Utility endpoints such as /api/screenshot are anonymous and governed by per-IP limits. Workspace-scoped/api/v1 operations require an organization key inX-API-Key or an authorized signed-in session. Details are in authentication and rate limits.

Quickstart

1. Capture a live page

This anonymous utility accepts a URL and returns a base64 PNG.

curl -s -X POST https://www.screenshot-studio.com/api/screenshot \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","deviceType":"desktop"}' \
  | jq -r .screenshot | base64 -d > shot.png

2. Optimize the export

Send the image back through Sharp to recompress it as WebP.

curl -s -X POST https://www.screenshot-studio.com/api/export \
  -F "[email protected]" \
  -F "format=webp" \
  -F "qualityPreset=high" \
  -o shot.webp

3. Handle failures

Every failing request returns the same JSON envelope. Branch on code.

{
  "error": "URL is required",
  "code": "invalid_request",
  "message": "URL is required",
  "hint": "Send a JSON body with a \"url\" string.",
  "status": 400,
  "documentation": "https://www.screenshot-studio.com/docs#errors"
}

Sandbox

There is no separate sandbox host. Use anonymous utility endpoints only with disposable public inputs. Tenant API calls can read or mutate workspace data and may consume plan quotas, so use a test workspace or run the full stack locally:

git clone https://github.com/PlaybookMediaLLC/screenshot-studio.git
cd screenshot-studio
npm install
npm run dev

Building an agent

Load /openapi.json directly as a function-calling tool definition. Every operation carries a unique operationId, a description, typed parameters, and a response schema. Any page on this site also serves Markdown when asked:

curl -H "Accept: text/markdown" https://www.screenshot-studio.com/docs

CLI and MCP server

No official CLI tool and no MCP server are published yet. The curl examples above are the supported command-line path. If you want either one, open an issue.

Support

File bugs and feature requests on GitHub issues, or reach the maintainers through the contact page.