scans

Get a scan

Return one scan with its per-category results and screenshot URLs.

Poll this to follow progress: status moves queued → scanning → summarizing → complete, or to failed. Screenshot URLs are pre-signed and short-lived — fetch them promptly rather than storing them.

Answers 404 for a scan that does not exist and for one belonging to another account, so scan ids cannot be enumerated.

get/api/v1/scans/{scan_id}

Request

  • Base URL: https://api.sytecheck.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.sytecheck.app/api/v1/scans/{scan_id}
  • Auth: HTTP bearer

Path parameters

scan_idinteger required

Response

Successful Response

idinteger required
urlstring required
labelstring nullable required
status'queued' | 'scanning' | 'summarizing' | 'complete' | 'failed' required
categories_requestedstring[] required
overall_scorenumber nullable required
error_messagestring nullable
webhook_urlstring nullable
quota_refunded_atstring date-time nullable
used_scan_creditboolean
created_atstring date-time required
completed_atstring date-time nullable required

Changes

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