# Webfold Docs > Install Webfold, scrape and crawl the web into clean Markdown, run the MCP and CDP servers, and call the hosted API. ## Docs - [Webfold documentation](https://webfold.ai/docs): Read how to install Webfold when it opens, scrape and crawl the web into clean Markdown, run the MCP and CDP servers, and call the hosted API. ## Get started - [Overview](https://webfold.ai/docs/getting-started/overview):/ What Webfold is, what it does, and how the pieces fit together. - [Install](https://webfold.ai/docs/getting-started/install):/ Install the webfold CLI and MCP server on Linux, macOS and Windows: requirements, the curl and PowerShell installers, prebuilt tarballs, Docker and Kubernetes, source builds, checksums, upgrades, uninstalling and troubleshooting. - [Quickstart](https://webfold.ai/docs/getting-started/quickstart):/ Scrape a page, crawl a site and convert a document in a few commands. ## Guides - [Scraping and conversion](https://webfold.ai/docs/guides/scraping):/ Turn a URL, saved HTML or a local file into clean Markdown. - [Scrape a sitemap to Markdown](https://webfold.ai/docs/guides/bulk):/ Turn a sitemap or a list of URLs into a folder of Markdown files, with a manifest, a failure ledger and resume. - [Rendered pages](https://webfold.ai/docs/guides/rendering):/ Extract pages whose content only appears after JavaScript runs, using a Chromium you control. - [Crawling and indexing](https://webfold.ai/docs/guides/crawling):/ Crawl sites, fold shared chrome once, build a local index and search it. - [Search](https://webfold.ai/docs/guides/search):/ Query web and academic engines and get one normalised result shape. - [Documents](https://webfold.ai/docs/guides/documents):/ Convert PDF, Word, Excel and CSV files to Markdown and chunks. - [WARC archives](https://webfold.ai/docs/guides/warc):/ Capture pages to WARC, extract from archives at high volume, and replay them. - [Headless and CDP](https://webfold.ai/docs/guides/headless-cdp):/ Run Webfold's CDP subset server for Playwright and Puppeteer, and the intercepting proxy. - [MCP server](https://webfold.ai/docs/guides/mcp):/ Give an AI agent Webfold's fetch, search, crawl and capture tools over MCP. - [Rust library](https://webfold.ai/docs/guides/library):/ Embed conversion and acquisition in your own program. - [OCR and documents](https://webfold.ai/docs/guides/ocr):/ Convert Office files, ebooks and PDFs to Markdown, and read text out of scanned pages. - [PII and secrets](https://webfold.ai/docs/guides/pii):/ Detect and redact personal data and credentials with a command-line scan, a library, or a self-hosted HTTP service. - [Corpusforge](https://webfold.ai/docs/guides/corpusforge):/ A corpus-governance pipeline: extract, scan and redact, build a deduplicated corpus and record an AI bill of materials. - [Glossa](https://webfold.ai/docs/guides/glossa):/ Extract, translate and verify every translatable string in your code, with a lockfile that merges without conflicts. - [Computer use](https://webfold.ai/docs/guides/computer-use):/ Sandboxed desktops an agent drives through the accessibility tree and a person can watch, take over and hand back. ## Reference - [CLI reference](https://webfold.ai/docs/reference/cli):/ Every webfold subcommand, with its arguments. - [Benchmarks](https://webfold.ai/docs/reference/benchmarks):/ What has been measured, under which protocol, and what the numbers do not show. - [Security](https://webfold.ai/docs/reference/security):/ Trust boundaries, known open findings, operator controls and how to report a vulnerability. - [Architecture](https://webfold.ai/docs/reference/architecture):/ How conversion, acquisition and execution fit together. - [Every face](https://webfold.ai/docs/reference/faces):/ All the ways to use Webfold, and where each one runs today. ## Hosted API - [API overview](https://webfold.ai/docs/api/overview):/ Base URL, authentication, conventions, errors and metering for the hosted Webfold API. - [SDKs](https://webfold.ai/docs/api/sdks):/ TypeScript, Python and Rust clients for the API. - [Agents and MCP](https://webfold.ai/docs/api/mcp):/ Use the API from Claude Desktop, Cursor and other agents, without writing integration code. ## API Reference - [Webfold API](https://webfold.ai/docs/api-reference):/ Web, research and bookmark endpoints over HTTP: scrape, crawl, map and search web pages, search and retrieve arXiv papers, fetch YouTube transcripts, archive… ### Web - [Scrape a web page](https://webfold.ai/docs/api-reference/web/web-scrape):/ Fetch a URL and convert it to Markdown using webfold. The response is returned as plain… Reference for the POST /v1/web/scrape endpoint in the Webfold API. - [Crawl a web site](https://webfold.ai/docs/api-reference/web/web-crawl):/ BFS crawl starting from url, staying on the same origin, up to max_pages and max_depth.… Reference for the POST /v1/web/crawl endpoint in the Webfold API. - [Discover URLs on a web site](https://webfold.ai/docs/api-reference/web/web-map):/ BFS URL discovery starting from url, staying on the same origin, up to max_pages. Returns a… Reference for the POST /v1/web/map endpoint in the Webfold API. - [Search the local web index](https://webfold.ai/docs/api-reference/web/web-search):/ Search the web index populated by /v1/web/crawl. Results are ranked by the B/U term score… Reference for the POST /v1/web/search endpoint in the Webfold API. ### Research - [Search arXiv](https://webfold.ai/docs/api-reference/research/arxiv-search):/ Query the arXiv Atom API and return a list of matching papers. Reference for the POST /v1/arxiv/search endpoint in the Webfold API. - [Retrieve an arXiv paper](https://webfold.ai/docs/api-reference/research/arxiv-retrieve):/ Fetch a paper by its arXiv ID, normalize it to Markdown, optionally prune references,… Reference for the POST /v1/arxiv/retrieve endpoint in the Webfold API. - [Fetch a YouTube transcript](https://webfold.ai/docs/api-reference/research/youtube-transcript):/ Extract a text transcript from a YouTube video URL. The server talks to YouTube's… Reference for the POST /v1/youtube/transcript endpoint in the Webfold API. ### Bookmarks - [Create and archive a bookmark](https://webfold.ai/docs/api-reference/bookmarks/create-bookmark):/ Scrape the provided URL, archive the Markdown, and store the bookmark. Optionally assign it… Reference for the POST /v1/bookmarks endpoint in the Webfold API. - [List and search bookmarks](https://webfold.ai/docs/api-reference/bookmarks/list-bookmarks):/ List bookmarks owned by the authenticated account. Filter by free-text query (q), tag, or… Reference for the GET /v1/bookmarks endpoint in the Webfold API. - [Get a bookmark](https://webfold.ai/docs/api-reference/bookmarks/get-bookmark):/ Get a bookmark. Reference for the GET /v1/bookmarks/{id} endpoint in the Webfold API. - [Update a bookmark](https://webfold.ai/docs/api-reference/bookmarks/update-bookmark):/ Partially update a bookmark. Set collection_id to an empty string to remove the… Reference for the PATCH /v1/bookmarks/{id} endpoint in the Webfold API. - [Delete a bookmark](https://webfold.ai/docs/api-reference/bookmarks/delete-bookmark):/ Delete a bookmark. Reference for the DELETE /v1/bookmarks/{id} endpoint in the Webfold API. ### Collections - [Create a collection](https://webfold.ai/docs/api-reference/collections/create-collection):/ Create a collection. Reference for the POST /v1/collections endpoint in the Webfold API. - [List collections](https://webfold.ai/docs/api-reference/collections/list-collections):/ List collections. Reference for the GET /v1/collections endpoint in the Webfold API. - [Get a collection with its bookmarks](https://webfold.ai/docs/api-reference/collections/get-collection):/ Get a collection with its bookmarks. Reference for the GET /v1/collections/{id} endpoint in the Webfold API. - [Delete a collection](https://webfold.ai/docs/api-reference/collections/delete-collection):/ Delete a collection. By default, all bookmarks in the collection are deleted. Pass… Reference for the DELETE /v1/collections/{id} endpoint in the Webfold API. ### Account - [Usage report](https://webfold.ai/docs/api-reference/account/get-usage):/ Returns a per-meter count of operations recorded for this account since the server started.… Reference for the GET /v1/usage endpoint in the Webfold API. ### System - [Health check](https://webfold.ai/docs/api-reference/system/health-check):/ Returns the service status and whether billing is enabled (i.e. FLEXPRICE_API_KEY is set on the… Reference for the GET /health endpoint in the Webfold API. ### Documents - [Convert a document to Markdown](https://webfold.ai/docs/api-reference/documents/documents-convert):/ Convert a base64-encoded DOCX, XLSX, PPTX, ODF, EPUB, RTF, CSV, HTML or text file… Reference for the POST /v1/documents/convert endpoint in the Webfold API. ### OCR - [Extract text from a PDF, with OCR for scans](https://webfold.ai/docs/api-reference/ocr/ocr-pdf):/ Reads the PDF's own text layer first (method: text). If there is none, renders the pages and… Reference for the POST /v1/ocr endpoint in the Webfold API. ### PII - [Redact personal data from text](https://webfold.ai/docs/api-reference/pii/pii-redact):/ Detects personal data (emails, phone numbers, card and IBAN numbers with checksum… Reference for the POST /v1/pii/redact endpoint in the Webfold API. - [Check text for personal data](https://webfold.ai/docs/api-reference/pii/pii-scan):/ Same detection as redaction but returns only the findings and a clean flag, for gating a… Reference for the POST /v1/pii/scan endpoint in the Webfold API. ### Corpus - [Redact a batch of records](https://webfold.ai/docs/api-reference/corpus/corpus-redact):/ Redacts up to 100 records, keeping their order and ids. Records without an id are… Reference for the POST /v1/corpus/redact endpoint in the Webfold API. - [Chunk and de-duplicate records into corpus rows](https://webfold.ai/docs/api-reference/corpus/corpus-build):/ Optionally redacts each record first, then splits it into chunks of at most chunk_chars… Reference for the POST /v1/corpus/build endpoint in the Webfold API. ### Localization - [Verify translations against their sources](https://webfold.ai/docs/api-reference/localization/localization-check):/ Runs Glossa's integrity gate on each source/translation pair: variable slots must… Reference for the POST /v1/localization/check endpoint in the Webfold API. - [List the translatable strings in a file](https://webfold.ai/docs/api-reference/localization/localization-extract):/ Extracts translatable strings from a source or resource file. The file type… Reference for the POST /v1/localization/extract endpoint in the Webfold API. ### Computers - [Create a sandbox computer](https://webfold.ai/docs/api-reference/computers/computers-create):/ Creates a sandbox desktop through the computer-use gateway, owned by your account. The… Reference for the POST /v1/computers endpoint in the Webfold API. - [Get a computer](https://webfold.ai/docs/api-reference/computers/computers-status):/ Status, size and expiry of one computer. Reference for the GET /v1/computers/{id} endpoint in the Webfold API. - [Destroy a computer](https://webfold.ai/docs/api-reference/computers/computers-destroy):/ Stops the sandbox and discards its state. Reference for the DELETE /v1/computers/{id} endpoint in the Webfold API. - [List capability tokens](https://webfold.ai/docs/api-reference/computers/computers-list-tokens):/ Tokens minted for this computer, without their secrets. Reference for the GET /v1/computers/{id}/tokens endpoint in the Webfold API. - [Mint a capability token](https://webfold.ai/docs/api-reference/computers/computers-mint-token):/ Mints a scoped, expiring token (view, control, or an agent scope). The secret… Reference for the POST /v1/computers/{id}/tokens endpoint in the Webfold API. - [Revoke every token](https://webfold.ai/docs/api-reference/computers/computers-revoke-all-tokens):/ Revokes all capability tokens for this computer. Reference for the POST /v1/computers/{id}/tokens/revoke-all endpoint in the Webfold API. - [Revoke one token](https://webfold.ai/docs/api-reference/computers/computers-revoke-token):/ Revokes a single capability token. Reference for the DELETE /v1/computers/{id}/tokens/{token_id} endpoint in the Webfold API. - [Resume the agent](https://webfold.ai/docs/api-reference/computers/computers-agent-resume):/ Lets the agent act again after a takeover or suspension. Reference for the POST /v1/computers/{id}/agent/resume endpoint in the Webfold API. - [Agent guard state](https://webfold.ai/docs/api-reference/computers/computers-agent-guard):/ Whether the agent may currently act, and why not if it may not. Reference for the GET /v1/computers/{id}/agent/guard endpoint in the Webfold API. - [Take over from the agent](https://webfold.ai/docs/api-reference/computers/computers-takeover):/ A human takes control; the agent is paused. Reference for the POST /v1/computers/{id}/takeover endpoint in the Webfold API. - [Hand control back to the agent](https://webfold.ai/docs/api-reference/computers/computers-handback):/ The human releases control. Reference for the POST /v1/computers/{id}/handback endpoint in the Webfold API. - [Revoke agent access](https://webfold.ai/docs/api-reference/computers/computers-revoke):/ Cuts the agent off from this computer. Reference for the POST /v1/computers/{id}/revoke endpoint in the Webfold API. - [Suspend a computer](https://webfold.ai/docs/api-reference/computers/computers-suspend):/ Freezes the sandbox in place. Reference for the POST /v1/computers/{id}/suspend endpoint in the Webfold API. - [Unsuspend a computer](https://webfold.ai/docs/api-reference/computers/computers-unsuspend):/ Resumes a suspended sandbox. Reference for the POST /v1/computers/{id}/unsuspend endpoint in the Webfold API. - [Read the audit log](https://webfold.ai/docs/api-reference/computers/computers-audit):/ The hash-chained audit trail of actions on this computer. Query parameters are… Reference for the GET /v1/computers/{id}/audit endpoint in the Webfold API. - [Where to open the live desktop](https://webfold.ai/docs/api-reference/computers/computers-stream-info):/ Returns the WebSocket address of the gateway. The stream is RFB over WebSocket… Reference for the GET /v1/computers/{id}/stream endpoint in the Webfold API. ## Pii API - [PII service (pii-svc)](https://webfold.ai/docs/pii-api):/ pii-svc exposes two endpoints: a liveness probe and a redaction endpoint. findings returned by POST /redact carry byte offsets into the original request text… ### Redaction - [Detect and redact PII in a block of text.](https://webfold.ai/docs/pii-api/redaction/redact):/ If PII_SVC_TOKEN is set on the server, this endpoint requires Authorization: Bearer… Reference for the POST /redact endpoint in the PII service (pii-svc) API. ### System - [Liveness probe.](https://webfold.ai/docs/pii-api/system/healthz):/ Returns 200 OK with the literal body ok if the process is up. Does not verify that… Reference for the GET /healthz endpoint in the PII service (pii-svc) API. ## Agent skills - [webfold-docs](https://webfold.ai/docs/.well-known/agent-skills/webfold-docs/SKILL.md):/ Read the Webfold Docs instead of answering from memory. Install Webfold, scrape and crawl the web into clean Markdown, run the MCP and CDP servers, and call the hosted API. Use when a task involves Webfold Docs: how it works, how to set it up or configure it, or its API. ## Agent resources - [llms-full.txt](https://webfold.ai/docs/llms-full.txt):/ The full Markdown of every page in one file. - [Page Markdown](https://webfold.ai/docs/index.md):/ Append `.md` to any page URL to fetch that page as raw Markdown. - [JSON API](https://webfold.ai/docs/api/docs/pages.json):/ Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://webfold.ai/docs/openapi.json./ - [Agent skills](https://webfold.ai/docs/.well-known/agent-skills/index.json):/ Agent Skills discovery index of the skills this site publishes. - [API catalog](https://webfold.ai/docs/.well-known/api-catalog):/ RFC 9727 linkset of the APIs documented here. - [AI catalog](https://webfold.ai/docs/.well-known/ai-catalog.json):/ ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs). - [agent-readability.json](https://webfold.ai/docs/agent-readability.json):/ Manifest of every agent-facing artifact on this site. - [Sitemap](https://webfold.ai/docs/sitemap.xml):/ Every indexable page URL with its last-modified date.