assistant-ui Copilots

Always consult assistant-ui.com/llms.txt for the latest API.

Copilots ground an assistant in your running app: steer it with instructions, feed it lazy app state, let it read and drive rendered components, give it two way state through interactables, and share model context across an iframe boundary.

References

• ./references/instructions.md -- useAssistantInstructions
• ./references/model-context.md -- useAssistantContext, imperative modelContext().register, ModelContextRegistry
• ./references/visible.md -- makeAssistantVisible
• ./references/interactables.md -- app-scoped and thread-scoped interactables, versions, persistence, partial updates
• ./references/assistant-frame.md -- AssistantFrameProvider and useAssistantFrameHost

Orientation

All APIs ship from @assistant-ui/react and run inside AssistantRuntimeProvider. Pick the smallest tool for the job: