Submit multiple URLs for concurrent extraction

Queue a list of URLs for concurrent extraction and return a job_id immediately — this endpoint is asynchronous and does not wait for the work to finish.

Queue a list of URLs for concurrent extraction and return a job_id immediately — this endpoint is asynchronous and does not wait for the work to finish.

Poll GET /bulk/{job_id} for progress and results, or supply webhook_url to be notified on completion instead of polling. The response includes webhook_signing_secret the first time you use a webhook; store it, as it is shown once.

Individual URLs can fail without failing the job: each entry in results carries its own status, so a partial success is normal and is reported as a 200. The per-request URL cap depends on your plan.

Send Idempotency-Key to make retries safe — the same key with the same body returns the original job rather than queuing a second one. Metered as one request per URL submitted.

Authorization

BearerAuth

AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer wm_.... Keys are wm_ followed by 40 hex characters. Create one with POST /register (free, no auth) or POST /keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

allow_domains?array<string>|

Restrict this job to these domains. Narrowing only — see ExtractRequest.allow_domains.

deny_patterns?array<string>|

Additional URL patterns to refuse. Narrowing only.

format?Format

Output shape, applied to every URL in the job. Same set /extract accepts; json and chunks are Pro+.

Default"markdown"

Value in

"markdown"
"json"
"chunks"
"html"
"links"

render_js?Render Js

Render every URL in a headless browser before extracting. Pro+ only.

Defaultfalse

respect_robots?|

Override robots.txt handling. lax→strict only.

retry?Retry

Extra attempts per URL if the fetch times out. Workers absorb the wait, so larger values are practical here than on the synchronous /extract.

Range0 <= value

Default0

urls*array<>

URLs to extract, processed concurrently. Must be non-empty. The per-request cap depends on your plan; exceeding it returns 422 bulk_cap_exceeded. Billed as one request per URL.

webhook_include_results?Webhook Include Results

Inline the full results array in the webhook payload. Default false sends job metadata plus a results_url to fetch from. Inlined payloads are capped at ~5 MB; over that we fall back to the thin shape and set results_truncated_for_size.

Defaultfalse

webhook_url?|

Receive a signed POST when the job finishes, instead of polling. Must be https://; loopback and private hosts are rejected at submit time as an SSRF guard. The first webhook job returns a webhook_signing_secret — store it, it is shown once.

Response Body

`application/json`

curl -X POST "https://api.wellmarked.io/bulk" \  -H "Authorization: Bearer wm_your_api_key_here" \  -H "Content-Type: application/json" \  -d '{    "urls": [      "http://example.com"    ]  }'

{  "completed": 0,  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",  "job_token": "string",  "kind": "bulk",  "results": [    {      "blocks": [        {          "level": 0,          "text": "string",          "type": "heading"        }      ],      "chunks": [        {          "end_token": 0,          "start_token": 0,          "text": "string"        }      ],      "error": "string",      "html": "string",      "links": [        "string"      ],      "markdown": "string",      "metadata": {        "author": "string",        "date": "string",        "retrieved_at": "2019-08-24T14:15:22Z",        "title": "string",        "url": "string"      },      "metrics": {        "content_bytes": 0,        "input_tokens": 0,        "output_tokens": 0,        "reduction_pct": 0,        "tokens_saved": 0      },      "url": "string"    }  ],  "status": "string",  "total": 0,  "webhook_signing_secret": "string"}

Submit multiple URLs for concurrent extraction

Authorization

Request Body

Response Body

200application/json

401application/json

402application/json

403application/json

409application/json

422application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`