ONon-page
Scheduled scans

Create a recurring diagnostic scan schedule.

Runs while the desktop app is closed. Each occurrence uses the caller's On-Page.ai credits, enforces per-run and monthly budgets, and never performs unattended site edits.

post/v1/scheduled-scans

Request

Request body

namestring required
urlstring uri required
keywordstring required

Primary search keyword. Whitespace is normalized. Must be a concise search query: max 150 characters.

depth'lite' | 'standard' | 'deep'
region'US' | 'CA' | 'UK' | 'AU' | 'NZ' | 'ES' | 'DE' | 'IT' | 'FR' | 'IE' | 'NL' | 'CH' | 'SE' | 'NO' | 'DK' | 'FI' | 'ZA' | 'MX' | 'BR' | 'CO' | 'IN' | 'SG' | 'MY' | 'JP' | 'KE' | 'AE' | 'HK'

Region code. Case-insensitive and trimmed on input. Use canonical uppercase codes in response bodies. See GET /v1/regions.

localestring

BCP-47 locale tag. Canonicalized via Intl.Locale (en_us → en-US; zh_hant_hk → zh-Hant-HK). Max 16 chars.

max_credits_per_runnumber required
monthly_credit_budgetnumber required

Example request

{
  "region": "uk",
  "locale": "en-GB"
}

Response

Schedule created.

Changes

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