inspector

Start scans

Start a durable AI-readiness scan of one public website URL and of up to five of its competitors' sites beside it, each its own Inspector scan billed as one. Inspector chooses the competitors: those the organization's business profile for the site names (none when it names none). Poll inspector_scans_get_v2 with the returned scanId, or platform_runs_get_v2 with runId, then read inspector_scan_results_get_v2 once it is complete; the scan's report lists its competitors' scores.

post/api/v1/inspector/scans/start

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/inspector/scans/start
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

urlstring uri required

Full URL to scan (e.g. https://example.com)

Response

Accepted: the durable run started. Follow it with GET /api/v1/platform/runs-v2/{id}.

runIdstring required

Billing run id; poll with platform_runs_get_v2

status'pending' | 'complete' required

pending = the scan is running; complete = this operation already finished

scanIdstring required

Changes

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