Skip to main content

Quickstart Guide

Get up and running with the Moss SDK in just a few minutes. This guide will walk you through the essential steps to install the SDK and render the assistant in your application.

1. Install the SDK

Choose your preferred installation method:
See the CDN Installation Guide for complete setup instructions.

Option B: NPM Installation (For React Apps)

See the NPM Installation Guide for full details.

2. Setup (NPM Installation Only)

If you used CDN installation, skip this step. The SDK is automatically configured and ready to use.
The AgentProvider is the heart of the SDK. It manages state, provides context to all other components, and renders the assistant UI. Wrap it around your application at a high level.
/src/App.tsx

3. Configuration

You must provide the apiUrl, applicationName, and userId in the config prop.
  • apiUrl: The URL of your Moss backend service.
  • applicationName: The unique name you registered for your application.
  • userId: A unique identifier for the current user.
That’s it! With these steps, the Moss SDK is now integrated. The floating action button will appear automatically, and users can begin interacting with the AI assistant. For more advanced customization and features, refer to the full SDK Reference.