API Product Description Generator
Struggling to create compelling product descriptions while managing complex API integrations and platform rules? Our API Product Description Generator simplifies this. Forget about juggling specific authentication methods, JSON formatting, or monitoring rate limits like 30 requests per minute for Starter plans. We provide a straightforward POST /api/v1/generate endpoint. Unlike generic AI tools where you must engineer prompts to fit your platform's data needs, our model inherently understands and respects these constraints. This means less development overhead for you. Integrate quickly, generate descriptions efficiently, and focus on selling. We handle the technical details, including retries and batch options via webhooks, all described in our OpenAPI 3.1 spec.
What scrb knows about the scrb REST API that a chat model doesn't
Interacting with the product description API adheres to a precise set of platform-specific technical rules designed for reliability and seamless integration. These guidelines ensure secure communication, predictable performance, and efficient data handling for all description generation requests. Understanding these foundational principles is crucial for developers building robust applications that leverage our product description capabilities effectively.
- All requests to the product description generation service must use the HTTP POST method directed at the
/api/v1/generateendpoint. - Authentication is strictly enforced via Bearer API keys. Each key is uniquely scoped to an individual user account, providing secure and auditable access to the API.
- Data exchange for both incoming requests and outgoing responses is exclusively formatted as JSON, ensuring a consistent and easily parsable structure for all API interactions.
- Rate limits are applied per subscription tier to manage system load: Starter plans permit 30 requests per minute, Pro plans allow 60 requests per minute, and Business plans accommodate 120 requests per minute.
- For enhanced resilience against transient network failures or temporary rate limit breaches, client-side retry mechanisms are strongly advised, with the tenacity library being a recommended implementation.
- Asynchronous processing for larger batches of product descriptions can leverage a webhook callback option, which notifies your system once the generation tasks are fully completed.
- A comprehensive and machine-readable OpenAPI 3.1 specification is readily available, detailing all API operations, data models, and error responses to facilitate straightforward integration.
Before / after: real examples
Generic AI output:
This advanced smart thermostat revolutionizes home climate control, offering unparalleled comfort and energy efficiency. Seamlessly integrate it into your smart home ecosystem, enjoying intuitive touchscreen operation and convenient voice commands. Its intelligent algorithms learn your preferences, optimizing heating and cooling to save you money while maintaining your ideal indoor environment. Experience the future of home comfort today with this sleek, modern device.scrb output tuned for api:
This Smart Wi-Fi Thermostat description is generated via `POST /api/v1/generate`, ensuring `JSON in, JSON out` for seamless integration. It adheres to a strict 250-character limit for the main description and a maximum of 5 bullet points for features. Keywords are optimized for search, placed within the first 50 characters. Authentication uses `Bearer API key`, scoped per user. Rate limits apply per plan (Starter 30/min, Pro 60/min). `OpenAPI 3.1` spec details all fields. For large batches, a `webhook callback option` is available, with `retries handled by tenacity`. This ensures consistent, structured product data.Why this wins: Leveraging `JSON in, JSON out` via `POST /api/v1/generate` provides structured data, enforcing character and bullet point limits directly, crucial for consistent product listings across diverse platforms.
Generic AI output:
Embark on an exciting journey to master a new language with our premium online course. Featuring engaging interactive lessons and authentic native speaker audio, you'll develop fluency rapidly. Track your progress effortlessly and connect with a vibrant global community of learners. Accessible via web and a dedicated mobile app, learning is flexible and convenient, fitting perfectly into your busy lifestyle. Unlock your linguistic potential today!scrb output tuned for api:
This premium online language course description is tailored for `api` integration, using `POST /api/v1/generate` with `JSON in, JSON out`. It provides a concise summary under 200 characters and highlights three key benefits as bullet points. All responses are authenticated via `Bearer API key` and respect `Business plan (120/min)` rate limits. `Retries handled by tenacity` ensures delivery reliability. An `OpenAPI 3.1` spec details the output schema, including `keyword` arrays. Batch processing is enabled through a `webhook callback option`, guaranteeing structured and consistent marketing copy.Why this wins: Enforcing strict character counts and specific bullet point limits through `JSON in, JSON out` ensures generated copy fits perfectly into constrained UI elements, preventing truncation and maintaining design integrity.
FAQ
How does the API handle content that might violate platform guidelines or be considered inappropriate?
The Product Description API includes a pre-processing content moderation layer. Before generation, input `product_details` and `target_audience` fields are scanned for explicit, hateful, or harmful content. If detected, the API returns a `400 Bad Request` status with an error object containing `error_code: "CONTENT_VIOLATION"` and a `message` detailing the issue, preventing description generation. Post-generation, the output `description` is also checked. If the generated text contains problematic language, it will be flagged, and the API response will include a `flagged: true` boolean in the metadata, along with `violation_type` and `moderation_score` fields, allowing your application to review or discard the output.
What are the precise character limits for input fields and the generated product descriptions?
Input fields like `product_name` are capped at 100 characters, `product_features` at 500 characters, and `target_audience` at 150 characters. The combined length of all input fields (excluding `api_key`) must not exceed 1000 characters. For the generated output, the `description` field has a configurable maximum length, defaulting to 250 characters. You can specify a `max_length` parameter in your request, ranging from 50 to 500 characters. Requests exceeding these limits will result in a `400 Bad Request` with an `INPUT_TOO_LONG` error code, advising which specific field or combined input length was exceeded.
What are the specific API endpoints, authentication methods, and data formats required for interaction?
The Product Description API is accessed via a RESTful endpoint: `POST https://api.productdescriptions.com/v1/generate`. Authentication uses a Bearer Token scheme; your unique API key, scoped per user, must be included in the `Authorization` header as `Bearer YOUR_API_KEY`. All requests require a JSON payload in the request body, specifying fields like `product_name`, `product_features`, and `target_audience`. The API responds with a JSON object containing the generated `description`, a `description_id`, and metadata such as `word_count` and `generation_timestamp`. Ensure `Content-Type: application/json` is set in your request headers.
Can the Product Description API generate descriptions in languages other than English?
Yes, the Product Description API supports generation in multiple languages. You can specify the desired output language using the `language` parameter in your JSON request body. Supported language codes include `en` (English, default), `es` (Spanish), `fr` (French), `de` (German), and `ja` (Japanese). The API processes input fields, such as `product_name` and `product_features`, in the specified language and generates the output `description` accordingly. If an unsupported language code is provided, the API will return a `400 Bad Request` with an `UNSUPPORTED_LANGUAGE` error and a list of available languages.
Does the API support processing multiple product description requests in a single batch or concurrently?
While the primary endpoint `POST /v1/generate` is designed for single-item generation, the API offers a `POST /v1/batch-generate` endpoint for bulk processing. This endpoint accepts an array of up to 50 individual product description request objects within a single JSON payload. Each object in the array should conform to the standard single-generation request structure. The API will process these asynchronously and return a `batch_id` for status tracking. You can then poll `GET /v1/batch-status/{batch_id}` to retrieve results. Direct concurrent calls to the single-item endpoint are also supported, subject to your account's rate limits, typically 10 requests per second.
How to plug scrb into your workflow
Integrate scrb into your API workflow with four flexible methods, designed to suit diverse operational scales and technical requirements:
- Chrome/Firefox Extension: Perfect for solo sellers or small businesses. This extension works directly on your e-commerce platform's product edit page, enabling quick, on-demand description updates for individual products.
- Web App Bulk CSV: For growing businesses with hundreds of SKUs needing periodic updates. Upload a CSV of your product data to our web app, process descriptions, and download an updated CSV for easy re-import.
- REST API: Built for agencies, large enterprises, and developers. Integrate programmatically with custom scripts, Zapier, or Make.com for automated, continuous updates across thousands of products.
- Native Platform Plugins: Available for WordPress (WooCommerce), Shopify, and Ecwid. These dedicated apps offer seamless, direct integration within your e-commerce platform, simplifying description management for any scale on supported platforms.
Pricing for product description api
Explore plans designed to optimize your product description API usage for e-commerce success:
- Free: 5 generations/month - Test the API on 1-2 product variants or generate a few bullet points for a single item.
- Starter $9.99: 100 generations/month - Ideal for small catalog refreshes or initial Etsy/eBay listings, covering descriptions for approximately 20 products (e.g., 5 bullet points each).
- Pro $24.99: 500 generations/month + API + batch CSV - Suited for mid-size brands, enabling comprehensive description generation for around 100 products, including efficient bulk updates.
- Business $49.99: 3000 generations/month + highest-quality output tier - Built for agencies and enterprises needing high volume and premium output, generating detailed descriptions for up to 600 products monthly.
- Recurring monthly and annual plans are available; scrb is sold as recurring access only.