--- seo: description: >- Web, research and bookmark endpoints over HTTP: scrape, crawl, map and search web pages, search and retrieve arXiv papers, fetch YouTube transcripts, archive… sidebar: label: Overview title: Webfold API --- Web, research and bookmark endpoints over HTTP: scrape, crawl, map and search web pages, search and retrieve arXiv papers, fetch YouTube transcripts, archive pages as Markdown, convert documents, read PDFs with OCR, redact personal data, build corpora, check translations, and run sandboxed computers. Authenticate every request except `GET /health` with a bearer API key. Fetched content is cached; the `x-cache` response header reports `hit`, `miss` or `raw-hit`. Errors have a plain-text body, not JSON. The hosted API is in early access. Version 0.1.0 Base URL: `https://api.webfold.ai` ## Web Fetch pages as Markdown, crawl a site, discover its URLs, and search the pages you have crawled. - [`POST /v1/web/scrape`](/docs/api-reference/web/web-scrape) — Scrape a web page. - [`POST /v1/web/crawl`](/docs/api-reference/web/web-crawl) — Crawl a web site. - [`POST /v1/web/map`](/docs/api-reference/web/web-map) — Discover URLs on a web site. - [`POST /v1/web/search`](/docs/api-reference/web/web-search) — Search the local web index. ## Research Search arXiv, retrieve papers as chunked Markdown, and fetch YouTube transcripts. - [`POST /v1/arxiv/search`](/docs/api-reference/research/arxiv-search) — Search arXiv. - [`POST /v1/arxiv/retrieve`](/docs/api-reference/research/arxiv-retrieve) — Retrieve an arXiv paper. - [`POST /v1/youtube/transcript`](/docs/api-reference/research/youtube-transcript) — Fetch a YouTube transcript. ## Bookmarks Archive a page as Markdown at creation time, tag it and search your archive. - [`POST /v1/bookmarks`](/docs/api-reference/bookmarks/create-bookmark) — Create and archive a bookmark. - [`GET /v1/bookmarks`](/docs/api-reference/bookmarks/list-bookmarks) — List and search bookmarks. - [`GET /v1/bookmarks/{id}`](/docs/api-reference/bookmarks/get-bookmark) — Get a bookmark. - [`PATCH /v1/bookmarks/{id}`](/docs/api-reference/bookmarks/update-bookmark) — Update a bookmark. - [`DELETE /v1/bookmarks/{id}`](/docs/api-reference/bookmarks/delete-bookmark) — Delete a bookmark. ## Collections Group bookmarks. Deleting a collection deletes its bookmarks unless `unlink=true`. - [`POST /v1/collections`](/docs/api-reference/collections/create-collection) — Create a collection. - [`GET /v1/collections`](/docs/api-reference/collections/list-collections) — List collections. - [`GET /v1/collections/{id}`](/docs/api-reference/collections/get-collection) — Get a collection with its bookmarks. - [`DELETE /v1/collections/{id}`](/docs/api-reference/collections/delete-collection) — Delete a collection. ## Account Per-meter usage for your key. - [`GET /v1/usage`](/docs/api-reference/account/get-usage) — Usage report. ## System Service health. No authentication. - [`GET /health`](/docs/api-reference/system/health-check) — Health check. ## Documents Convert office documents, e-books and spreadsheets to Markdown. - [`POST /v1/documents/convert`](/docs/api-reference/documents/documents-convert) — Convert a document to Markdown. ## OCR Read PDFs, including scans. - [`POST /v1/ocr`](/docs/api-reference/ocr/ocr-pdf) — Extract text from a PDF, with OCR for scans. ## PII Detect and redact personal data. - [`POST /v1/pii/redact`](/docs/api-reference/pii/pii-redact) — Redact personal data from text. - [`POST /v1/pii/scan`](/docs/api-reference/pii/pii-scan) — Check text for personal data. ## Corpus Redact, chunk and de-duplicate text into training or retrieval corpora. - [`POST /v1/corpus/redact`](/docs/api-reference/corpus/corpus-redact) — Redact a batch of records. - [`POST /v1/corpus/build`](/docs/api-reference/corpus/corpus-build) — Chunk and de-duplicate records into corpus rows. ## Localization Extract translatable strings and verify translations. - [`POST /v1/localization/check`](/docs/api-reference/localization/localization-check) — Verify translations against their sources. - [`POST /v1/localization/extract`](/docs/api-reference/localization/localization-extract) — List the translatable strings in a file. ## Computers Sandboxed computers an agent can drive, with human takeover and an audit trail. - [`POST /v1/computers`](/docs/api-reference/computers/computers-create) — Create a sandbox computer. - [`GET /v1/computers/{id}`](/docs/api-reference/computers/computers-status) — Get a computer. - [`DELETE /v1/computers/{id}`](/docs/api-reference/computers/computers-destroy) — Destroy a computer. - [`GET /v1/computers/{id}/tokens`](/docs/api-reference/computers/computers-list-tokens) — List capability tokens. - [`POST /v1/computers/{id}/tokens`](/docs/api-reference/computers/computers-mint-token) — Mint a capability token. - [`POST /v1/computers/{id}/tokens/revoke-all`](/docs/api-reference/computers/computers-revoke-all-tokens) — Revoke every token. - [`DELETE /v1/computers/{id}/tokens/{token_id}`](/docs/api-reference/computers/computers-revoke-token) — Revoke one token. - [`POST /v1/computers/{id}/agent/resume`](/docs/api-reference/computers/computers-agent-resume) — Resume the agent. - [`GET /v1/computers/{id}/agent/guard`](/docs/api-reference/computers/computers-agent-guard) — Agent guard state. - [`POST /v1/computers/{id}/takeover`](/docs/api-reference/computers/computers-takeover) — Take over from the agent. - [`POST /v1/computers/{id}/handback`](/docs/api-reference/computers/computers-handback) — Hand control back to the agent. - [`POST /v1/computers/{id}/revoke`](/docs/api-reference/computers/computers-revoke) — Revoke agent access. - [`POST /v1/computers/{id}/suspend`](/docs/api-reference/computers/computers-suspend) — Suspend a computer. - [`POST /v1/computers/{id}/unsuspend`](/docs/api-reference/computers/computers-unsuspend) — Unsuspend a computer. - [`GET /v1/computers/{id}/audit`](/docs/api-reference/computers/computers-audit) — Read the audit log. - [`GET /v1/computers/{id}/stream`](/docs/api-reference/computers/computers-stream-info) — Where to open the live desktop.