Tour Category Generator — rank travel categories from content

▣ ENDPOINT 01 / 02

POST

Generate Tours & Activities Product Categories Submit Job

http://localhost:8080/sharpapi/generate-tours-activities-product-catego

QUICKSTARTGUIDE

Quickstart

Submit a travel content generation job with the required content field.

curl -X POST "http://localhost:8080/sharpapi/generate-tours-activities-product-catego" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Best family-friendly attractions in Paris"
  }'

What you'll get back

Returns a JSON object with two string fields: job_id and status_url. job_id is the submitted job identifier, and status_url is the URL you can use to check the job status.

{
  "status_url": "https://apyhub.com/services/provider/sharpapi/api/v1/tth/ta_product_categories/job/status/d4b1bfda-371e-4e8c-b63f-340a7cccdeeb",
  "job_id": "d4b1bfda-371e-4e8c-b63f-340a7cccdeeb"
}

TRY ITLIVE · 50 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Submits an async job to generate tours and activities product categories from the provided content and optional travel context. The response returns a job identifier and a status URL to check the job later.

Request Body

Parameter	Type	Mandatory	Description
city	String	No	Specify the city of travel.
content	String	Yes	Provide the content to generate travel product categories.
context	String	No	Provide additional context to improve paraphrasing accuracy.
country	String	No	Specify the country related to travel.
language	String	No	Specify the language of the output, defaults to `English`.
max_quantity	Number	No	Specify the maximum length of the paraphrased content.

Response

Returns a JSON object with job_id and status_url string fields. job_id identifies the submitted job, and status_url is the URL used to check the job status. Success returns an object shaped like { job_id, status_url }.

Parameter	Type	Mandatory	Description
job_id	String	Yes	Job identifier for the submitted async job.
status_url	String	Yes	URL used to check the submitted job status.

Notes

This endpoint kicks off an async job and returns immediately with a job identifier; the actual work runs in the background. Pair this call with the corresponding job_check endpoint — poll that until the status reaches a terminal state to retrieve the result. Extract the job identifier from job_id.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 02 / 02

GET

Generate Tours & Activities Product Categories Check Job Status

http://localhost:8080/sharpapi/generate-tours-activities-product-catego/job/status/:job_id

QUICKSTARTGUIDE

Quickstart

Check the status of a job by its job_id.

curl -X GET "http://localhost:8080/sharpapi/generate-tours-activities-product-catego/job/status/:job_id" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a data object. data contains id and type for the job result, plus an attributes object with status, type, and result. status is one of success, failed, running, or queued.

{
  "data": {
    "id": "55bc3311-d16e-4949-83a0-d367b7f79f89",
    "type": "api_job_result",
    "attributes": {
      "status": "success",
      "type": "tth_ta_product_categories",
      "result": [
        {
          "name": "Boat Tours",
          "weight": 9.5
        }
      ]
    }
  }
}

TRY ITLIVE · 1 ATOM

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Checks the status of a previously submitted job for generating tours and activities product categories using the provided job_id. The response returns the job result wrapper with its current status and, when available, the generated result list.

Path Parameter(s)

Attribute	Type	Mandatory	Description
job_id	String	Yes	Job identifier, a string.

Response

Returns a JSON object with a data object field. The data object contains id and type string fields, plus an attributes object that includes status and type strings, and may include a result array of objects with name and weight fields.

Attribute	Type	Mandatory	Description
data	Object	Yes	Job result wrapper object.
data.id	String	Yes	Job identifier, a string.
data.type	String	Yes	Resource type, a string.
data.attributes	Object	Yes	Job attributes object.
data.attributes.type	String	Yes	Result type identifier, a string.
data.attributes.status	ENUM	Yes	Job status. Allowed values: `success`, `failed`, `running`, `queued`.
data.attributes.result	Object Array	No	Generated categories returned when available. Each item contains `name` and `weight`.
data.attributes.result[].name	String	Yes	Category name, a string.
data.attributes.result[].weight	Number	Yes	Category weight, a number.

Notes

Poll this endpoint with the job_id returned by the submit call. The status field cycles through transitional values (queued, running) before reaching a terminal state (success, failed). The result fields are only populated once status is success; treat them as absent otherwise.

Path parameters

Name

Type

Description

job_idREQUIRED

string

—

Generate Tours & Activities Product Categories API

What it does

Quickstart

What you'll get back

About this endpoint

What it does

Request Body

Response

Notes

Body

Quickstart

What you'll get back

About this endpoint

What it does

Path Parameter(s)

Response

Notes

Path parameters

Errors any endpoint can return