tools

Extract structured data matching a JSON Schema from CSS selector hints, JSON-LD structured data, and OpenGraph/meta tags. LLM-guided extraction is available via the CrawlForge MCP server, not this endpoint.

post/tools/extract_structured

Request

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

Request body

urlstring uri required

The URL to extract structured data from

promptstring

Accepted for compatibility; only used by the MCP server LLM extraction

selectorHintsobject

CSS selectors per schema property, checked before structured data

fallbackToSelectorsboolean

When false and required fields are set, extracting nothing returns EXTRACTION_FAILED instead of nulls

respect_robotsboolean

Response

The tool's result; 3 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.