Skip to main content
Represents the properties required to initialize and configure a graph builder.
type GraphBuilderProps = {
    apiKey?: string;
    appName?: string;
    appVersion?: string;
    enableRemoteConfig?: boolean;
    id: string;
}

Properties

apiKey (optional)

apiKey?: string
An optional Inworld API key. In order for Remote nodes to work, you need to pass it here or via environment variable INWORLD_API_KEY. Default Value: Process environment variable INWORLD_API_KEY

appName (optional)

appName?: string
An optional name of the application utilizing the graph builder. Used in observability reporting.

appVersion (optional)

appVersion?: string
An optional version of the application utilizing the graph builder. Used in observability reporting.

enableRemoteConfig (optional)

enableRemoteConfig?: boolean
An optional flag to enable remote config, which allows one-click experiment deployment from Inworld portal. Default Value: false

id

id: string
A unique identifier for the graph instance. This field is required.