Skip to main content
GET
Get overlay
Returns the full details for an overlay, including all image URLs and change data.

Image URLs

Running Vision Analysis

The changes and clashes arrays are populated after running Vision API analysis:

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

Success

data
object
Example: