Extract Content

Extract clean markdown or HTML from any URL with sync or async mode support

Authorization

APIKeyHeader

X-Api-Key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*Url

URL to extract content from

formats?array<>

Output formats to return

render_js?Render Js

If true, uses a headless browser to render the page (slower, more expensive).

processing_mode?ProcessingMode

Processing mode: sync (block until done) or async (starts job and return job ID)

proxy?|

Proxy configuration. Optional — when omitted or explicitly null, defaults are applied: residential type, country auto-resolved from the target URL (domain/path overrides first, then the TLD; if nothing matches, the upstream proxy provider picks the exit region). Send an object to override either field; individual fields inside the object may also be null (see ProxySettings).

headers?|

Custom HTTP headers to include in extraction request

wait_config?|

Grouped browser wait policy. Optional: when omitted or null, browser requests use the adaptive default settle policy whenever a browser runs. Send a non-null object to opt into caller-owned explicit wait mode, which skips the adaptive default settle phase. Null fields inside wait_config behave the same as absence. If render_js is not set explicitly, any non-null wait_config auto-enables browser rendering and the effective render_js value is returned in metadata. If render_js=false is sent together with a non-null wait_config, the request is rejected as ambiguous.

Response Body

`application/json`

curl -X POST "https://example.com/v1/extract" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com"  }'

{
  "data": {
    "html": "string",
    "markdown": "string"
  },
  "metadata": {
    "url": "string",
    "render_js": true,
    "http_status": 0,
    "duration_ms": 0,
    "formats": [
      "markdown"
    ],
    "proxy": {
      "country": "string",
      "type": "datacenter"
    },
    "processing_mode": "sync",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "wait_config": {
      "wait_until": "commit",
      "wait_for": "string",
      "wait_timeout": 0
    }
  },
  "tokens_charged": 0
}

{
  "job_id": "string",
  "status": "queued",
  "status_url": "string",
  "estimated_tokens": 0
}

{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true
}

{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true
}

{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "string",
    "retryable": true,
    "details": {
      "property1": "string",
      "property2": "string"
    }
  },
  "tokens_charged": 0
}

{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true
}

{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true
}

{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true
}

Extract Content

Authorization

Request Body

Response Body

200application/json

202application/json

400application/json

401application/json

402application/json

422application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`