diff --git a/docs/credit-costs/index.html b/docs/credit-costs/index.html index 34032ae6..f8b6393f 100644 --- a/docs/credit-costs/index.html +++ b/docs/credit-costs/index.html @@ -321,11 +321,11 @@
searchsearch + scrapemonitor create / list / getPurchased top-up credits never expire and are not tied to your current billing cycle. Cancelling your subscription zeroes only the plan's included/monthly credit allowance; any purchased top-up balance survives cancellation and stays spendable.
The FREE plan grants 1000 credits once, for the lifetime of the account, not monthly, and it never resets. No card is required to get them. Once they are spent, a FREE account either upgrades to a paid plan or stops.
+The FREE plan grants 500 credits once, for the lifetime of the account, not monthly, and it never resets, plus up to 500 more from onboarding tasks. No card is required to get them. Once they are spent, a FREE account either upgrades to a paid plan or stops.
The crawl start reserves the job. Subsequent polls charge only for newly materialized pages, not for the total accumulated page count each time.
That prevents the same already-seen pages from being charged again and again just because you are checking progress.
@@ -383,15 +383,15 @@Available tags: latest, 0.16 (tracks the current minor), 0.16.0 (pinned).
Use a pinned tag in production — latest rolls forward on every release.
git clone https://github.com/us/crw.git
cd crw
docker compose up
diff --git a/docs/docs/credit-costs.md b/docs/docs/credit-costs.md
index f55f3563..00c00c6d 100644
--- a/docs/docs/credit-costs.md
+++ b/docs/docs/credit-costs.md
@@ -15,8 +15,8 @@ Cloud only (fastcrw.com) -- self-hosted instances do not have credit-based billi
| `map` | 1 credit |
| `crawl` start | 1 credit |
| `crawl` polling | New pages discovered since the previous poll |
-| `search` | 1 credit |
-| `search` + scrape | 1 credit + 1 per scraped result |
+| `search` | 2 credits |
+| `search` + scrape | 2 credits + 1 per scraped result |
| `monitor` create / list / get | 0 credits |
| `monitor` check (per run) | 1 credit per scraped page, plus 1 more credit per page judged changed |
| `browse` | Not a billed cloud endpoint. It is a local CLI/companion capability, free either way |
@@ -43,7 +43,7 @@ Purchased top-up credits never expire and are not tied to your current billing c
## Free tier
-The FREE plan grants 1000 credits **once, for the lifetime of the account**, not monthly, and it never resets. No card is required to get them. Once they are spent, a FREE account either upgrades to a paid plan or stops.
+The FREE plan grants 500 credits **once, for the lifetime of the account**, not monthly, and it never resets, plus up to 500 more from onboarding tasks. No card is required to get them. Once they are spent, a FREE account either upgrades to a paid plan or stops.
## Why crawl billing looks different
@@ -60,9 +60,9 @@ That prevents the same already-seen pages from being charged again and again jus
| Start one crawl job | 1 credit |
| Poll a crawl and receive 7 new pages | 7 additional credits |
| Poll again with no new pages | No new page credits |
-| Search for "AI tools" with 5 results | 1 credit |
-| Search + scrape 3 results | 1 + 3 = 4 credits |
-| Search + scrape, 1 scrape fails | 1 + 2 = 3 credits (failed scrape refunded) |
+| Search for "AI tools" with 5 results | 2 credits |
+| Search + scrape 3 results | 2 + 3 = 5 credits |
+| Search + scrape, 1 scrape fails | 2 + 2 = 4 credits (failed scrape refunded) |
## What Usually Does Not Consume Permanent Credits
diff --git a/docs/docs/docker.md b/docs/docs/docker.md
index b5612ea6..4f61cf2e 100644
--- a/docs/docs/docker.md
+++ b/docs/docs/docker.md
@@ -12,6 +12,11 @@ docker run -p 3000:3000 ghcr.io/us/crw:0.16.0
Available tags: `latest`, `0.16` (tracks the current minor), `0.16.0` (pinned).
Use a pinned tag in production — `latest` rolls forward on every release.
+:::note
+500 credits to start, up to 500 more from onboarding tasks, no card.
+Get your API key
+:::
+
## Docker Compose
```bash
diff --git a/docs/docs/glossary.md b/docs/docs/glossary.md
index 2401aaac..32bdb097 100644
--- a/docs/docs/glossary.md
+++ b/docs/docs/glossary.md
@@ -30,7 +30,7 @@ Chrome DevTools Protocol is the WebSocket-based protocol that lets external prog
## credit
-A credit is the billing unit for the hosted cloud at `fastcrw.com`, worth $0.001. Every scrape costs 1 credit regardless of renderer (HTTP, lightpanda, or Chrome); there is no renderer or proxy surcharge. LLM-backed work (`POST /v1/extract`, or `formats: ["json"]` / `summary` on scrape) costs that 1-credit base render plus the actual LLM cost of the call, dynamically metered: there is no flat credit number for it. See the [Credit Costs](/docs/credit-costs) table for current billing. Map and search start-calls each cost 1 credit, and crawl jobs charge 1 credit at start plus one additional credit per page as pages are discovered during polling. The FREE plan grants 1000 credits once, for the lifetime of the account, not monthly, and they never reset. Purchased top-up credits never expire and survive plan cancellation. Self-hosted deployments have no billing layer and are unaffected by credit costs. Check your balance with `GET /api/v1/account/balance` on the SaaS control-plane. See [Credit Costs](/docs/credit-costs) for the full table.
+A credit is the billing unit for the hosted cloud at `fastcrw.com`, worth $0.001. Every scrape costs 1 credit regardless of renderer (HTTP, lightpanda, or Chrome); there is no renderer or proxy surcharge. LLM-backed work (`POST /v1/extract`, or `formats: ["json"]` / `summary` on scrape) costs that 1-credit base render plus the actual LLM cost of the call, dynamically metered: there is no flat credit number for it. See the [Credit Costs](/docs/credit-costs) table for current billing. A map call costs 1 credit, a search call costs 2 credits, and crawl jobs charge 1 credit at start plus one additional credit per page as pages are discovered during polling. The FREE plan grants 500 credits once, for the lifetime of the account, not monthly, and they never reset, plus up to 500 more from onboarding tasks. Purchased top-up credits never expire and survive plan cancellation. Self-hosted deployments have no billing layer and are unaffected by credit costs. Check your balance with `GET /api/v1/account/balance` on the SaaS control-plane. See [Credit Costs](/docs/credit-costs) for the full table.
---
diff --git a/docs/docs/installation.md b/docs/docs/installation.md
index 7164387c..d59be73a 100644
--- a/docs/docs/installation.md
+++ b/docs/docs/installation.md
@@ -2,7 +2,9 @@
## Cloud (no installation needed)
-Sign up at [fastcrw.com](https://fastcrw.com) and start using the API immediately.
+Skip installation and get a free API key for fastCRW Cloud, or install the self-hosted engine as a single binary, Docker container, or Homebrew formula.
+
+Sign up at [fastcrw.com/register](https://fastcrw.com/register?ref=docs-installation-inline) and start using the API immediately.
Native `/v1` endpoints for new CRW integrations, with `/firecrawl/v2` compatibility available for Firecrawl migrations.
```bash
@@ -12,6 +14,11 @@ curl -X POST https://api.fastcrw.com/v1/scrape \
-d '{"url": "https://example.com"}'
```
+:::note
+500 credits to start, up to 500 more from onboarding tasks, no card.
+Get your API key
+:::
+
## One-Line Install (Recommended)
The install script auto-detects your OS and architecture, downloads the latest binary, and installs it:
diff --git a/docs/docs/introduction.md b/docs/docs/introduction.md
index 0ea10d45..d883c3a0 100644
--- a/docs/docs/introduction.md
+++ b/docs/docs/introduction.md
@@ -3,7 +3,7 @@
Turn websites into usable data with one API. Start with a single scrape request, then move into search, map, crawl, extract, or MCP only when your workflow actually needs them. Interactive browser automation is handled by the companion crw-browse service.
Open-source web scraping API for agents and RAG. Scrape, crawl, search, map, and extract data from any site with one Rust binary, self-hosted or on fastCRW Cloud.
npx crw-mcp@latest install to add the MCP server and skill, then use the crw_scrape, crw_search, crw_map, and crw_crawl tools (or the native /v1 REST API) to fetch, search, and crawl the web with the CRW_API_KEY in my environment.
+:::
+
+Full reference written for autonomous agents: [Agent Onboarding Guide](/agent-onboarding).
+
+## Pick your endpoint
+
+:::cards
+::card{icon="code" title="Scrape" href="#scraping" description="One known URL in, clean markdown or JSON out."}
+::card{icon="search" title="Search" href="#search" description="No URL yet? Search the web and get ranked results with content."}
+::card{icon="map" title="Map" href="#map" description="Discover every URL under a domain before you scrape or crawl."}
+::card{icon="layers" title="Crawl" href="#crawling" description="Scrape every page under a URL in one background job."}
+::card{icon="key" title="Extract" href="#extract" description="Pull structured JSON fields from a page with an LLM."}
+::card{icon="plug" title="MCP" href="#mcp" description="Give Claude, Cursor, Codex, and other agents live web access."}
+:::
+
> **New to CRW? Use `/v1`.** The `/v1` routes are the native fastCRW API for new integrations. Use `/firecrawl/v2` when migrating existing Firecrawl v2 SDK code or when you need compatibility-only routes such as batch scrape or PDF parse.
https://api.fastcrw.comchunkStrategy is an optional request field on POST /v1/scrape that tells the engine to split the page's markdown into smaller pieces server-side before returning it. You supply an object with a type ("topic" to split on headings, "sentence" to split on punctuation, or "regex" for a custom pattern), an optional maxChars cap per chunk, and an optional dedupe flag to drop near-duplicate chunks. The engine returns the chunks as a chunks array alongside the normal markdown field — no text-splitting library needed on the client side. Note that chunkStrategy only works on POST /v1/scrape; it is not forwarded by batch or crawl jobs. See the RAG recipe for a complete example.
A credit is the billing unit for the hosted cloud at fastcrw.com, worth $0.001. Every scrape costs 1 credit regardless of renderer (HTTP, lightpanda, or Chrome); there is no renderer or proxy surcharge. LLM-backed work (POST /v1/extract, or formats: ["json"] / summary on scrape) costs that 1-credit base render plus the actual LLM cost of the call, dynamically metered: there is no flat credit number for it. See the Credit Costs table for current billing. Map and search start-calls each cost 1 credit, and crawl jobs charge 1 credit at start plus one additional credit per page as pages are discovered during polling. The FREE plan grants 1000 credits once, for the lifetime of the account, not monthly, and they never reset. Purchased top-up credits never expire and survive plan cancellation. Self-hosted deployments have no billing layer and are unaffected by credit costs. Check your balance with GET /api/v1/account/balance on the SaaS control-plane. See Credit Costs for the full table.
A credit is the billing unit for the hosted cloud at fastcrw.com, worth $0.001. Every scrape costs 1 credit regardless of renderer (HTTP, lightpanda, or Chrome); there is no renderer or proxy surcharge. LLM-backed work (POST /v1/extract, or formats: ["json"] / summary on scrape) costs that 1-credit base render plus the actual LLM cost of the call, dynamically metered: there is no flat credit number for it. See the Credit Costs table for current billing. A map call costs 1 credit, a search call costs 2 credits, and crawl jobs charge 1 credit at start plus one additional credit per page as pages are discovered during polling. The FREE plan grants 500 credits once, for the lifetime of the account, not monthly, and they never reset, plus up to 500 more from onboarding tasks. Purchased top-up credits never expire and survive plan cancellation. Self-hosted deployments have no billing layer and are unaffected by credit costs. Check your balance with GET /api/v1/account/balance on the SaaS control-plane. See Credit Costs for the full table.
"Firecrawl-compatible" means fastCRW exposes a /firecrawl/v2 compatibility layer for existing Firecrawl v2 SDK integrations. It is intentionally close enough for migration work, but it is not the recommended API for new fastCRW builds. New projects should start with /v1; migration projects should validate the documented differences before switching production traffic. See Migrate from Firecrawl for the exact list of changes and Compatibility for the behavior matrix.