For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/genui/openui/core/interfaces/OpenUIError.md.
Lynx
  • English
  • Interface: OpenUIError

    Structured, LLM-friendly error from the openui-lang pipeline.

    Designed for an automated correction loop: send these to the LLM so it can generate patches. Only includes errors that are fixable by changing the openui-lang code — transient streaming errors, network failures, and tool execution errors are excluded.

    Properties

    code

    code: OpenUIErrorCode

    Machine-readable error code.


    component?

    optional component?: string

    Component type name (e.g. "BarChart", "Query").


    hint?

    optional hint?: string

    Actionable fix context for the LLM (e.g. available components, correct signature).


    message

    message: string

    Human/LLM-readable description of what went wrong.


    path?

    optional path?: string

    Prop path (e.g. "/title").


    source

    source: OpenUIErrorSource

    Where the error originated.


    statementId?

    optional statementId?: string

    Statement name (e.g. "header", "metrics") — tells the LLM which statement to patch.


    toolName?

    optional toolName?: string

    Tool name for query/mutation errors (e.g. "get_users", "create_item").

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.