Register / Sign in | Get API Keys

AnyCrawler Public API Documentation

This repository is the public API reference repository for AnyCrawler.

Start Here

• Quickstart
• Authentication
• Errors and Headers
• API Reference
• SDK Guide
• Machine-readable contract: shared/openapi/openapi.json
• Shared SDK assets: shared/sdks/README.md
• Documentation status: shared/localization-status.md
• Release governance: releases/README.md

Source of Truth

For machine-checkable contract facts, shared/openapi/openapi.json is the authoritative source.

For navigation, integration guidance, stability notes, and explanatory prose, the authoritative documentation is the root documentation set in this repository.

The lightweight SDK files and curl scripts under shared/sdks/ are derived from the stable public contract. They are examples and convenience assets, not a second authority layer.

Current Scope

This repository currently publishes a single documentation set with no language-specific folder split.

The active public endpoints are:

• GET /v1/account/usage
• POST /v1/crawl/page
• POST /v1/crawl/screenshot
• POST /v1/search

Repository Structure

• root Markdown files: authoritative integration guidance
• api-reference/: endpoint reference index and per-endpoint docs
• sdk/: SDK usage guide
• shared/openapi/openapi.json: machine-readable API contract and release trigger anchor
• shared/sdks/: canonical lightweight SDK and curl assets
• releases/: changelog and migration governance artifacts
• MAINTENANCE.md: maintenance rules for docs and release hygiene

Contract Boundary

This repository documents the stable public contract only.

Only the request fields documented by the public contract are supported. Undocumented fields are not modeled by the shared SDKs and must not be used by integrations.