Installation

Prerequisites

  • Node.js 14.x or later
  • npm or yarn package manager
  • An API key from RankFlow

Installing the SDK

You can install the RankFlow SDK using npm:

npm install @rankflow/sdk

Or using yarn:

yarn add @rankflow/sdk

Note: You can find the latest version of the RankFlow SDK on ranflow sdk npm.

Configuration

After installation, you'll need to initialize RankFlow with your API key:

import { RankFlow } from "@rankflow/sdk";

const rankflow = new RankFlow({
  apiKey: "your_api_key_here",
 
});

Environment Variables

We recommend using environment variables to store your API keys. Create a .env file in your project root:

RANKFLOW_API_KEY=your_api_key_here

Note: To generate your API key, visit the RankFlow Dashboard.

TypeScript Support

The RankFlow SDK includes TypeScript definitions out of the box. No additional configuration is needed.

Next Steps

Once you have installed the SDK, check out our Quick Start Guide to begin integrating RankFlow into your AI application.