Getting Started

Quick Start Guide

Get your first Runa AI agent running in your product in under 5 minutes.

Prerequisites

  • Node.js 18+ or any modern browser environment
  • A Runa account — sign up free
  • Your Product ID from the Runa dashboard

Installation

Install the Runa client and UI packages via npm:

npm install @useruna/client @useruna/ui

Quick Start (5 steps)

1

Sign up and create a product

Go to the Runa dashboard, create a new product, and copy your Product ID.

2

Install the package

npm install @useruna/client @useruna/ui
3

Add the widget to your React app

import { RunaWidget } from '@useruna/ui';

export default function App() {
  return (
    <RunaWidget
      productId="your-product-id"
      apiEndpoint="https://api.useruna.ai"
    />
  );
}
4

Or use the script tag embed

<script src="https://cdn.useruna.ai/widget.js"
  data-product-id="your-product-id">
</script>
5

Add knowledge sources in the dashboard

Connect your docs site, upload files, or sync Notion — your agent will index everything automatically.

Explore the docs

API Reference

Full reference for all REST endpoints.

SDK

React, JavaScript, and TypeScript SDK docs.

Examples

Real-world integration examples.