extract

Extract Structured

Extract JSON in your schema from up to 100 pages.

Returns one result per URL: {url, data, confidence, error}. A page that fails, or lacks the fields, gets an error without failing the request.

post/v1/extract

Request

  • Base URL: https://api.snoopscan.com
  • URL: https://api.snoopscan.com/v1/extract
  • Auth: none declared

Headers

authorizationstring nullable

Request body

schemaobject nullable

Your own JSON Schema for the fields you want. Give this or template, not both.

templatestring nullable

A named template instead of a schema — product, article, jobPosting and more. GET /v1/templates lists them with their fields.

urlsstring[] required

The pages to extract from, 1 to 100. Each page gets its own result.

promptstring nullable

Plain-language guidance on what to pick out, e.g. "the cheapest paid plan".

Response

Successful Response

object required

Changes

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