Quick Start

Use Lexmount WebFetch when you want structured content from a public web page without building your own fetch, rendering, and extraction pipeline.

The most practical starting point is POST /v1/extract.

Authentication

• The API is currently in internal testing
• External requests must include X-API-Key
• Contact an administrator to get your API key

Send Your First Request

API_KEY='<your-api-key>'

curl -sS -X POST https://webfetch.lexmount.com/v1/extract \
  -H 'content-type: application/json' \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "extract": {
      "url": "https://example.com"
    }
  }'

Typical response:

{
  "result": {
    "url": "https://example.com",
    "final_url": "https://example.com",
    "status_code": 200,
    "title": "Example Domain",
    "description": "Example Domain",
    "main_text": "Example Domain This domain is for use in illustrative examples in documents.",
    "engine": "http",
    "template_id": "generic:v1",
    "dom_id": "dom_123"
  },
  "metadata": {
    "dom_id": "dom_123",
    "template_id": "generic:v1",
    "server_elapsed_ms": 1234
  }
}

What You Get

POST /v1/extract is the all-in-one endpoint. It handles:

• page fetching
• template matching
• background generation when needed
• final structured extraction

Common fields in result include:

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

When To Use Dump DOM

Use POST /v1/dom/dump when you need the captured HTML itself, want to inspect rendering output, or want to reuse a dom_id in a later extraction request.

curl -sS -X POST https://webfetch.lexmount.com/v1/dom/dump \
  -H 'content-type: application/json' \
  -H "X-API-Key: $API_KEY" \
  -d '{"url":"https://example.com"}' \
  | jq '{final_url, engine, dom_id, dump_path, html_len:(.html|length)}'

Adjust Defaults

POST /v1/extract returns trace by default, and does not return raw_dom by default.

• If you want a smaller response and want to disable trace, see Disable Trace
• If you need raw_dom in the response, see Return Raw DOM

Next

• See All-in-One Extract for the full /v1/extract request and response shape
• See Dump DOM for /v1/dom/dump options and reuse patterns
• See Common Errors for troubleshooting guidance