Extract
Pull the fields you name from any public page as JSON, each checked against the page. Send one request and get JSON back.
Price
5 credits for most pages: the page’s own price plus 4 credits. A call that finds none of the fields is free. See Pricing for what credits cost.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.
x >= 1Body
The pages to read, up to 10, such as ["https://bun.com/blog/bun-v1.3"]. With more than one, the fields are filled from all of them together. A page that cannot be read is skipped and named in warning, and costs nothing. The call fails only when no page can be read.
1 - 10 elements2048The fields to fill, as a JSON Schema (draft-07 or 2020-12) object with properties. Pydantic's model_json_schema() and zod's toJSONSchema() output work as they are. enum, const, anyOf, oneOf, nullable types, $ref with $defs, required, descriptions and any key names are read. Up to 100 top-level fields and 32 KB. A field the page does not state comes back null.
What to pull from the pages in plain words, such as the version and the release date.
1 - 500How to read each page, the same options as scrape.
Send true to keep nothing from this call: pages are read live, the result is held for one hour at most, and nothing is logged. Costs 1 credit more per page.
Skip addresses that are not public website URLs. Send false to refuse the call instead.