Generate Product Introduction API - ApyHub
apyhub-logo
FusionPlatformAPI CatalogPricingBlog

Generate Product Introduction API

Artificial IntelligenceE-commerce Quick ToolsSmart Generation#ecommerce#introduction#product
job
SharpAPI
SharpAPI
verified icon
1000 atoms
AI tier

About

The Product Intro Generator API generates a shorter version of the product description. Provide as many details and parameters of the product to get the best marketing introduction possible. This API is useful for populating product catalog data and processing bulk products efficiently.
This API is ideal for developers working on e-commerce platforms, product management systems, or marketing tools. It automates the creation of concise and impactful product introductions, enhancing the quality of product listings and improving user engagement. Use cases include generating brief product descriptions for online stores, creating marketing summaries for promotional materials, and streamlining product data management.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Generate Product Introduction Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/ecommerce/product_intro

Request example

1
```cURL
2
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/ecommerce/product_intro' \
3
--header 'apy-token: {{token}}' \
4
--header 'Content-Type: application/json' \
5
--data '{
6
    "content": "Razer Blade 16 Gaming Laptop: NVIDIA GeForce RTX 4090-13th Gen Intel 24-Core i9 HX CPU - 16\" Dual Mode Mini LED (4K UHD+ 120Hz & FHD+ 240Hz) - 32GB RAM - 2TB SSD - Compact GaN Charger - Windows 11 NVIDIA GEFORCE RTX 4090 GRAPHICS: Packed for pure performance with 1.50 gPD (Graphics Power Density) and delivers up to 35% more graphic power per inch than any other 16 inch gaming laptop     \n13TH GEN INTEL CORE I9 13950HX PROCESSOR: From full-blown AAA gaming to full-on content creation, run resource-intensive tasks flawlessly with the most powerful mobile processor leveraging desktop-grade silicon\n NEXT GEN DUAL-MODE MINI LED DISPLAY: Switch between ultra-sharp 4K for creative work and ultra-fast refresh rates for silky-smooth gameplay, backed by 1K nits peak brightness and 100% DCI-P3 color accuracy \n 16 INCH DISPLAY IN A 15 INCH BODY: Built with similar chassis dimensions to a typical 15” gaming laptop, it's just as ultra-portable yet offers even more screen real estate—a solution that’s the best of both worlds \nULTRA-COMPACT GAN CHARGER (UP TO 330W): Stay ready to go with a charger that’s not only faster and more power-efficient than standard adapters but also up to 60% smaller \nANODIZED ALUMINUM UNIBODY: CNC-milled from a single aluminum block, the chassis achieves optimal strength-to-weight ratio and is anodized with a matte black finish for a smooth, scratch-resistant surface",
7
    "language": "English",
8
    "max_length":200,
9
    "voice_tone": "neutral"
10
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
contentStringYesProduct name and its parameters to generate the product intro.
languageStringNoSpecify the language of the output, defaults to English
max_lengthNumberNoSpecify the maximum length of intro in # of words.
voice_toneStringNoSpecify the voice tone of the output. It can be adjectives like funny or joyous, or even the name of a famous writer.
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/ecommerce/product_intro/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
3
  "job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles