Skip to content
Port OS

GenerativeUiInterfaceGetSurfaceResponseMessage

HTTP API schema

The surface the device holds: its flat A2UI components, data model, last applied sequence, visibility and the screen it is drawn on, so an agent that reads the surface knows how it fits.

GenerativeUiInterfaceGetSurfaceResponseMessage fields

surfaceIdstring

The surface id, or null when the device holds no surface.

nullable: true

visiblebooleanRequired

False when the viewer left the surface; it stays held until closed or replaced.

sequenceintegerRequired

The last applied sequence of the surface (0 when none).

minimum: 0

componentsarray<GenerativeUiComponent>Required

The components of the surface in the flat A2UI form.

dataModelobject

The surface's data model.

displayGenerativeUiDisplayRequired
View source specification ↗