Skip to content
✨ Learn more about Convo Space & Omnid →
Docs
Convo SDK
Installation

Convo SDK

SDK containing all the functions you'll need to build on theconvo.space

🌲 Tree Shaking Supported ✔️
🆓 Side Effect Free ✔️
🪨 Fully TypeScript Compatible ✔️

Jump to Sample Projects Try it Out (opens in a new tab)

Installation

NodeJs

pnpm i --save @theconvospace/sdk

Browser (UMD)

<script src="https://cdn.jsdelivr.net/npm/@theconvospace/sdk@latest/dist/index.global.js"></script>

Deno

import { Convo } from "https://deno.land/x/convo@v0.1.1/packages/sdk-deno/mod.ts";

Valist

pnpm i --save https://sdk--theconvospace.on.valist.io

Setup

  1. Generate and Copy your API key from https://theconvo.space/dashboard/developer/ (opens in a new tab)

  2. Import Convo Space in your own project.

    import { Convo } from '@theconvospace/sdk';
  3. Setup an new instance of Convo using

    const convo = new Convo("apikey")

    Replace apikey with your newly generated key.

Sample Projects

  1. NextJS/React Sample Project
    Code (opens in a new tab) | Demo - convosdk-examples-nextjs.vercel.app (opens in a new tab)

  2. Browser (Vanilla JS) Sample Project
    Code (opens in a new tab) | Demo - convosdk-examples-browser.vercel.app (opens in a new tab)

Comments