Quick Start

Get from zero to a streamed answer in three steps. The Finn SDK ships for Node.js/TypeScript and Python — pick your language with the tabs below (your choice sticks across the docs).

1. Install the SDK

   Node.js

   npm install @riseanalytics/finn-sdk
   # or: pnpm add @riseanalytics/finn-sdk
   # or: yarn add @riseanalytics/finn-sdk

   Python

   pip install finn-sdk

2. Connect and ask a question

   Node.js

   import { FinnClient } from '@riseanalytics/finn-sdk';
   
   const finn = new FinnClient({
     url: process.env.FINN_URL,         // e.g. https://finn.example.com
     apiKey: process.env.FINN_API_KEY,  // your static API key
   });
   
   await finn.connect();
   
   const turn = finn.sendMessage('How many active members do I have?');
   
   // Tokens stream in as Finn answers.
   for await (const chunk of turn) {
     process.stdout.write(chunk.text);
   }
   
   const result = await turn.completed;
   console.log('\nconversationId:', result.conversationId);
   
   await finn.disconnect();

   Python

   import asyncio, os
   from finn_sdk import FinnClient
   
   async def main():
       finn = FinnClient(
           url=os.environ["FINN_URL"],         # e.g. https://finn.example.com
           api_key=os.environ["FINN_API_KEY"],  # your static API key
       )
       await finn.connect()
   
       turn = await finn.send_message("How many active members do I have?")
   
       # Tokens stream in as Finn answers.
       async for chunk in turn:
           print(chunk.text, end="", flush=True)
   
       result = await turn.completed
       print("\nconversationId:", result.conversation_id)
   
       await finn.disconnect()
   
   asyncio.run(main())

3. Run it

   Node.js

   FINN_URL=https://finn.example.com FINN_API_KEY=your-key node index.mjs

   Python

   FINN_URL=https://finn.example.com FINN_API_KEY=your-key python main.py

At CU Build?

Grab a Finn FINN_URL and FINN_API_KEY from us at the booth and you’re ready to build.

Just want the answer?

If you don’t need live tokens, use ask() — it does the loop for you and resolves once with the full answer:

Node.js

const { text } = await finn.ask('How many active members do I have?');
console.log(text);

Python

answer = await finn.ask("How many active members do I have?")
print(answer.text)

See Sending messages & streaming for the difference between ask() and sendMessage().

What just happened

• Creating a client (new FinnClient({ url, apiKey }) / FinnClient(url=..., api_key=...)) just holds config — nothing connects yet.
• connect() opened the WebSocket and authenticated with your API key.
• sendMessage(...) / send_message(...) returned a MessageTurn — an async-iterable you loop over to read tokens as they arrive.
• turn.completed resolved with the final TurnResult, including the conversationId you’d reuse for a follow-up.

Next steps

• Connecting & auth — every connection option, API-key rotation, and lifecycle events.
• Sending messages & streaming — the streaming model in depth, plus interrupting a turn.
• Conversations & follow-ups — keep context across turns.
• Full examples — complete, runnable programs in both languages.