Skip to main content
DELETE
Delete overlay
Permanently delete an overlay and its associated images.
Deleting an overlay does not affect the source blocks or drawings. You can always re-create the overlay by running the comparison again.

Authorizations

Authorization
string
header
required

API key prefixed with sk_. Example: Authorization: Bearer sk_xxx

Headers

X-API-Version
string
default:2026-01-01

API version

Path Parameters

overlay_id
string
required

Overlay ID

Response

Overlay deleted.

deleted
enum<boolean>
required
Available options:
true