Skip to main content
POST
Text read of a frame (what's on screen)

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
required
room_name
string
room_description
string

Response

Scene perception.

summary
string
visible
string[]
affordances
string[]
exits
string[]
mock
boolean

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