JSPM

@sharpapi/sharpapi-node-product-description

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q33914F
  • License MIT

SharpAPI.com Node.js SDK for generating product descriptions

Package Exports

  • @sharpapi/sharpapi-node-product-description
  • @sharpapi/sharpapi-node-product-description/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sharpapi/sharpapi-node-product-description) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SharpAPI GitHub cover

Product Description Generator API for Node.js

Generate professional e-commerce product descriptions -- powered by SharpAPI AI.

npm version License

SharpAPI Product Description Generator creates compelling, SEO-optimized product descriptions from raw product data. Supports multiple languages, customizable tone of voice, and length control. Perfect for e-commerce platforms, product catalogs, and marketplace listings.


Table of Contents

  1. Requirements
  2. Installation
  3. Usage
  4. API Documentation
  5. Use Cases
  6. License

Requirements

  • Node.js >= 16.x
  • npm or yarn

Installation

Step 1. Install the package via npm:

npm install @sharpapi/sharpapi-node-product-description

Step 2. Get your API key

Visit SharpAPI.com to get your API key.


Usage

const { SharpApiProductDescriptionService } = require('@sharpapi/sharpapi-node-product-description');

const apiKey = process.env.SHARP_API_KEY; // Store your API key in environment variables
const service = new SharpApiProductDescriptionService(apiKey);

const productData = 'Wireless Bluetooth Headphones, 40mm drivers, active noise cancellation, 30-hour battery, foldable design, USB-C charging';

async function generateDescription() {
  try {
    // Submit processing job
    const statusUrl = await service.generateProductDescription(productData);
    console.log('Job submitted. Status URL:', statusUrl);

    // Fetch results (polls automatically until complete)
    const result = await service.fetchResults(statusUrl);
    console.log('Result:', result.getResultJson());
  } catch (error) {
    console.error('Error:', error.message);
  }
}

generateDescription();

API Documentation

Methods

generateProductDescription(productData, language?, maxLength?, voiceTone?, context?)

Generates a professional product description from the provided product data.

Parameters:

Parameter Type Required Description
productData string Yes Product details, features, and key information
language string No Output language (default: English)
maxLength number No Maximum character length of the description
voiceTone string No Tone of the description (e.g., "Professional", "Casual", "Luxury")
context string No Additional context for the AI (e.g., target audience, platform)

Returns: Promise - Status URL for polling results


Use Cases

  • Product Listings: Create detailed, persuasive descriptions for online stores
  • Bulk Catalog Upload: Generate descriptions for large product catalogs
  • SEO Optimization: Create keyword-rich descriptions for better search rankings
  • Marketplace Adaptation: Generate platform-specific descriptions (Amazon, Shopify, eBay)
  • Multi-language Stores: Generate descriptions in multiple languages from a single source
  • A/B Testing: Create description variations for conversion optimization
  • Content Localization: Adapt product messaging for different markets and audiences

API Endpoint

POST /ecommerce/product_description

Request Body:

{
  "content": "Product details and features...",
  "language": "English",
  "max_length": 500,
  "voice_tone": "Professional",
  "context": "Additional context for the AI..."
}

License

This project is licensed under the MIT License. See the LICENSE.md file for details.


Support