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 — Clone the examples workspace

The SDK ships with a working examples repository. Clone it to get a full local copy with all dependencies and the environment verifier:

git clone https://github.com/conversa-platform-sdk/conversa-sdk-examples.git conversa-workspace
cd conversa-workspacecopy

Step 3 — Install and verify

Install dependencies and run the environment verifier. The verifier checks your Node version, API reachability, and local registry config:

npm install
npm testcopy

Step 4 — Add your API key

Create a .env file with your credentials:

echo "CONVERSA_API_KEY=your_key_here" >> .envcopy

Step 5 — Make your first call

Run the included example to confirm the SDK can reach the Conversa API:

node index.jscopy