tools

Extract main article content from web pages using readability detection

post/tools/extract_content

Request

  • Base URL: https://www.crawlforge.dev/api/v1
  • URL: https://www.crawlforge.dev/api/v1/tools/extract_content
  • Auth: API key in header X-API-Key

Request body

urlstring uri required

The URL to extract content from

include_imagesboolean

Include images found in the content

include_linksboolean

Include links found in the content

clean_htmlboolean

Return clean text instead of HTML: one line per block element (heading, paragraph, list item, table row)

extract_main_contentboolean

Use readability algorithms to find main content

timeoutnumber

Request timeout in milliseconds (1000-30000)

respect_robotsboolean
max_inline_charsinteger

Largest result returned inline, in characters of its JSON (1000-10000000; env CRAWLFORGE_MAX_INLINE_CHARS sets the default). Over it, the result is stored for 1 hour and the response carries a preview, a result_handle, total_chars and truncated: true; read the rest with read_result (1 credit).

Response

The tool's result; 2 credits charged (see x-credits-note and x-extra for add-ons).

successtrue required
dataobject required

The tool's result. Its shape is tool-specific and documented on the tool's docs page (x-docs-url on the operation).

credits_usedinteger required

Credits charged for this call: the operation's x-credits, plus any add-on x-credits-note or x-extra describes.

credits_remaininginteger required

The account's credit balance after this call.

processing_timeinteger required

Server-side processing time in milliseconds.

warningsstring[]

Non-fatal notes: a robots.txt override that was recorded, a format that could not be produced, a redaction that changed the payload.

Changes

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