SharpAPI Cheat Sheet

A quick reference to the API endpoints.

(Click any table row for more details)

AI-powered API Endpoints

Endpoint URL SDK Method Details

🛒 1. E-commerce

Generate Product Intro »

Generates a shorter version of the product description.

/api/v1/ecommerce/product_intro generateProductIntro()

Provide as many details and parameters of the product to get the best marketing introduction possible. Comes in handy with populating products catalogs data and bulk products' processing. You can limit the output with the `max_length` parameter. Please keep in mind that `max_length` serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. Only the `content` parameter is required.

Request:

Response:

Product Categories »

Generates a a list of suitable categories for the product with relevance weights.

/api/v1/ecommerce/product_categories productCategories()

Weights are provided as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. Provide product name and its parameters to get the best categories matches possible. Comes in handy with populating products catalogs data and bulk products' processing. You can limit the output with the "max_quantity" parameter. Within an additional optional parameter context, you can provide a list of other categories that will be taken into consideration during the mapping process (for example your current e-commerce categories). You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. Only the `content` parameter is required.

Request:

Response:

Product Review Sentiment »

Parses the customer's product review and provides its sentiment.

/api/v1/ecommerce/review_sentiment productReviewSentiment()

The sentiment metrics (POSITIVE/NEGATIVE/NEUTRAL) are provided with an additional score between 0-100%. Great for sentiment reports processing for any online store.

Request:

Response:

Generate Thank You E-mail »

Generates a personalized thank you email to the customer.

/api/v1/ecommerce/thank_you_email generateThankYouEmail()

The response content does not contain title, greeting or sender info at the end so you can personalize the rest of the email easily. You can limit the output with the `max_length` parameter. Please keep in mind that `max_length` serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome. Only the `content` parameter is required. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like funny or joyous, or even the name of a famous writer. This API method also provides an optional context parameter, which can be used to supply additional flexible instructions for content processing.

Request:

Response:

📝 2. Content & Marketing Automation

Translate Text »

Translates provided text to selected language. 80 languages are supported.

/api/v1/content/translate translate()

You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. An optional context parameter is also available. It can be used to provide more context to the translated text, like the use case example or some additional explanations. Only the `content` parameter is required.

Request:

Response:

Summarize Content »

Generates a summarized version of the provided content.

/api/v1/content/summarize summarizeText()

Perfect for generating marketing introductions for longer texts. Only the `content` parameter is required. You can define the output language, maximum character length, and tone of voice. Please keep in mind that `max_length` serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer.

Request:

Response:

Paraphrase Text »

Generates a paraphrased version of the provided text.

/api/v1/content/paraphrase paraphrase()

Only the `content` parameter is required. You can define the output language, maximum character length, and tone of voice. Additional instructions on how to process the text can be provided in the context parameter. Please keep in mind that `max_length` serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. This API method also provides an optional context parameter, which can be used to supply additional flexible instructions for content processing.

Request:

Response:

Proofread & Grammar check »

Proofreads (and checks grammar) of the text.

/api/v1/content/proofread proofread()

Request:

Response:

Generate Keywords/Tags »

Generates a list of unique keywords/tags for the text.

/api/v1/content/keywords generateKeywords()

Only `content` parameter is required. You can limit the output with the "max_quantity" parameter. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer.

Request:

Response:

Detect Phone Numbers »

Parses the provided text for any phone numbers and returns original detected version and its E.164 format.

/api/v1/content/detect_phones detectPhones()

Might come in handy in case of processing and validating big chunks of data against phone numbers or f.e. if you want to detect phone numbers in places where they're not supposed to be.

Request:

Response:

Detect Emails »

Parses the provided text for any possible emails.

/api/v1/content/detect_emails detectEmails()

Might come in handy in case of processing and validating big chunks of data against email addresses or f.e. if you want to detectemails in places where they're not supposed to be.

Request:

Response:

Detect Spam »

Checks if provided content passes a spam filtration test.

/api/v1/content/detect_spam detectSpam()

Provides a percentage confidence score and an explanation for whether it is considered spam or not. This information is useful for moderators to make a final decision.

Request:

Response:

🪪 3. SEO

Generate SEO Tags »

