Quickstart

This guide will get you all set up and ready to use the Pulse API. We'll cover how to install one of our SDKs and make your first API request.

Install the SDK

  • TypeScript:
    npm install @rwai/pulse     # or bun, yarn, pnpm
  • Python:
    pip install pulse-sdk

Making your first API request

After installing the SDK, you can analyze your data with just a few lines of code.

TypeScriptBeta

import { Starters, Auth } from "@rwai/pulse";

const inputs = [
    "I love the new features in the latest update!",
    "The product is okay, but it could be better.",
    "I'm not satisfied with the customer service I received.",
]

const result = await Starters.analyzeSentiment({ inputs, auth: Auth.userAuth() })
console.log(result)
View full documentation

Pythoncoming soon

from pulse.starters import theme_allocation
from pulse.auth import ClientCredentialsAuth

input_file_name = "product-reviews.txt"

ta = theme_allocation(
    input_file_name,
    auth=ClientCredentialsAuth(
        client_id="<CLIENT_ID>",
        client_secret="<CLIENT_SECRET>",
    )
)
ta.bar_chart()
View full documentation

Rcoming soon

library(pulse)

client <- PulseClient$new(
    client_id = "<CLIENT_ID>", 
    client_secret = "<CLIENT_SECRET>"
)
result <- client$generateThemes(inputs = your_data)
print(result)
View full documentation