Quick Start

Set up the Conversa SDK in your Node.js project and make your first API call.

Prerequisites

• Node.js 18 or later  (node --version to check)
• npm 9 or later
• A Conversa API key — sign up free, no credit card required

Step 1 — Initialise a project

Create a project directory and initialise package.json:

mkdir -p conversa-app && cd conversa-app && npm init -ycopy

Step 2 — Install the SDK

Install conversa-sdk. The postinstall step writes conversa.config.json to your project directory and registers your workspace with the Conversa API:

npm install conversa-sdkcopy

Step 3 — Add your API key

Create a .env file with your credentials:

echo "CONVERSA_API_KEY=your_key_here" >> .envcopy

Step 4 — Make your first call

Create index.js and run it to confirm the SDK can reach the Conversa API:

const { createClient } = require('conversa-sdk');
require('dotenv').config();

const client = createClient(process.env.CONVERSA_API_KEY);

client.summarise('wildlife-elephants').then(summary => {
  console.log('SDK reachable:', summary.status);
});copy

node index.jscopy