Batch Scrape API Reference

Submit a batch scrape when an agent needs several pages converted into stable Markdown with shared provenance.

Request

curl -X POST https://api.example.test/v1/batch \
  -H 'authorization: Bearer token' \
  -H 'content-type: application/json' \
  -d '{"urls":["https://example.com/a","https://example.com/b"],"formats":["markdown","metadata"]}'

Parameter	Type	Required	Description
urls	array<string>	yes	Absolute HTTP URLs to extract.
formats	array<string>	no	Requested outputs such as markdown and metadata.
timeout_ms	integer	no	Per-page deadline for deterministic agent runs.

Response

{
  "documents": [
    {"url": "https://example.com/a", "markdown": "# Alpha", "metadata": {"content_sha256": "abc"}}
  ]
}

Stable error envelopes let agents retry only the failed URLs.

UNLABELED_FENCE_SHOULD_STAY_BALANCED=true