Skip to main content
POST
Compare stored screenshots

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
before
object
required
after
object
required
mode
enum<string>
default:perceptual
Available options:
pixel,
perceptual
visualization
enum<string>
default:overlay
Available options:
overlay,
heatmap,
mask,
none
async
boolean
default:false
webhookUrl
string<uri>
webhookSecret
string
write-only
storage_provider
enum<string>
Available options:
b2,
s3,
r2
storage_path
string
default:diffs

Response

Completed comparison

success
boolean
required
type
string
required
Allowed value: "diff"
before
object
required
after
object
required
diff
object
required
credits
object
required
media
object | null