Web Fetch API

Lexmount Web Fetch is the public API for fetching web pages, rendering when needed, and returning structured output without building your own scraping pipeline.

What It Covers

• POST /v1/extract for all-in-one structured extraction
• POST /v1/dom/dump for captured HTML and DOM snapshot reuse
• dom_id reuse between fetch and extract flows
• trace and raw DOM controls for debugging
• common HTTP and API error handling patterns

Authentication

• External requests must include both X-API-Key and X-Project-Id
• Create or copy them from API key settings on the current site
• Use https://api.lexmount.com for COM projects and https://api.lexmount.cn for CN projects; credentials must match the API region

Start Here

• Quick Start for the first request, response shape, and when to use dump-dom
• All-in-One Extract for the full /v1/extract request and response contract
• Dump DOM for engine selection, HTML capture, and dom_id reuse
• Common Errors for integration troubleshooting

Typical Workflow

1. Call POST /v1/extract with extract.url for the normal production path.
2. If you need workflow diagnostics, explicitly enable trace.include_steps.
3. If extraction fails or you need to inspect captured HTML, call POST /v1/dom/dump.
4. Reuse the returned dom_id in /v1/extract to separate fetch problems from extraction problems.

Common Output Fields

The most common result fields are:

• title
• description
• main_text
• final_url
• author
• publish_time
• links
• images
• engine
• dom_id

Integration Scope and Usage

The public API exposes the two POST endpoints above. Web Fetch targets public HTTP/HTTPS pages and does not inherit Cloud Browser session cookies, Contexts, or proxy settings. For login, clicks, or company-network access, use Cloud Browser; see SDK local proxy for private-network access.

Successful calls to either endpoint report Web Fetch usage. Dumping and then extracting are two calls; reusing dom_id does not make extraction free of usage. Reporting is asynchronous, so a client timeout alone does not prove that no usage was recorded. Included allowance is consumed before purchased balance. Check available requests in Plans & Usage and current offers on Pricing.

The Web Fetch playground runs both endpoints. Signed-in users use their own project. Environments with guest trials enabled display the applicable guest limits; a guest trial does not make the public API unauthenticated.

Free included Web Fetch allowance is shared across projects linked to the same account identity; replacing a key or deleting and recreating a project does not grant a fresh allowance. Purchased pack balance remains attached to the project it was bought for.