Extract

AI structured extraction across one or many URLs.

POST/api/v1/extract5 / URL

Give Peep a set of URLs plus a schema or prompt, and it scrapes them and returns structured data conforming to your shape. Runs asynchronously; poll for the result.

Request

ParameterTypeDescription
urlsrequiredstring[]URLs to extract from. Supports wildcard paths.
promptstringNatural-language description of what to extract.
schemaobjectA JSON schema the output must conform to.
enableWebSearchbooleanLet the extractor follow the web for missing details. Defaults to false.
showSourcesbooleanInclude the source URLs each value came from. Defaults to false.

Example

bash
curl -X POST https://peep.shownomore.com/api/v1/extract \
  -H "Authorization: Bearer peep_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
  "urls": [
    "https://example.com"
  ],
  "prompt": "Extract the company name and pricing tiers.",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string"
      }
    }
  }
}'

Poll GET /api/v1/extract/{jobId} for the structured result.