Skip to content
AIDE
Sign up
post/v1/scans

Create a new scan

Accepts a URL + optional metadata. The scan runs asynchronously; stream progress via the `stream_url` or poll `result_url`.

Request body

  • urlstring <uri>Required
  • site_typeanyOfOptional
  • depthintegerOptional
  • js_renderbooleanOptional
  • priorityenum (2)Optional
  • webhook_urlanyOfOptional
  • metadataobjectOptional
  • profileenum (2)Optional

    Which check suite a scan asks for. Profile is orthogonal to ``site_type``: a "content" site can be scanned with the AI Agent-Ready suite *or* the SEO suite, and each suite weights its categories differently. Adding a profile is intentionally cheap — the registry filters by check class attribute so we never have to maintain a parallel inventory. Yeni bir profile eklemek için: bu enum'a satır ekle, ilgili check sınıflarının ``profiles`` frozenset'ine yeni profili koy. Frontend tarafında ``apps/web/src/lib/profiles.ts`` registry'sine de ekleme şart (UI route klasörü + i18n key'leri için).

  • seo_keywordsarrayOptional
  • seo_target_countryanyOfOptional
  • seo_competitorsarrayOptional

Responses

  • 202Successful Response
    • scan_idstringRequired
    • statusenum (5)Required
    • created_atstring <date-time>Required
    • estimated_duration_secondsintegerOptional
    • stream_urlstringRequired
    • result_urlstringRequired
    • cachedbooleanOptional
  • 422Validation Error
    • detailarrayOptional
POST /v1/scans | AIDE