Skip to content
Reponse.ai LogoDocs
DocsAPISDKsGuides

Search Documentation

Search for an article...

Getting Started

  • Overview
  • Architecture
  • Installation
  • Authentication
  • First Request

Products & Collections

  • Products — List
  • Products — Get
  • Products — Metafields
  • Collections — List
  • Collections — Get
  • Collections — Products

Cart & Checkout

  • Cart — Create
  • Cart — Get
  • Cart — Add Item
  • Cart — Update Item
  • Cart — Remove Item
  • Cart — Apply Promotion
  • Checkout — Stripe
  • Checkout — Payment Intent
  • Checkout — ACP

Orders & Fulfillment

  • Orders — Create
  • Orders — Get
  • Orders — Confirm
  • Orders — Cancel
  • Orders — Fulfill
  • Orders — Refund

Commerce

  • Inventory — Get
  • Inventory — Update
  • Shipping — Rates
  • Discounts — List
  • Discounts — Create
  • Discounts — Validate
  • Subscriptions — Manage

Loyalty & Gift Cards

  • Loyalty — Balance
  • Loyalty — Redeem
  • Loyalty — Referral
  • Gift Cards — List
  • Gift Cards — Redeem

Tickets & Support

  • Tickets — List
  • Tickets — Create
  • Tickets — Reply

Platform

  • Product Feed — JSON
  • Product Feed — CSV
  • Theme — Get
  • Approvals — Execute
  • Approvals — Reject
  • Geocode

SDKs

  • SDK Overview
  • TypeScript SDK
  • React Hooks

Guides

  • Chat Widget
  • Shopify Sync
  • Storefront Starter
  • Loyalty Program
  • Discounts & Promotions
  • Subscriptions
  • Klaviyo Integration
  • Custom Domains
  • Agentic Commerce (ACP)
  • A2A Protocol
  • AI Engines
  • MCP Server

Webhooks

  • Webhooks Overview
  • Events Reference
  • Shopify Webhooks
  • Stripe Webhooks
  • Reviews (Stamped / Trustpilot)
  • Logistics
  • Email Inbound

Resources

  • Environment Variables
  • Rate Limits
  • Changelog
DocsGetting StartedInstallation

Installation

Install the Reponse SDK and set up your environment.

1 min read/Last updated Jul 22, 2026
On this page

Overview

Install the Reponse SDK with your preferred package manager, configure your API key, and verify the setup with a quick health check. The entire process takes under five minutes.

Prerequisites

  • Node.js 18 or later
  • A package manager: npm, pnpm, or yarn
  • A Reponse API key (see Authentication)

Step 1 — Install the SDK

Choose your package manager:

bash
# npm
npm install @reponseai/sdk

# pnpm
pnpm add @reponseai/sdk

# yarn
yarn add @reponseai/sdk

For React projects, also install the hooks package:

bash
npm install @reponseai/react

CDN (Browser)

If you are not using a bundler, load the SDK from the CDN:

html
<script src="https://cdn.reponse.ai/sdk/latest/reponse.min.js"></script>
<script>
  const reponse = new Reponse({ apiKey: "rp_live_..." });
</script>

Step 2 — Configure Environment Variables

Create a `.env.local` file at the root of your project:

bash
# Required — your workspace API key (server-side only)
REPONSE_API_KEY=rp_live_...

# Optional — override the default API base URL
NEXT_PUBLIC_REPONSE_BASE_URL=https://api.reponse.ai
**Important:** Never prefix server-only secrets with `NEXT_PUBLIC_`. The `REPONSE_API_KEY` variable must stay server-side.

Step 3 — Initialize the Client

typescript
import { Reponse } from "@reponseai/sdk";

const reponse = new Reponse({
  apiKey: process.env.REPONSE_API_KEY!,
});

Step 4 — Verify the Installation

Run a quick products request to confirm everything works:

typescript
const { data } = await reponse.catalog.listProducts({ query: { limit: 1 } });
console.log("Connected ✓ — first product:", data.data[0]?.title);

Expected output:

Connected ✓ — first product: Example Product

Configuration Options

OptionTypeDefaultDescription
apiKeystring—Your workspace API key (required).
baseUrlstringhttps://api.reponse.aiOverride the API base URL.
timeoutnumber30000Request timeout in milliseconds.
retriesnumber2Number of automatic retries on 5xx errors.

Troubleshooting

IssueSolution
MODULE_NOT_FOUNDRun npm install again and check your node_modules.
401 Unauthorized on first callVerify REPONSE_API_KEY is set and correct.
TypeScript type errorsEnsure you are on @reponseai/sdk ≥ 1.0.0 and TypeScript ≥ 5.0.
CDN script not loadingCheck for ad-blockers or CSP headers blocking cdn.reponse.ai.
PreviousArchitecture
NextAuthentication