API reference · Context.dev

context-dev/scrape-html

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APIAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDcontext-dev/scrape-html

Input Schema

9 parameters · 1 required · 8 optional

Parameter	Type	Required	Description
`url`	string	Required	Full URL to fetch, including the http:// or https:// scheme.
`zdr`	string	Optional	Set 'enabled' to bypass Context.dev's shared caches and omit request and response content from its retained usage logs. Requires zero data retention on the Context.dev organization, otherwise the call fails with ZDR_NOT_ENABLED. · Options: enabled, disabled enableddisabled
`country`	string	Optional	Two-letter ISO 3166-1 alpha-2 country code (e.g. 'us', 'gb', 'de'). Must be one of Context.dev's supported countries. · Min length: 2 · Max length: 2
`maxAgeMs`	integer	Optional	Reuse a cached result younger than this many milliseconds. Default 86400000 (1 day), max 2592000000 (30 days). Set 0 to always fetch fresh. · Min: 0 · Max: 2592000000
`timeoutMS`	integer	Optional	Upstream timeout in milliseconds (max 300000). Context.dev aborts the call with a 408 when exceeded. Keep it below the endpoint's requestTimeoutMs so the provider answers before the platform's own budget expires. · Min: 1000 · Max: 300000
`waitForMs`	integer	Optional	Extra browser wait in milliseconds after page load before the content is captured (0-30000). Useful for JavaScript-heavy pages. · Min: 0 · Max: 30000
`includeFrames`	boolean	Optional	Render iframes inline into the returned HTML. Default false.
`settleAnimations`	boolean	Optional	Wait briefly for CSS and transition animations to settle before the HTML is captured. Default false.
`useMainContentOnly`	boolean	Optional	Keep only the page's main content, dropping headers, footers, sidebars, and navigation when detectable. Default false.

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "context-dev/scrape-html",
  "prompt": "a beautiful sunset over mountains"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to Scrape HTML