Skip to main content

Surface reference

Every surface has key, label, type, and optional icon and description fields.

frontendPage​

{key, label, type: 'frontendPage', page}

page is a reference to frontendPages.

dataWorkspaceView​

{key, label, type: 'dataWorkspaceView', table, viewKey?}

table references dataWorkspaceTables. viewKey selects a declared view from that table.

document​

{key, label, type: 'document', document?, documentFolder?}

Provide exactly one document or document folder reference.

chat​

{
  key,
  label,
  type: 'chat',
  preset: {
    workflow,
    space?,
    outputDocumentFolder?,
    allowedTools?,
    initialMessage?,
    instructions?,
    showModelSelector?,
    showBrowserControls?,
    showAttachments?,
    expectedOutput?,
  },
}

workflow is required. allowedTools may contain only workflow.launch; expectedOutput may be only document.

contentScheduler​

{key, label, type: 'contentScheduler', documentFolder?, space?}

Use the optional bindings to scope the scheduler to app-owned content.