@outfitcanvas/fitview-sdk 1.0.1 → 1.0.3

package/README.md

@@ -12,6 +12,10 @@ yarn add @outfitcanvas/fitview-sdk
 pnpm add @outfitcanvas/fitview-sdk
 ```
 
+## API key
+
+To use the FitView API you need an API key. **Purchase and register at [https://outfitcanvas.app](https://outfitcanvas.app)** to acquire your API key. Use it in the client as shown below.
+
 ## Quick Start
 
 ```typescript
@@ -20,7 +24,7 @@ import { FitViewClient, OutfitCanvasModel } from '@outfitcanvas/fitview-sdk';
 // Initialize the client
 const client = new FitViewClient({
   apiKey: 'pk_live_your_api_key_here',
-  baseURL: 'https://api.fitview.com', // Optional, defaults to production
+  baseURL: 'https://api.fitview.io', // Optional, defaults to production
 });
 
 // Generate a virtual try-on
@@ -53,7 +57,7 @@ Main client class for interacting with the FitView API.
 ```typescript
 const client = new FitViewClient({
   apiKey: string,              // Required: Your API key
-  baseURL?: string,            // Optional: API base URL (default: https://api.fitview.com)
+  baseURL?: string,            // Optional: API base URL (default: https://api.fitview.io)
   timeout?: number,            // Optional: Request timeout in ms (default: 300000)
   apiVersion?: string,         // Optional: API version (default: 'v1')
   maxRetries?: number,        // Optional: Retries for 429/5xx (default: 3, set 0 to disable)
@@ -528,6 +532,25 @@ The SDK provides specific error classes for different scenarios:
 - `FitViewTimeoutError` - Timeout errors
 - `FitViewNetworkError` - Network errors
 
+## Troubleshooting
+
+### `getaddrinfo ENOTFOUND api.fitview.io` (or similar)
+
+This means the hostname of the API could not be resolved (DNS failure). Common causes:
+
+1. **Wrong or placeholder base URL** – The default `baseURL` is `https://api.fitview.io`. If your API is hosted elsewhere (e.g. your own Cloud Run URL), set the correct URL when creating the client:
+   ```typescript
+   const client = new FitViewClient({
+     apiKey: process.env.FITVIEW_API_KEY!,
+     baseURL: process.env.FITVIEW_BASE_URL || 'https://your-actual-api.run.app',
+   });
+   ```
+   Or set the `FITVIEW_BASE_URL` environment variable (e.g. `https://fitview-api-xxxxx-uc.a.run.app` without `/api/v1`).
+
+2. **Network or DNS issues** – Firewall, VPN, or local DNS may block or fail to resolve the host. Try from another network or verify the API URL in a browser/curl.
+
+3. **Custom domain not set up** – If `api.fitview.io` is not yet configured in DNS for your environment, use the actual API URL provided by your dashboard or deployment (e.g. Cloud Run URL) as `baseURL`.
+
 ## Requirements
 
 - Node.js 18.0.0 or higher

package/dist/index.d.mts

@@ -284,7 +284,7 @@ interface FitViewClientOptions {
      */
     apiKey: string;
     /**
-     * Base URL of the API (default: https://api.fitview.com)
+     * Base URL of the API (default: https://api.fitview.io)
      */
     baseURL?: string;
     /**

package/dist/index.d.ts

@@ -284,7 +284,7 @@ interface FitViewClientOptions {
      */
     apiKey: string;
     /**
-     * Base URL of the API (default: https://api.fitview.com)
+     * Base URL of the API (default: https://api.fitview.io)
      */
     baseURL?: string;
     /**