Skip to main content
Extract reads pages and fills the fields you name, and leaves out a field the page does not state. The call answers with an id, and you read the fields from GET /v1/extract/{id}.

Make a request

Get an API key in the Quickstart. Extract needs an API key. This request reads a documentation page and fills four fields, then reads the result with the id it gets back.

Read the response

The call that starts the extract answers with the id of the result. invalidURLs lists addresses it skipped because they are not public pages.
GET /v1/extract/{id} returns the fields.
pricePerMonth is not in data: the page does not state it, so the field is left out. Each value is checked against the page text, and confidence says how sure Stophy is that it is there, from 0 to 1. See Results for the rest of the fields.

Request fields

The schema is described in Schema. showSources, timeout and webhook are described in Results. These fields belong to this page. With a prompt and no schema, the model names up to 20 fields in camelCase.

Price

$5 per 1,000 pages for most calls: $1 for the page and $4 for the extraction. Each page after the first adds $1 per 1,000 pages, and a long answer adds $1 per 1,000 pages for every 64 values after the first 64, for each 40,000 characters of page text read. `enableWebSearch` adds $1 per 1,000 searches, and allowExternalLinks adds $1 per 1,000 pages read. A call that finds none of the fields is free. See Pricing.

Choose another API

  • Scrape returns the whole page, and json fills a schema from one page.
  • Agent searches and reads several pages, then fills your fields with a quote for each.
  • Search finds pages from a query.
  • Crawl reads every page of a site in the background.
  • Parse documents turns a file you hold into Markdown.