Generate Hospitality Product Categories API - ApyHub

Generate Hospitality Product Categories API

Artificial IntelligenceData ExtractionTravel#content#link#seo
job
SharpAPI
SharpAPI
verified icon
1000 atoms
AI tier

About

This API generates a list of suitable categories for hospitality products with relevance weights as float values (1.0 - 10.0), where 10 represents the highest relevance score. By providing the product name and its parameters, this API delivers the best category matches possible. It is highly useful for populating product catalogs and processing bulk products efficiently.
Ideal for developers working on travel platforms, hotel booking systems, or hospitality marketplaces. It streamlines the categorization of hospitality products, ensuring accuracy and enhancing searchability. Use cases include categorizing new hotel listings, improving the organization of hospitality offerings, and providing users with relevant category suggestions for a better experience.
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 Hospitality Product Categories Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/tth/hospitality_product_categories

Request example

1
```cURL
2


3
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/tth/hospitality_product_categories' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
    "content": "Hotel Crystal 大人専用",
8
    "city": "Tokyo",
9
    "country":"Japan",
10
    "language": "English",
11
    "max_quantity":10,
12
    "voice_tone": "neutral",
13
    "context":null 
14
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
contentStringYesProvide the content to generate travel product categories.
cityStringNoSpecify the city to travel.
countryStringNoSpecify the country to travel.
languageStringNoSpecify the language of the output, defaults to English
max_quantityNumberNoMaximum number of product categories to generate
voice_toneStringNoSpecify the voice tone. Default will be neutral
contextStringNoProvide additional context to improve paraphrasing accuracy
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/tth/hospitality_product_categories/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