Generates all most important SEO META tags.

/api/v1/seo/generate_tags generateSeoTags()

Make sure to include link to the website and pictures URL to get as many tags populated as possible. Only `content` parameter is required. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer.

Request:

Response:

🧑🏻‍💻 4. HR Tech

Parse Resume/CV File »

Parses a resume (CV) file from multiple formats (pdf/doc/docx/txt/rtf)

/api/v1/hr/parse_resume parseResume()

Endpoint returns an extensive object of data points. The file has to be uploaded as form-data parameter called `file`. An optional `language` parameter can also be provided (`English` value is set as the default one).

Request:

Response:

Generate Job Description »

Generates job description (short description, job requirements and job responsibilities).

/api/v1/hr/job_description generateJobDescription()

Based on the list of extensive parameters this endpoint provides concise job details in the response format. Only the `name` parameter is required. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. This API method also provides an optional context parameter, which can be used to supply additional flexible instructions for content processing.

Request:

Response:

Related Job Positions »

Generates a list of related job positions with their weights metrics.

/api/v1/hr/related_job_positions relatedJobPositions()

Weights are provided as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. You can limit the output with the "max_quantity" parameter. Only the `content` parameter is required.

Request:

Response:

Related Skills »

Generates a list of related skills with their weights metrics.

/api/v1/hr/related_skills relatedSkills()

Weights are provided as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. You can limit the output with the "max_quantity" parameter. Only the `content` parameter is required.

Request:

Response:

✈ 5. Travel, Tourism & Hospitality

Travel Review Sentiment »

Parses the Travel/Hospitality product review and provides its sentiment.

/api/v1/tth/review_sentiment travelReviewSentiment()

The resulting sentiment metric (POSITIVE/NEGATIVE/NEUTRAL) is provided with the score between 0-100%. Great for sentiment reports processing for any online store. Only the `content` parameter is required.

Request:

Response:

Tours & Activities Product Categories »

Generates a a list of suitable categories for the Tours & Activities product with relevance weights.

/api/v1/tth/ta_product_categories toursAndActivitiesProductCategories()

The weights are provided as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. Provide product name and its parameters to get the best categories matches possible. Comes in handy with populating products catalogs data and bulk products' processing. Only the `content` parameter is required. You can limit the output with the "max_quantity" parameter. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. Within an additional optional parameter context, you can provide a list of other categories that will be taken into consideration during the mapping process (for example your current categories).

Request:

Response:

Hospitality Product Categories »

Generates a a list of suitable categories for the Hospitality type product with relevance weights.

/api/v1/tth/hospitality_product_categories hospitalityProductCategories()

The weights are provided as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. Provide product name and its parameters to get the best categories matches possible. Comes in handy with populating products catalogs data and bulk products' processing. Only the `content` parameter is required. You can limit the output with the "max_quantity" parameter. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. Within an additional optional parameter context, you can provide a list of other categories that will be taken into consideration during the mapping process (for example your current categories).

Request:

Response:

Utilities Endpoints / Non-AI

Endpoint URL SDK Method Details

✈ 1. Airports

Airports List »

A paginated list of almost 30,000 airports.

/api/v1/airports airportsList()

An easy-to-use paginated list of almost 30,000 airports with an advanced set of filter parameters by airport name, city, country, and assigned code types.

Response:

Airport Details by UUID »

Single airport details - search by internal UUID.

/api/v1/airports/UUID airportByUuid()

Response:

Airport Details by IATA »

Single airport details - search by IATA code.

/api/v1/airports/iata/SIN airportByIata()

Response:

Airport Details by ICAO »

Single airport details – search by ICAO code.

/api/v1/airports/icao/ZBTJ airportByIcao()

Response:

Airport Details by LID »

Single airport details - search by LID code.

/api/v1/airports/lid/00AL airportByLid()

Response:

Flight Duration »

Calculates journey duration based on departure and arrival parameters

/api/v1/airports/flight_duration/iata/SIN/2024-06-26/01:40/iata/DXB/2024-06-26/12:10 flightDuration()

A special Flight Length endpoint can help with calculations of the total journey duration based on departure and arrival parameters (airport code, date and time). All parameters are required and can be provided via the URL

Response: