Generate Tours & Activities Product Categories API - ApyHub

Generate Tours & Activities 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 Tours & Activities products with relevance weights as float values (1.0-10.0), where 10 equals 100%, the highest relevance score. Provide the product name and its parameters to get the best category matches possible. This API is perfect for populating product catalog data and processing bulk products efficiently.
Ideal for developers working on travel platforms, tour operators, or activities marketplaces. It automates the categorization of tours and activities, ensuring accuracy and enhancing searchability. Use cases include categorizing new tour products, improving the organization of tour listings, and enhancing user experience by providing relevant category suggestions.
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 Tours & Activities Product Categories Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/tth/ta_product_categories

Request example

1
```cURL
2


3
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/tth/ta_product_categories' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
    "content": "Oasis of the Bay",
8
    "city": "Ha Long",
9
    "country": "Vietnam",
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 of travel.
countryStringNoSpecify the country related to travel.
languageStringNoSpecify the language of the output, defaults to English
max_quantityNumberNoSpecify the maximum length of the paraphrased content
contextStringNoProvide additional context to improve paraphrasing accuracy
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/tth/ta_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