Skip to content

Overview

The @gocommotion/copilot-sdk is an embeddable chat interface that brings real-time visibility into your AI workers and agents. Whether you are processing data, answering questions, or automating tasks, the SDK provides a clean, unified interface to monitor, control, and interact with your AI workforce.

Jump to the Quickstart to embed Copilot in a React app in under five minutes, or skip ahead to the UMD build for plain HTML or non-React projects.

Key capabilities

Real-time worker monitoring

Watch your AI workers operate in real time. View live streaming responses and results formatted in a readable chat interface.

Interactive communication

Send requests through a natural chat interface and receive formatted output - text, code, tables, and more. Context is maintained across multi-turn conversations.

Human-in-the-loop oversight

Critical tasks can pause for human review. Examine, modify, or reject worker decisions and provide guidance to steer worker actions.

File processing

Upload documents, data files, and images directly in the chat. Workers process files and return results in real time.

Flexible integration

Embed in a React app or plain HTML. The component adapts to your layout and design without a rewrite.

Multi-worker support

Route requests to different workers based on context and display all responses in one unified interface.

Build formats

The Copilot is available in three build formats. Pick the one that matches your stack:

  • React build - npm-installed package for React 18+ applications. See the Quickstart.
  • Browser ESM build - recommended path for non-React apps. Self-contained ES module loaded dynamically with import() - no peer-dependency scripts required. See the Browser ESM guide.
  • UMD build - legacy fallback for environments without dynamic import(). See the UMD guide.
FeatureReact buildBrowser ESMUMD build
Component typeReact JSXJavaScript classJavaScript class
containerIdNot neededRequiredRequired
style (object)YesNoNo
styles (string)NoYesNo
Shadow DOMAuto (internal)Configurable (default on)Always on
Instance methodsn/adestroy(), updateConfig()destroy()
Static methodsn/adestroy(id), destroyAll(), getActiveInstances()None