Extract Markdown

Turn any public web page into clean Markdown. scope keeps either the article body or the whole page, and include_metadata adds the page's title, author, published date and image. Handles pages that render themselves in the browser at effort: max.

post/global/extract/markdown/v1

Request

Base URL: https://api.croma.run
URL: https://api.croma.run/global/extract/markdown/v1
Auth: HTTP bearer

Headers

Idempotency-Keystring

Example:0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Request body

urlstring uri required

Public http or https URL of the page to read. Loopback and private addresses are not accepted.

scope'main' | 'full'

main keeps the article body and drops navigation and boilerplate; full keeps the whole page.

effort'min' | 'standard' | 'max'

Effort to spend on the page: min is fastest and may serve a recent copy, standard is the balanced default, max always reads the page live and handles pages that render themselves in the browser.

include_metadataboolean

Include the page's title, author, published date and image in the response.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.