Generate Product Categories API
SharpAPI
1000 atoms
AI tier
About
The Product Categories API generates a list of suitable categories for a given product, along with their relevance scores. By providing the product name and its parameters, this API returns related categories and their weights as float values ranging from
1.0
to 10.0
, where 10 represents the highest relevance.This API is highly useful for developers building e-commerce platforms, product catalog management systems, or bulk product processing tools. It automates the categorization of products, ensuring accuracy and consistency. Use cases include populating product catalog data, enhancing product search algorithms, and improving inventory management systems.
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.
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 Categories Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/ecommerce/product_categories
Request example
Method:
POST
Content Type:
application/json
Request Body
Attribute | Type | Mandatory | Description |
---|---|---|---|
content | String | Yes | Product name and its parameters to generate the categories |
context | String | No | The list of other categories that will be taken into consideration during the mapping process (for example your current e-commerce categories) |
language | String | No | Specify the language of the output, defaults to English |
voice_tone | String | No | Preferred writing style parameter. It can be adjectives like funny or joyous, or even the name of a famous writer |
max_quantity | Number | No | Maximum number of product categories to generate |
Sample Response
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|---|
202 | The job was submitted successfully. |
401 | Required authentication information is either missing or not valid for the resource. |
400 | Invalid input - if the file is invalid or corrupted |
500 | If 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
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