Capture a page screenshot · Browser API
Render a URL in a headless browser and capture a screenshot, returned as a base64-encoded image. Control the viewport, capture the full scrollable page, target a CSS selector, and choose png, jpeg, or webp output.
Using ChatGPT, Claude Code or another client? See the setup steps
curl -X POST https://api.unifapi.com/browser/screenshot \ -H "Authorization: Bearer $UNIFAPI_KEY" \ -H "Content-Type: application/json"
Parameters
- The parameter for this Browser operation. Use the URL-visible slug or id described in the docs.
- The parameter for this Browser operation. Use the URL-visible slug or id described in the docs.
This operation is part of the Browser API in the browser category. It uses the same Bearer token, request tracing, error model, and billing envelope as every UnifAPI endpoint, so agents can switch between platforms without custom per-vendor glue code.
Use it when a workflow needs Browser public data but should still keep one API key, one account balance, and one predictable JSON contract across social, live public-data sources.
Common agent workflows
- Track what is moving on Browser for trend-discovery and content-planning agents.
- Compare live Browser signals with other public social data sources available through the same MCP and HTTP surface.
- Give an AI agent a stable Browser data source without building a per-platform integration.
- Normalize Browser responses into the same UnifAPI envelope used across the catalog.
Unified envelope, platform-native fields
- List-style responses return `data` as an array of top-level records plus optional `pagination` for continuation tokens or cursors.
- The operation has a 10 credits ($0.01) minimum charge, so `billing.records_charged` can be higher than the visible records returned.
- If the workspace balance cannot cover every result, the response can be truncated and `billing.truncated_due_to_balance` tells the caller why.
Response status codes
Billing
This operation charges 1 credit per billable record, with a 10 credits ($0.01) operation minimum. Public responses include billing metadata with credits charged, records charged, and remaining workspace balance. Incorrect Credit deductions caused by platform failures can be restored as billing corrections.
Errors and retries
Authentication, validation, rate-limit, not-found, and provider errors use the unified UnifAPI error format. Agents should log `request_id`, retry only retryable failures, and treat invalid API keys, disabled keys, and expired keys as the same public `unauthorized` error type.
Fields in the data object
A successful Capture a page screenshot call returns one data object with these fields.
- urlstring
- The rendered URL.
- formatstring
- Output image format.
- image_base64string
- Base64-encoded image bytes.
- size_bytesinteger
- Decoded image size in bytes.
Agents & Skills built on Browser
You rarely call Capture a page screenshot by hand. These prebuilt agents and skills already read Browser data inside Claude or Codex — start from one of them, or call this endpoint yourself.
More Browser operations
Combine endpoints from the same platform, then join the results with other UnifAPI categories without changing authentication or response parsing.
Render a page to HTML
Render a URL in a headless browser and return the fully rendered HTML after JavaScript execution — use it to read meta tags, structured data, and content that only appears after client-side rendering.
Extract links from a page
Render a URL in a headless browser and return every link on the page as absolute URLs, including links injected by JavaScript. Optionally restrict to visible links or same-domain links for internal-link and broken-link audits.
Render a page to Markdown
Render a URL in a headless browser (running JavaScript) and return the page as clean Markdown — ideal for content analysis, summarization, and feeding pages to language models.