Get hotel highlights
post_data_hotel_highlightsOverview
Instructions
Overview
Generate short, AI-written "Smart Highlight" cards for a hotel. Each highlight is a title plus a one or two sentence description, generated directly in the requested language.
Pricing: $0.02 per request
Rate Limiting: This endpoint is rate-limited to 10 requests per minute. Exceeding this limit will result in a 429 Too Many Requests response.
When to Use
Hotel detail pages - Show a few compelling reasons to consider a property
Partner-specific tone - Adjust voice and emphasis per surface via
tone,styleand per-highlightcontext
What You Get
Exactly
counthighlights, always, in the requested ordertypeechoed back from the request so you can map each card to your own UIgeneratedindicating whether the copy is AI-generated or template fallback
Behaviour
Hotel facts are resolved server-side from hotelId; the caller never supplies them. The model sees the name, city, country, street address, parking, and description, plus a sample of facilities, rooms, policies, and nearby places (with a server-computed distance phrase: on the property, short walk, short drive, or longer drive; farther places are omitted), guest sentiment strengths when stored (not drawbacks), and classification (star rating, hotel type, chain). Generated copy is grounded in those facts. Straight apostrophes in titles and descriptions are normalized to typographic apostrophes. Enterprise API keys also omit wifi and the phrase modern amenities from the facts and from the copy, and they omit review-style wording such as guests say. Other API keys still return wifi and connectivity copy when the request asks for it. When tone or style specify length or format, those rules override the default title and description lengths.
If AI generation fails, the endpoint still returns 200 with the requested number of neutral template highlights and generated: false. It never returns an empty array for a valid hotel.
Results are cached, so repeated calls with an identical request body return identical copy.
tone and style are truncated to 200 characters (5,000 for enterprise accounts). Each highlight context is truncated to 300 characters (10,000 for enterprise accounts).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tone | No | Global writing guidance, e.g. `professional and inviting` or `calm and practical`. Truncated to 200 characters (5,000 for enterprise accounts). | |
| count | No | Number of highlights to generate. If `highlights` is supplied, `count` must equal its length. | |
| style | No | Formatting preferences such as title or description length. When supplied, these rules override the default title (2-4 words) and description (~180 characters) lengths. Truncated to 200 characters (5,000 for enterprise accounts). | |
| hotelId | Yes | Unique ID of the hotel (MAQAMI format) | |
| language | Yes | Language code. Highlights are generated directly in this language. | |
| highlights | No | Per-highlight guidance. Omit for generic generation. When supplied, its length must equal `count` and the response preserves this order. |