Skip to content

docs: Pergamon page - #616

Open
behramcelen wants to merge 2 commits into
mainfrom
feature/571-data-api-docs
Open

behramcelen wants to merge 2 commits into
mainfrom
feature/571-data-api-docs

Conversation

@behramcelen

Copy link
Copy Markdown
Collaborator

Documents the cloud-only /v1/data surface shipping in crw-saas#730 (NanofyOU/tickets#571).

Covers the free catalog endpoint, calling a capability, the provenance block field by field, credits and automatic refunds, the licence-driven cache TTL, the error table, and worked curl/JS/Python examples.

Includes why a 200 can still come back as a 502: several official data sources answer 200 with an HTML error page or a WAF challenge, so content type and JSON parse are the real status check and the credit is refunded.

Sidebar entry under More APIs. Markdown source in docs/docs/data-api.md, pages regenerated with scripts/build-docs-pages.mjs, scripts/docs-guards.sh passes.

@github-actions

Copy link
Copy Markdown
Contributor

Thanks for the pull request. Before we can merge it, please read our Contributor License Agreement and sign it by posting the comment below in this PR.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

Pergamon is the fastCRW data API — the cloud-only /v1/data surface. The page
documents the free catalog endpoint, how to call a capability, the provenance
block and what each field is for, credits and refunds, the licence-driven cache
TTL, and the error table.

Includes why a 200 can still come back as a 502 — several official data sources
answer 200 with an HTML error page or a WAF challenge, so the content type and
the JSON parse are the real status check and the credit is refunded.

Sidebar entry under More APIs. Generated pages regenerated with
scripts/build-docs-pages.mjs; docs-guards.sh passes.

Part of NanofyOU/tickets#571.
@behramcelen
behramcelen force-pushed the feature/571-data-api-docs branch from c115eb7 to 2aa7710 Compare October 11, 2026 22:10
@behramcelen behramcelen changed the title docs: Data API page docs: Pergamon page Oct 11, 2026
The `pergamon` array on POST /v2/scrape, deliberately Firecrawl's Alexandria
shape with one word changed, and the three-level find-tools walk that carries
free discovery.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants