Interface: KabooProviderProps¶

Defined in: src/context/KabooProvider.tsx:15

Props for KabooProvider.

Properties¶

a2ui?¶

optional a2ui?: object

Defined in: src/context/KabooProvider.tsx:69

The A2UI catalog, theme and action handler.

catalog?¶

optional catalog?: any

Optional component catalog to pass to the A2UI renderer. When omitted, the default basicCatalog is used.

includeSchema?¶

optional includeSchema?: boolean

When true (the default), the full component schemas from the catalog are sent as agent context so the agent knows what components and props are available. The A2UI middleware can overwrite this with a server-side schema if configured. Set to false to disable.

loadingComponent?¶

optional loadingComponent?: ComponentType\<{ }>

Optional custom loading component shown while an A2UI surface is generating. When omitted, a default animated skeleton is shown.

recovery?¶

optional recovery?: A2UIRecoveryRendererOptions

Options for the A2UI error-recovery status UI (OSS-162): how long before the transient "Retrying…" hint appears, after how many attempts, and how much retry/debug detail to surface. When omitted, sane defaults apply.

theme?¶

optional theme?: Theme

Override the default A2UI viewer theme. When omitted, the built-in viewerTheme from @copilotkit/a2ui-renderer is used.

agent¶

agent: string

Defined in: src/context/KabooProvider.tsx:19

CopilotKit agent id to run (the workflow entry agent).

approvalScopes?¶

optional approvalScopes?: ApprovalScope[]

Defined in: src/context/KabooProvider.tsx:34

The approval options the app allows. A request offers only the scopes both the agent and the app allow; once is always offered. Defaults to all three (once, thread, always).

children¶

children: ReactNode

Defined in: src/context/KabooProvider.tsx:75

Your app subtree, rendered inside all kaboo contexts.

copilotKitProps?¶

optional copilotKitProps?: Partial\<Omit\<CopilotKitProps, "agentId" | "children" | "agent" | "threadId" | "runtimeUrl">>

Defined in: src/context/KabooProvider.tsx:73

Any other props for the underlying <CopilotKit>.

disableInlineCards?¶

optional disableInlineCards?: boolean

Defined in: src/context/KabooProvider.tsx:50

Skip auto-mounting the built-in KabooInlineCards.

disableInterruptHandler?¶

optional disableInterruptHandler?: boolean

Defined in: src/context/KabooProvider.tsx:42

Skip auto-mounting the built-in KabooInterruptHandler.

interruptRenderers?¶

optional interruptRenderers?: InterruptRenderers

Defined in: src/context/KabooProvider.tsx:28

Renderer overrides for the built-in HITL handler, keyed by request kind: approval, form, or an app's own kind such as files.

onInterruptError?¶

optional onInterruptError?: (message) => void

Defined in: src/context/KabooProvider.tsx:48

Called with the reason when a person's answer never reached the agent; the requests come back to be answered again. See KabooInterruptHandlerProps.onInterruptError.

Parameters¶

message¶

string

Returns¶

void

openGenerativeUI?¶

optional openGenerativeUI?: object

Defined in: src/context/KabooProvider.tsx:71

Open Generative UI: the sandbox functions and the design skill.

designSkill?¶

optional designSkill?: string

Design guidelines injected as agent context for the generateSandboxedUi tool. Override this to control the visual style of generated UIs.

A sensible default is provided if omitted.

sandboxFunctions?¶

optional sandboxFunctions?: SandboxFunction\<StandardSchemaV1\<unknown, unknown>>[]

Functions made available inside sandboxed iframes. Each function is described to the LLM via agent context and exposed via websandbox's localApi.

Inside the iframe, call them with:

await Websandbox.connection.remote.<functionName>(args)

properties?¶

optional properties?: Record\<string, any>

Defined in: src/context/KabooProvider.tsx:63

Sent to the agent as forwardedProps with every run.

references?¶

optional references?: ReferenceProvider\<unknown>[]

Defined in: src/context/KabooProvider.tsx:55

@ reference providers made available to the composer / useReferences. File upload is not implicit — include uploadProvider() to offer uploads.

renderActivityMessages?¶

optional renderActivityMessages?: ReactActivityMessageRenderer\<any>[]

Defined in: src/context/KabooProvider.tsx:67

Renderers for activity messages: A2UI surfaces, Open Generative UI, MCP Apps.

renderToolCalls?¶

optional renderToolCalls?: ReactToolCallRenderer\<any>[]

Defined in: src/context/KabooProvider.tsx:65

Renderers for tool calls: the controlled tier of generative UI.

runtimeUrl¶

runtimeUrl: string

Defined in: src/context/KabooProvider.tsx:17

URL of the CopilotKit runtime endpoint (e.g. /api/copilotkit).

slots?¶

optional slots?: KabooSlots

Defined in: src/context/KabooProvider.tsx:61

App-supplied render slots for the chat surfaces (end-of-turn footer, per-message footers, run-start indicator). All optional; nothing is rendered in those positions unless provided.

structuredRenderers?¶

optional structuredRenderers?: StructuredRenderers

Defined in: src/context/KabooProvider.tsx:23

Renderers for structured agent outputs, keyed by output schema name.

threadId?¶

optional threadId?: string

Defined in: src/context/KabooProvider.tsx:21

Conversation id. Scopes both the run and its activity.

toolRenderers?¶

optional toolRenderers?: ToolRenderers

Defined in: src/context/KabooProvider.tsx:40

Per-tool-name renderer overrides applied inside every Timeline surface (agent cards, drill views). Keyed by exact tool name; a match replaces the built-in tool row with the app's custom card.