# CleanedWeb documentation

> Versioned REST APIs for website collections. Use each saved API contract for its inputs and availability.

## Getting started

- [Overview](https://cleanedweb.com/docs/): Learn how to inspect a public website collection, review fields, validate a generated REST API, and handle versioned output and source changes.
  Markdown: https://cleanedweb.com/docs/index.md
- [Quickstart](https://cleanedweb.com/docs/quickstart/): Make a bounded request to a validated website API, pin its definition version, and check records with the execution summary.
  Markdown: https://cleanedweb.com/docs/quickstart/index.md
- [Core concepts](https://cleanedweb.com/docs/concepts/): A guide to sources, collections, records, schemas, and API versions in CleanedWeb.
  Markdown: https://cleanedweb.com/docs/concepts/index.md

## Build an API

- [Choosing a source](https://cleanedweb.com/docs/choosing-a-source/): Choose a public collection URL, define the records you need, and review inspection evidence before building a REST API.
  Markdown: https://cleanedweb.com/docs/choosing-a-source/index.md
- [Fields and schemas](https://cleanedweb.com/docs/schemas/): Review observed fields, types, missing values, and the validated schema before connecting a generated web data API.
  Markdown: https://cleanedweb.com/docs/schemas/index.md
- [Build and validate](https://cleanedweb.com/docs/build-validation/): Review a collection, validate its build, and verify the saved API before connecting an application.
  Markdown: https://cleanedweb.com/docs/build-validation/index.md
- [Versions and changes](https://cleanedweb.com/docs/versioning/): Pin a source definition, review schema changes, and update an integration deliberately.
  Markdown: https://cleanedweb.com/docs/versioning/index.md

## API reference

- [Run a source](https://cleanedweb.com/docs/run-api/): Reference for the source execution request, version checks, bounded inputs, and response summary.
  Markdown: https://cleanedweb.com/docs/run-api/index.md
- [Authentication](https://cleanedweb.com/docs/authentication/): Use server credentials, check key scope and expiry, and keep requests pinned to a reviewed source definition.
  Markdown: https://cleanedweb.com/docs/authentication/index.md
- [Idempotency and recovery](https://cleanedweb.com/docs/idempotency/): Preserve request identity, replay settled results, and recover an uncertain execution without creating duplicate work.
  Markdown: https://cleanedweb.com/docs/idempotency/index.md
- [Pagination and output](https://cleanedweb.com/docs/pagination/): Set collection and detail limits, read execution summaries, and distinguish a bounded result from complete coverage.
  Markdown: https://cleanedweb.com/docs/pagination/index.md
- [Errors and retries](https://cleanedweb.com/docs/errors/): Interpret request errors and partial runs, handle uncertain outcomes before retrying, and review usage and billing.
  Markdown: https://cleanedweb.com/docs/errors/index.md

## Integration guides

- [Website to REST API tutorial](https://cleanedweb.com/docs/website-to-api/): Follow a website-to-API tutorial: choose a collection, validate fields, make bounded cURL and Python requests, and review partial results.
  Markdown: https://cleanedweb.com/docs/website-to-api/index.md
- [JavaScript](https://cleanedweb.com/docs/javascript/): Execute a bounded source request from Node.js and inspect its records, version, and summary.
  Markdown: https://cleanedweb.com/docs/javascript/index.md
- [Python](https://cleanedweb.com/docs/python/): Use a standard-library Python client to save a bounded response and review execution outcomes.
  Markdown: https://cleanedweb.com/docs/python/index.md
- [Store and deduplicate](https://cleanedweb.com/docs/storing-results/): Store records with their execution summary, choose record identities, and handle partial datasets.
  Markdown: https://cleanedweb.com/docs/storing-results/index.md
- [Schedule collection](https://cleanedweb.com/docs/scheduled-runs/): Use your scheduler to collect within explicit limits, prevent overlapping work, and handle unknown outcomes.
  Markdown: https://cleanedweb.com/docs/scheduled-runs/index.md
- [Migration guide](https://cleanedweb.com/docs/migration-guide/): Move an existing collection pipeline to CleanedWeb while preserving your application schema and downstream processing.
  Markdown: https://cleanedweb.com/docs/migration-guide/index.md

## Operate and manage

- [Production checklist](https://cleanedweb.com/docs/production-checklist/): Check credentials, schema compatibility, collection limits, storage, monitoring, and recovery before production use.
  Markdown: https://cleanedweb.com/docs/production-checklist/index.md
- [Monitor runs](https://cleanedweb.com/docs/monitoring/): Read run outcomes and usage, preserve diagnostic identifiers, and monitor the sources your application depends on.
  Markdown: https://cleanedweb.com/docs/monitoring/index.md
- [Source changes](https://cleanedweb.com/docs/source-changes/): Read execution summaries, preserve partial results, and review definition changes before using output from a maintained website API.
  Markdown: https://cleanedweb.com/docs/source-changes/index.md
- [Troubleshooting](https://cleanedweb.com/docs/troubleshooting/): Diagnose discovery, authentication, version conflicts, partial output, and uncertain execution outcomes.
  Markdown: https://cleanedweb.com/docs/troubleshooting/index.md
- [Units and billing](https://cleanedweb.com/docs/billing/): Understand prepaid Units, account usage, purchase receipts, and optional auto-reload controls.
  Markdown: https://cleanedweb.com/docs/billing/index.md
- [Security and access](https://cleanedweb.com/docs/security/): Protect API credentials, control data access, and prepare the security requirements for your integration.
  Markdown: https://cleanedweb.com/docs/security/index.md
- [Get support](https://cleanedweb.com/docs/support/): Prepare a useful support request with source, version, run identifiers, and redacted diagnostics.
  Markdown: https://cleanedweb.com/docs/support/index.md