Skip to content
Port OS

GenerativeUiCreateSurface

HTTP API schema

Creates the surface. `catalogId` is the basic catalog, or the Port OS TV catalog when the surface uses `Timer`. `components` must define the component with id `root` unless a later `updateComponents` does.

GenerativeUiCreateSurface fields

surfaceIdstringRequired
catalogIdstringRequired

Allowed values

  • https://a2ui.org/specification/v1_0/catalogs/basic/catalog.json
  • https://portoperatingsystem.com/a2ui/catalogs/tv/v1/catalog.json
componentsarray<GenerativeUiComponent>
dataModelobject

The initial data model. Components read it with @path bindings, for example {"@path": "/pointer"}.

View source specification ↗