Skip to main content
POST
Closed-vocab hotspot detection (pin choices to objects)

Authorizations

Authorization
string
header
required

An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) is read-only (browser-safe).

Body

application/json
frame_b64
string

Base64 frame (alias: frame_jpeg_base64).

frame_jpeg_base64
string
location_name
string
npc_present_slugs
string[]
expected_choices
object[]

Response

Hotspots.

Hotspot boxes for detected objects. bbox is [x,y,w,h] in 0-1000 normalized image space.

hotspots
object[]
mock
boolean

Present and true only for TEST-mode keys. See Testing.