API docs
Book a demo

Content Enrichment API / Enrichment

Get enriched hotel

Page

POST /v2/project/content/getEnrichedHotel

Retrieve one fully enriched hotel with its rooms, images, points of interest, factual attributes, check-in and check-out times and per-locale generated texts.

The response is returned synchronously. Resolve the hotel with exactly one selector; each returns the same hotel.

  • HotelID is the hotel UUID, GlobalHotelID the cross-tenant identifier, ExternalHotelID a map of your own identifiers.
  • ExternalHotelID sub-keys are productid, giata and peakworkgoalid; several are AND-combined, so a conflict returns 404.
  • No selector, more than one, an unsupported sub-key, a non-numeric or non-positive giata or peakworkgoalid, or a giata above 2147483647 returns 400.
  • The hotel must be in your project's content set; an unknown or out-of-scope hotel returns 404.
  • 429 means the rate limit was hit; wait Retry-After seconds.

Example request

curl -X POST 'https://api.ygo.ai/v2/project/content/getEnrichedHotel' \
  -H "Authorization: Bearer $YGO_API_KEY" \
  -H "X-Project-ID: $YGO_PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "HotelID": "0192fb17-5dc6-7abc-8def-123456789abc"
}'

Authorization

Authorization: Bearer <key>

Project-scoped API key

Headers

  • X-Project-ID string (uuid) required

    Project UUID. Required for all project-scoped endpoints.

    Example
    $YGO_PROJECT_ID

Request body required

application/json object GetEnrichedHotelRequest

Request body for fetching one enriched hotel. Provide exactly one selector: HotelID, GlobalHotelID or ExternalHotelID.

  • HotelID string (uuid)

    UUID of the enriched hotel to retrieve, one of three mutually exclusive selectors. The hotel must be in your project's content set: your project's, or instead that of the project YGO set it to share content from.

    Example
    0192fb17-5dc6-7abc-8def-123456789abc
  • GlobalHotelID string

    Cross-tenant global hotel identifier, one of three mutually exclusive selectors. The resolved hotel must be in your project's content set (see HotelID).

    Example
    ES-MALLR-K7MP2
  • ExternalHotelID map of string to string

    Resolve the hotel by your own identifiers, AND-combined when several are given. Sub-key names are case-insensitive; productid compares exactly, giata and peakworkgoalid are positive integers compared by number, giata up to 2147483647.

    Example
    {
      "productid": "HTL-MAJ-4711"
    }
Example request: Resolve by hotel UUID
{
  "HotelID": "0192fb17-5dc6-7abc-8def-123456789abc"
}
Example request: Resolve by global hotel ID
{
  "GlobalHotelID": "ES-MALLR-K7MP2"
}
Example request: Resolve by the project's own product ID
{
  "ExternalHotelID": {
    "productid": "HTL-MAJ-4711"
  }
}
Example request: Resolve by product ID and GIATA together (both must match the same hotel)
{
  "ExternalHotelID": {
    "productid": "HTL-MAJ-4711",
    "giata": "668370"
  }
}
Example request: Resolve by the hotel's Peakwork Goal ID
{
  "ExternalHotelID": {
    "peakworkgoalid": "864521"
  }
}

Responses

200 OK

Enriched hotel retrieved successfully.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object GetEnrichedHotelResponse

Single-object response envelope wrapping the enriched hotel.

  • Data object EnrichedHotel required

    A fully enriched hotel with its identity, location, factual attributes, structured check-in / check-out times, per-locale generated texts, guest rating, images, and rooms.

    26 fields
    • ID string (uuid) required

      Unique hotel UUID.

      Example
      0192fb17-5dc6-7abc-8def-123456789abc
    • Name string required

      Normalized English (en-US) hotel display name.

      Example
      Bahia Azul Beach Resort
    • Names map of string to string required

      Per-locale display names keyed by BCP 47 language tag, always including en-US. Other locales appear only when a localized name has been generated.

      Example
      {
        "en-US": "Bahia Azul Beach Resort",
        "de-DE": "Bahia Azul Strandresort"
      }
    • ExternalHotelIDs map of string to string

      External identifiers this hotel is known by, omitted when it has none. Current keys are ProductID, Giata and PeakworkGoalID, each only when it applies; the map is open, so read the keys you need.

      Example
      {
        "ProductID": "HTL-MAJ-4711",
        "Giata": "668370",
        "PeakworkGoalID": "864521"
      }
    • GlobalHotelID string

      Cross-tenant global hotel identifier. Omitted when the hotel has no global ID assigned.

      Example
      ES-MALLR-K7MP2
    • Stars number (float) required

      The hotel's default star grade (StarsMap.default.Stars); 0 when unrated.

      Example
      4
    • StarsMap map of string to object StarsMap required

      Grades by source, in default's order: project (content set's, if set), national, association, canonical (own site); new keys may appear. default is always present: the first one set, else the collected rating or 0.

      Each value

      One star grade from one source, or the computed default. Stars, Superior and Garni are always present; further members may be added, so ignore members you do not read.

      3 fields
      • Stars number (float) required

        The grade (for example 4 or 4.5), with at most one decimal except a default taken from the collected rating. Only default may be 0 (unrated), and default.Stars always equals the top-level Stars.

        Example
        4
        Limits
        min 0, max 10
      • Superior boolean required

        True when the grade is a Superior class on top of Stars, such as the "S" suffix of a national classification; a "4 Superior" is Stars 4 with Superior true, never 4.5. False when the source sets no Superior.

        Example
        true
      • Garni boolean required

        True when the source classifies the hotel as a garni, a hotel that serves breakfast but no other meals, such as the "Garni" suffix of a national classification. False when the source sets no Garni.

        Example
        false
    • AccommodationType string required

      Accommodation kind, for example hotel, apartment, aparthotel, resort, villa, hostel, guesthouse, bed_and_breakfast, cruise_ship or holiday_village. The set of values may be extended, so read it as an open string.

      Example
      hotel
    • Chain string

      Hotel company the property belongs to. Omitted when the hotel has no chain recorded.

      Example
      Accor
    • Brand string

      Product line within the chain the property is marketed under. Omitted when the hotel has no brand recorded.

      Example
      Novotel
    • Location object Location required

      Geographic location of the hotel.

      4 fields
      • Latitude number (double) required

        Latitude in decimal degrees.

        Example
        39.5696
      • Longitude number (double) required

        Longitude in decimal degrees.

        Example
        2.6502
      • CountryCode string required

        ISO 3166-1 alpha-2 country code.

        Example
        ES
      • Address object Address

        Postal address and contact details extracted from enrichment details. Present only when address data is available.

        7 fields
        • Street string

          Street name and number.

          Example
          Carrer de la Mar 12
        • City string

          City or town.

          Example
          Palma
        • CityNames map of string to string

          Localized city display names keyed by BCP 47 language tag, present only when they have been generated. Fall back to City.

          Example
          {
            "en-US": "Rome",
            "de-DE": "Rom",
            "it-IT": "Roma"
          }
        • State string

          State, province, or region.

          Example
          Illes Balears
        • PostalCode string

          Postal or ZIP code.

          Example
          07015
        • Phone string

          The hotel's phone number, as its sources state it. Omitted when none is known.

          Example
          +34 971 000 000
        • Email string

          The hotel's email address, as its sources state it. Omitted when none is known.

          Example
          info@bahia-azul.example
    • FactualAttributes array of object FactualAttribute required

      Hotel-level factual attributes (amenities, facilities, grouped on-site facility families, and group header rows).

      Each item

      A factual attribute. A single fact carries a scalar Value; a grouped facility family carries Instances and an empty Value; a group header carries ValueType group.

      13 fields
      • Key string required

        Canonical attribute key.

        Example
        wifi
      • Type string

        Ontology kind resolved from the attribute tree at serve time. For this surface the value is 'factual'.

        Example
        factual
      • Name map of string to string required

        Localized attribute display names keyed by BCP 47 language tag.

        Example
        {
          "en-US": "Free WiFi",
          "de-DE": "Kostenloses WLAN"
        }
      • Value string

        Scalar value for a single fact, empty for grouped families and headers. It carries the polarity, so always render the attribute with its Value, never from Name alone.

        Example
        true
      • ValueType string required

        How Value should be interpreted: 'boolean', 'text', or 'group' for a group header row.

        Example
        boolean
      • ParentKey string

        Key of the parent category this attribute belongs to (used by clients as a section grouping).

        Example
        facilities_and_services
      • Details map of string to string

        Additional free-text properties in the source language, such as description or Category; their translations are under DetailsLocalized. Omitted when empty.

      • IsFree boolean nullable

        Whether the amenity is free of charge. true (free), false (paid), or null when unknown / not applicable.

        Example
        true
      • IsOnSite boolean

        Whether the facility or activity is on the hotel's premises (true) or only in the surrounding area (false), for example a golf course 12 km away. Hotel facts only; omitted when not determined, never null.

        Example
        false
      • GTCodes array of string

        DRV GlobalTypes codes for this attribute, general to specific: concept code, optional SubType refinement, then a free-of-charge qualifier. Omitted when the attribute has no mapping.

        Example
        [
          "GT03-POOL",
          "ST03-INSW"
        ]
      • ValueLocalized map of string to string

        Per-locale translations of the free-text Value, keyed by BCP 47 language tag; a boolean Value normally carries none. Present only when translations exist, otherwise fall back to Value.

      • DetailsLocalized map of string to map of string to string

        Per-locale translations of the free-text Details, keyed by property key, then by BCP 47 language tag. Present only when translations exist, otherwise fall back to Details.

      • Instances array of object FactualInstance

        Named outlets for a grouped on-site facility family, such as each restaurant or bar. Present only for grouped families, omitted for single-fact attributes.

        Each item

        One named outlet within a grouped on-site facility family.

        3 fields
        • Name string required

          Display name of the outlet.

          Example
          La Marea
        • Details map of string to string

          Per-outlet free-text properties, such as description or hours. Omitted when empty.

        • DetailsLocalized map of string to map of string to string

          Per-property, per-locale translations of this outlet's free-text details, keyed propertyKey then BCP 47 language tag. Fall back to Details; omitted when empty.

    • POIs array of object POI required

      Nearby points of interest with localized names and, where there is one to show, distances.

      Each item

      A nearby point of interest: one place, or an area (IsArea) such as part of a town or a beach. POI data partly © OpenStreetMap contributors, available under the ODbL.

      10 fields
      • ID string (uuid) required

        Unique POI UUID. Stable identifier used as the entity id when submitting feedback about this POI.

        Example
        0192fb20-1aa2-7def-9abc-1122334455aa
      • Name map of string to string required

        Localized POI names keyed by BCP 47 language tag, always with en-US. For an area (IsArea true) it is the area's official local name, translated per locale.

        Example
        {
          "en-US": "Palma Cathedral",
          "de-DE": "Kathedrale von Palma"
        }
      • Type string required

        POI category (e.g. landmark, beach, airport, restaurant).

        Example
        landmark
      • Distance number (double)

        Distance in Unit: meters under 1 km, else km to one decimal; for an area, to its nearest edge, its centre without an outline, or the distance its source stated. Omitted with Unit when unknown, at the hotel or InArea.

        Example
        3.2
      • Unit string

        Unit for Distance: m for meters, km for kilometers. Present exactly when Distance is present.

        Values
        m km
        Example
        km
      • IsArea boolean

        True for a POI that is an area rather than one place: an area of a town (a historic centre, an old town, a district, a promenade), or a beach located by its OpenStreetMap outline. Omitted when false.

        Example
        true
      • InArea boolean

        True when the hotel lies inside the area's outline, for a beach on its sand; Distance and Unit are then omitted. Implies IsArea; not set when a stated distance is kept, omitted when false.

        Example
        true
      • Latitude number (double)

        Latitude of the POI in decimal degrees (WGS-84). For an area (IsArea) it is the area's representative point: the centroid of its outline, which can lie off a line or an irregular area, or its single point. Sent together with Longitude; both are omitted when the POI has no known position, an area that could not be located included.

        Example
        39.5675
      • Longitude number (double)

        Longitude of the POI in decimal degrees (WGS-84). Present exactly when Latitude is present.

        Example
        2.6484
      • Details map of string to string

        Additional POI properties. Omitted when empty.

    • CheckIn object CheckIn

      Earliest check-in time. The whole object is omitted when no valid time is available.

      1 field
      • From string

        Earliest check-in time as a 24-hour 'HH:MM' clock string.

        Example
        15:00
    • CheckOut object CheckOut

      Latest check-out time. The whole object is omitted when no valid time is available.

      1 field
      • Until string

        Latest check-out time as a 24-hour 'HH:MM' clock string.

        Example
        11:00
    • GeneratedTexts map of string to map of string to object GeneratedTexts required

      Generated texts keyed by locale (BCP 47 language tag) then by template key; each value is a GeneratedTextDetail.

      Each value

      One generated text for a (locale, template key) pair. Every text served here is AI-generated and therefore carries a Compliance marker envelope.

      4 fields
      • Text string required

        The generated text, sanitized for display.

        Example
        Set on a quiet stretch of the Bay of Palma, Bahia Azul Beach Resort pairs direct beach access with bright, contemporary rooms and a sea-view rooftop pool.
      • GeneratedAt string (date-time)

        Per-text generation timestamp (RFC3339). Omitted for legacy / unstamped texts.

        Example
        2026-04-12T09:15:00Z
      • TextType string

        Set to 'rules' for rule-based texts (policies, house rules). Omitted for marketing texts.

        Example
        rules
      • Compliance object Compliance

        Regulatory marker envelope, present whenever the text is non-empty; AIGenerated is always true. Omitted on an empty text.

        1 field
        • AIGenerated boolean

          EU AI Act Article 50(2) machine-readable marker: true when the text content of the enclosing object is AI-generated. Always stated explicitly when the envelope is present.

          Example
          true
    • GuestRating object GuestRating

      Guest rating of the hotel: the guest review scores we hold, calibrated per platform and aggregated on a 0 to 100 scale, with category scores and summaries. Omitted when the hotel has no rating.

      3 fields
      • ReviewScore integer required

        Overall guest score from 0 to 100: the aggregate of the guest review scores we hold, each calibrated per review platform.

        Example
        93
        Limits
        min 0, max 100
      • SubScores object GuestRatingSubScores

        Category scores from 0 to 100 showing how a category compares with the hotel overall. A category without data is absent, never 0; omitted when no category has data.

        7 fields
        • Cleanliness integer

          Score for cleanliness, 0 to 100.

          Example
          96
          Limits
          min 0, max 100
        • Service integer

          Score for staff and service, 0 to 100.

          Example
          96
          Limits
          min 0, max 100
        • Location integer

          Score for the location, 0 to 100.

          Example
          91
          Limits
          min 0, max 100
        • Rooms integer

          Score for the rooms, 0 to 100.

          Example
          95
          Limits
          min 0, max 100
        • Food integer

          Score for food and drink, 0 to 100.

          Example
          91
          Limits
          min 0, max 100
        • Value integer

          Score for value for money, 0 to 100.

          Example
          90
          Limits
          min 0, max 100
        • Facilities integer

          Score for the facilities, 0 to 100.

          Example
          93
          Limits
          min 0, max 100
      • Texts map of string to object GuestRatingTexts

        AI-generated summaries of guest opinion keyed by locale (BCP 47 language tag); they quote no review. Omitted when no text has been generated.

        Each value

        What guests say about the hotel in one locale: a short summary with the points most often praised and criticized.

        5 fields
        • Summary string required

          Short paragraph summarizing guest opinion of the hotel.

          Example
          Guests consistently describe their stay as a peaceful, relaxing retreat highlighted by exceptionally friendly and attentive staff. Rooms and grounds are praised for being spotless and comfortable, while the delicious breakfast and calm adults-only setting make it an ideal getaway.
        • Pros array of string

          Up to 5 points guests praise. Omitted when there are none.

          Example
          [
            "Warm, attentive, and professional staff",
            "Spotless rooms and well-kept grounds",
            "Peaceful, child-free atmosphere",
            "Superb and varied breakfast spread",
            "Modern, spacious guest rooms"
          ]
          Limits
          max items 5
        • Cons array of string

          Up to 3 points guests criticize. Omitted when there are none.

          Example
          [
            "Extra charges for some premium drinks and minibar",
            "Lunch and dinner buffets can feel repetitive to some"
          ]
          Limits
          max items 3
        • GeneratedAt string (date-time)

          Generation timestamp of this text (RFC3339). Omitted for an unstamped text.

          Example
          2026-11-05T18:10:57Z
        • Compliance object Compliance

          Regulatory marker envelope, present on every served text; AIGenerated is always true.

          1 field
          • AIGenerated boolean

            EU AI Act Article 50(2) machine-readable marker: true when the text content of the enclosing object is AI-generated. Always stated explicitly when the envelope is present.

            Example
            true
    • RenderLayouts map of string to string

      Optional rendering hints, not enrichment data: template key to layout hint such as prose, highlights, roomcards or summary. Only keys whose template carries a hint are included.

      Example
      {
        "Summary": "prose",
        "HouseRules": "highlights"
      }
    • Images array of object Image required

      Hotel-level images, deduplicated and sorted by category priority. An image pinned in your project's content set (see PinnedImageID) is served first, ahead of that order.

      Each item

      An enriched image with vision-derived metadata.

      26 fields
      • ID string (uuid) required

        Unique image UUID.

        Example
        0192fb20-1aa2-7def-9abc-1122334455aa
      • URL string (uri) required

        Image URL.

        Example
        https://cdn.ygo.ai/hotels/bahia-azul/exterior-pool.jpg
      • Source string

        Detected provenance of the pixels: photo, render, illustration or ai_generated. Omitted when the image carries no provenance assessment.

        Example
        photo
      • Category string

        Vision-derived image category (e.g. exterior, room, pool, restaurant).

        Example
        exterior
      • Features array of string

        Vision-derived feature tags depicted in the image.

        Example
        [
          "pool",
          "sea_view"
        ]
      • Mood array of string

        Vision-derived mood descriptors.

        Example
        [
          "relaxing"
        ]
      • Tags array of string

        Additional vision-derived tags.

        Example
        [
          "rooftop",
          "sunset"
        ]
      • Flags array of string

        Quality / content flags raised by vision analysis. Omitted when empty.

      • AppealScore integer

        Appeal score from 0 to 100, or -1 when there is no scorer-stamped value and no value above 0, normally because nothing has scored the image yet. -1 is not a score and does not affect image order.

        Example
        88
      • QualityScore integer

        Technical quality score from 0 to 100, or -1 when there is no scorer-stamped value and no value above 0, normally because nothing has scored the image yet. -1 is not a score and does not affect image order.

        Example
        91
      • AppealScoreVersion string

        Version stamp of the scorer that produced AppealScore, for example app-v4; it may name an earlier version. Absent when AppealScore is -1 or a legacy score from before stamps existed.

        Example
        app-v4
      • QualityScoreVersion string

        Version stamp of the scorer that produced QualityScore, for example qs-v4; it may name an earlier version. Absent when QualityScore is -1, a legacy score, or a first-seen image's provisional score.

        Example
        qs-v4
      • Width integer

        Image width in pixels.

        Example
        1600
      • Height integer

        Image height in pixels.

        Example
        1067
      • Format string

        Image format (e.g. jpeg, png, webp).

        Example
        jpeg
      • FileSize integer

        File size in bytes.

        Example
        412000
      • DominantColor string

        Dominant color as a hex string.

        Example
        #2E6F95
      • BlurHash string

        BlurHash placeholder string for progressive loading.

        Example
        LKO2?U%2Tw=w]~RBVZRi};RPxuwH
      • FileMetadata object

        What the image file itself states in its embedded IPTC/EXIF/XMP metadata: capture date and copyright notice. Omitted when the file states neither; inside it, a value the file did not state has no key.

        Example
        {
          "CaptureDate": "2012-06-14",
          "Copyright": "© 2012 Hotel Sol S.A."
        }
        2 fields
        • CaptureDate string

          Date the photograph was taken, at the precision the file stated: 2012-06-14, 2012-06 or 2012. It carries no time of day and no timezone.

          Example
          2012-06-14
          Limits
          pattern ^\d{4}(-\d{2}(-\d{2})?)?$
        • Copyright string

          The copyright notice the file carries, as the file wrote it. It names who to ask; it is not a machine-readable licence.

          Example
          © 2012 Hotel Sol S.A.
      • Descriptions map of string to string

        Neutral alt text describing what the image shows, not marketing copy, keyed by BCP 47 language tag. More locales may be added after an image is first analyzed.

        Example
        {
          "en-US": "Rooftop infinity pool overlooking the Bay of Palma at sunset."
        }
      • Compliance object Compliance

        EU AI Act Article 50(2) marker for this image. Always present with AIGenerated true: the category, features, mood, tags, scores and descriptions are model output, FileMetadata is not.

        1 field
        • AIGenerated boolean

          EU AI Act Article 50(2) machine-readable marker: true when the text content of the enclosing object is AI-generated. Always stated explicitly when the envelope is present.

          Example
          true
      • Presence array of object PresenceDetection

        People and animals seen in the image, from the closed vocabulary person, adult, child, animal. Omitted when the image carries no presence measurement.

        Each item

        One person or animal seen in the image.

        2 fields
        • Label string required

          What was seen: person, adult, child or animal.

          Example
          adult
        • Confidence number (float) DetectionConfidence required nullable

          Confidence between 0 and 1, or null when the entry was asserted without a measured confidence. An entry the analysis did not assert is absent from its list rather than scored zero.

          Example
          0.94
          Limits
          min 0, max 1
      • Safety map of string to number (float) DetectionConfidence

        Safety confidences keyed by dimension, Inappropriate and OffTopic, each between 0 and 1 or null. Omitted when the image carries no safety measurement.

        Each value
        nullable

        Confidence between 0 and 1, or null when the entry was asserted without a measured confidence. An entry the analysis did not assert is absent from its list rather than scored zero.

        Example
        0.94 (each value)
        Limits
        each value: min 0, each value: max 1
      • TextDetections array of object TextDetection

        Texts read off the image, each with its kind. Omitted when the image carries no text measurement.

        Each item

        One text read off the image.

        3 fields
        • Content string required

          The text as it appears on the image. A password or access code printed after a password label is masked.

          Example
          POOL BAR
        • Label string required

          Kind of text: overlay, price, promotional, watermark, signage or document.

          Example
          signage
        • Confidence number (float) DetectionConfidence required nullable

          Confidence between 0 and 1, or null when the entry was asserted without a measured confidence. An entry the analysis did not assert is absent from its list rather than scored zero.

          Example
          0.94
          Limits
          min 0, max 1
      • FeatureDetections array of object FeatureDetection

        The image's features with the confidence measured for each, running parallel to Features. Omitted when the image carries no feature measurement.

        Each item

        One feature of the image with the confidence measured for it.

        2 fields
        • Label string required

          The feature label, from the same vocabulary as Features.

          Example
          sea_view
        • Confidence number (float) DetectionConfidence required nullable

          Confidence between 0 and 1, or null when the entry was asserted without a measured confidence. An entry the analysis did not assert is absent from its list rather than scored zero.

          Example
          0.94
          Limits
          min 0, max 1
      • Nudity object

        Nudity assessment: exposure score, reason and explicit flag, independent of Safety.Inappropriate. Omitted when the assessment did not run or the image's Presence shows no person.

        3 fields
        • Score integer required

          Exposure score from 0 to 100. Anchors: 20 beach or casual wear, 40 standard swimwear, 60 revealing swimwear or lingerie, 80 partial nudity, 100 explicit.

          Example
          60
          Limits
          min 0, max 100
        • Reason string required

          One model-written sentence naming what drives the score, at most 240 characters. Not sanitized for markup, so escape it before rendering.

          Example
          Adult in revealing swimwear by the pool.
        • Explicit boolean required

          True from a score of 90 up. Whether a child is in the picture is answered by Presence, not here.

          Example
          false
    • PinnedImageID string (uuid)

      UUID of the pinned image promoted to the front of Images, always the first entry's ID. Omitted when no pin is in effect.

      Example
      0192fb20-1aa2-7def-9abc-1122334455aa
    • Rooms array of object EnrichedRoom required

      Enriched room types belonging to this hotel.

      Each item

      An enriched room type belonging to a hotel.

      12 fields
      • ID string (uuid) required

        Unique room UUID.

        Example
        0192fb30-2bb3-7abc-8def-99887766aabb
      • Name map of string to string required

        Localized room names keyed by BCP 47 language tag. Always contains en-US when a base room name exists.

        Example
        {
          "en-US": "Double Room Sea View",
          "de-DE": "Doppelzimmer mit Meerblick"
        }
      • SizeSqm integer

        Room size in square meters. 0 when unknown.

        Example
        26
      • Beddings array of array of object Bedding

        Bedding configurations. The outer array lists alternative configurations; each inner array lists the beds in one configuration.

        Each item

        A single bed entry within a bedding configuration.

        3 fields
        • Type string required

          Bed type. Known codes: SINGLE, TWIN, DOUBLE, QUEEN, KING, SOFA_BED, BUNK_BED, EXTRA_BED, CRIB, CHILD_BED, DAY_BED, MURPHY_BED, CHAIR_BED; older records can hold other values.

          Example
          DOUBLE
        • Quantity integer required

          Number of beds of this type.

          Example
          1
        • Name map of string to string

          Bed type name per room Name locale (BCP 47) in en, de, fr, it, nl, es, tr or he, shown after Quantity: singular for 1, else the counted form, plural if inflected. Absent for an unknown Type or no such locale; use Type.

          Example
          {
            "en-US": "double bed",
            "de-DE": "Doppelbett"
          }
      • FactualAttributes array of object FactualAttribute required

        Room-level factual attributes.

        Each item

        A factual attribute. A single fact carries a scalar Value; a grouped facility family carries Instances and an empty Value; a group header carries ValueType group.

        13 fields
        • Key string required

          Canonical attribute key.

          Example
          wifi
        • Type string

          Ontology kind resolved from the attribute tree at serve time. For this surface the value is 'factual'.

          Example
          factual
        • Name map of string to string required

          Localized attribute display names keyed by BCP 47 language tag.

          Example
          {
            "en-US": "Free WiFi",
            "de-DE": "Kostenloses WLAN"
          }
        • Value string

          Scalar value for a single fact, empty for grouped families and headers. It carries the polarity, so always render the attribute with its Value, never from Name alone.

          Example
          true
        • ValueType string required

          How Value should be interpreted: 'boolean', 'text', or 'group' for a group header row.

          Example
          boolean
        • ParentKey string

          Key of the parent category this attribute belongs to (used by clients as a section grouping).

          Example
          facilities_and_services
        • Details map of string to string

          Additional free-text properties in the source language, such as description or Category; their translations are under DetailsLocalized. Omitted when empty.

        • IsFree boolean nullable

          Whether the amenity is free of charge. true (free), false (paid), or null when unknown / not applicable.

          Example
          true
        • IsOnSite boolean

          Whether the facility or activity is on the hotel's premises (true) or only in the surrounding area (false), for example a golf course 12 km away. Hotel facts only; omitted when not determined, never null.

          Example
          false
        • GTCodes array of string

          DRV GlobalTypes codes for this attribute, general to specific: concept code, optional SubType refinement, then a free-of-charge qualifier. Omitted when the attribute has no mapping.

          Example
          [
            "GT03-POOL",
            "ST03-INSW"
          ]
        • ValueLocalized map of string to string

          Per-locale translations of the free-text Value, keyed by BCP 47 language tag; a boolean Value normally carries none. Present only when translations exist, otherwise fall back to Value.

        • DetailsLocalized map of string to map of string to string

          Per-locale translations of the free-text Details, keyed by property key, then by BCP 47 language tag. Present only when translations exist, otherwise fall back to Details.

        • Instances array of object FactualInstance

          Named outlets for a grouped on-site facility family, such as each restaurant or bar. Present only for grouped families, omitted for single-fact attributes.

          Each item

          One named outlet within a grouped on-site facility family.

          3 fields
          • Name string required

            Display name of the outlet.

            Example
            La Marea
          • Details map of string to string

            Per-outlet free-text properties, such as description or hours. Omitted when empty.

          • DetailsLocalized map of string to map of string to string

            Per-property, per-locale translations of this outlet's free-text details, keyed propertyKey then BCP 47 language tag. Fall back to Details; omitted when empty.

      • GeneratedTexts map of string to map of string to object GeneratedTexts

        Generated texts keyed by locale (BCP 47 language tag) then by template key; each value is a GeneratedTextDetail.

        Each value

        One generated text for a (locale, template key) pair. Every text served here is AI-generated and therefore carries a Compliance marker envelope.

        4 fields
        • Text string required

          The generated text, sanitized for display.

          Example
          Set on a quiet stretch of the Bay of Palma, Bahia Azul Beach Resort pairs direct beach access with bright, contemporary rooms and a sea-view rooftop pool.
        • GeneratedAt string (date-time)

          Per-text generation timestamp (RFC3339). Omitted for legacy / unstamped texts.

          Example
          2026-04-12T09:15:00Z
        • TextType string

          Set to 'rules' for rule-based texts (policies, house rules). Omitted for marketing texts.

          Example
          rules
        • Compliance object Compliance

          Regulatory marker envelope, present whenever the text is non-empty; AIGenerated is always true. Omitted on an empty text.

          1 field
          • AIGenerated boolean

            EU AI Act Article 50(2) machine-readable marker: true when the text content of the enclosing object is AI-generated. Always stated explicitly when the envelope is present.

            Example
            true
      • RenderLayouts map of string to string required

        Optional rendering hints keyed by room template namespace (empty string for bare template keys). One layout governs the whole room card.

        Example
        {
          "": "roomcards"
        }
      • ExternalRoomIDs map of string to array of string

        Your own identifiers for this room, omitted when it has none. Current key is ProductRoomIDs, sorted and included only for confident matches; several ids can map to one room.

        Example
        {
          "ProductRoomIDs": [
            "11824",
            "11902"
          ]
        }
      • Images array of object Image required

        Room-level images, deduplicated and sorted by category priority.

        Each item

        An enriched image with vision-derived metadata.

        26 fields
        • ID string (uuid) required

          Unique image UUID.

          Example
          0192fb20-1aa2-7def-9abc-1122334455aa
        • URL string (uri) required

          Image URL.

          Example
          https://cdn.ygo.ai/hotels/bahia-azul/exterior-pool.jpg
        • Source string

          Detected provenance of the pixels: photo, render, illustration or ai_generated. Omitted when the image carries no provenance assessment.

          Example
          photo
        • Category string

          Vision-derived image category (e.g. exterior, room, pool, restaurant).

          Example
          exterior
        • Features array of string

          Vision-derived feature tags depicted in the image.

          Example
          [
            "pool",
            "sea_view"
          ]
        • Mood array of string

          Vision-derived mood descriptors.

          Example
          [
            "relaxing"
          ]
        • Tags array of string

          Additional vision-derived tags.

          Example
          [
            "rooftop",
            "sunset"
          ]
        • Flags array of string

          Quality / content flags raised by vision analysis. Omitted when empty.

        • AppealScore integer

          Appeal score from 0 to 100, or -1 when there is no scorer-stamped value and no value above 0, normally because nothing has scored the image yet. -1 is not a score and does not affect image order.

          Example
          88
        • QualityScore integer

          Technical quality score from 0 to 100, or -1 when there is no scorer-stamped value and no value above 0, normally because nothing has scored the image yet. -1 is not a score and does not affect image order.

          Example
          91
        • AppealScoreVersion string

          Version stamp of the scorer that produced AppealScore, for example app-v4; it may name an earlier version. Absent when AppealScore is -1 or a legacy score from before stamps existed.

          Example
          app-v4
        • QualityScoreVersion string

          Version stamp of the scorer that produced QualityScore, for example qs-v4; it may name an earlier version. Absent when QualityScore is -1, a legacy score, or a first-seen image's provisional score.

          Example
          qs-v4
        • Width integer

          Image width in pixels.

          Example
          1600
        • Height integer

          Image height in pixels.

          Example
          1067
        • Format string

          Image format (e.g. jpeg, png, webp).

          Example
          jpeg
        • FileSize integer

          File size in bytes.

          Example
          412000
        • DominantColor string

          Dominant color as a hex string.

          Example
          #2E6F95
        • BlurHash string

          BlurHash placeholder string for progressive loading.

          Example
          LKO2?U%2Tw=w]~RBVZRi};RPxuwH
        • FileMetadata object

          What the image file itself states in its embedded IPTC/EXIF/XMP metadata: capture date and copyright notice. Omitted when the file states neither; inside it, a value the file did not state has no key.

          Example
          {
            "CaptureDate": "2012-06-14",
            "Copyright": "© 2012 Hotel Sol S.A."
          }
          2 fields
          • CaptureDate string

            Date the photograph was taken, at the precision the file stated: 2012-06-14, 2012-06 or 2012. It carries no time of day and no timezone.

            Example
            2012-06-14
            Limits
            pattern ^\d{4}(-\d{2}(-\d{2})?)?$
          • Copyright string

            The copyright notice the file carries, as the file wrote it. It names who to ask; it is not a machine-readable licence.

            Example
            © 2012 Hotel Sol S.A.
        • Descriptions map of string to string

          Neutral alt text describing what the image shows, not marketing copy, keyed by BCP 47 language tag. More locales may be added after an image is first analyzed.

          Example
          {
            "en-US": "Rooftop infinity pool overlooking the Bay of Palma at sunset."
          }
        • Compliance object Compliance

          EU AI Act Article 50(2) marker for this image. Always present with AIGenerated true: the category, features, mood, tags, scores and descriptions are model output, FileMetadata is not.

          1 field
          • AIGenerated boolean

            EU AI Act Article 50(2) machine-readable marker: true when the text content of the enclosing object is AI-generated. Always stated explicitly when the envelope is present.

            Example
            true
        • Presence array of object PresenceDetection

          People and animals seen in the image, from the closed vocabulary person, adult, child, animal. Omitted when the image carries no presence measurement.

          Each item

          One person or animal seen in the image.

          2 fields
          • Label string required

            What was seen: person, adult, child or animal.

            Example
            adult
          • Confidence number (float) DetectionConfidence required nullable

            Confidence between 0 and 1, or null when the entry was asserted without a measured confidence. An entry the analysis did not assert is absent from its list rather than scored zero.

            Example
            0.94
            Limits
            min 0, max 1
        • Safety map of string to number (float) DetectionConfidence

          Safety confidences keyed by dimension, Inappropriate and OffTopic, each between 0 and 1 or null. Omitted when the image carries no safety measurement.

          Each value
          nullable

          Confidence between 0 and 1, or null when the entry was asserted without a measured confidence. An entry the analysis did not assert is absent from its list rather than scored zero.

          Example
          0.94 (each value)
          Limits
          each value: min 0, each value: max 1
        • TextDetections array of object TextDetection

          Texts read off the image, each with its kind. Omitted when the image carries no text measurement.

          Each item

          One text read off the image.

          3 fields
          • Content string required

            The text as it appears on the image. A password or access code printed after a password label is masked.

            Example
            POOL BAR
          • Label string required

            Kind of text: overlay, price, promotional, watermark, signage or document.

            Example
            signage
          • Confidence number (float) DetectionConfidence required nullable

            Confidence between 0 and 1, or null when the entry was asserted without a measured confidence. An entry the analysis did not assert is absent from its list rather than scored zero.

            Example
            0.94
            Limits
            min 0, max 1
        • FeatureDetections array of object FeatureDetection

          The image's features with the confidence measured for each, running parallel to Features. Omitted when the image carries no feature measurement.

          Each item

          One feature of the image with the confidence measured for it.

          2 fields
          • Label string required

            The feature label, from the same vocabulary as Features.

            Example
            sea_view
          • Confidence number (float) DetectionConfidence required nullable

            Confidence between 0 and 1, or null when the entry was asserted without a measured confidence. An entry the analysis did not assert is absent from its list rather than scored zero.

            Example
            0.94
            Limits
            min 0, max 1
        • Nudity object

          Nudity assessment: exposure score, reason and explicit flag, independent of Safety.Inappropriate. Omitted when the assessment did not run or the image's Presence shows no person.

          3 fields
          • Score integer required

            Exposure score from 0 to 100. Anchors: 20 beach or casual wear, 40 standard swimwear, 60 revealing swimwear or lingerie, 80 partial nudity, 100 explicit.

            Example
            60
            Limits
            min 0, max 100
          • Reason string required

            One model-written sentence naming what drives the score, at most 240 characters. Not sanitized for markup, so escape it before rendering.

            Example
            Adult in revealing swimwear by the pool.
          • Explicit boolean required

            True from a score of 90 up. Whether a child is in the picture is answered by Presence, not here.

            Example
            false
      • Status string required

        Room lifecycle status (e.g. active).

        Example
        active
      • CreatedAt string (date-time) required

        Timestamp when the room record was created (RFC3339).

        Example
        2026-03-01T08:00:00Z
      • UpdatedAt string (date-time) required

        Timestamp when the room record was last updated (RFC3339).

        Example
        2026-04-10T12:30:00Z
    • Tags array of object ProjectTagSummary

      Internal tags of your project's content set applied to the hotel (your project's, or instead those of the project YGO set it to share content from). Present only when the hotel carries one or more; omitted otherwise.

      Each item

      A reference to one internal tag of your project's content set applied to the hotel: the tag id, display name and optional description.

      3 fields
      • ID string (uuid) required

        Unique project tag UUID.

        Example
        0192fc01-1111-7abc-8def-aaaaaaaaaaaa
      • Name string required

        Tag display name.

        Example
        Summer Campaign
      • Description string

        Tag description. Omitted when the tag has none.

        Example
        Hotels in the 2026 summer campaign
    • Status string required

      The hotel's status in your project, first match wins: closed_permanently, closed_temporarily, removed (out of the catalog), inactive, active (active in the catalog, with texts), else draft.

      Values
      draft active inactive closed_temporarily closed_permanently removed
      Example
      active
    • TextStatus string

      Your project's text state of the hotel, first match wins: generating, failed (latest generation failed; older texts stay), generated (texts held), else none.

      Values
      none generating generated failed
      Example
      generated
    • CreatedAt string (date-time) required

      Timestamp when the hotel record was created (RFC3339).

      Example
      2026-03-01T08:00:00Z
    • UpdatedAt string (date-time) required

      Timestamp when the hotel record was last updated (RFC3339).

      Example
      2026-04-12T09:15:00Z
Example response: A fully enriched Mallorca-style hotel
{
  "Data": {
    "ID": "0192fb17-5dc6-7abc-8def-123456789abc",
    "Name": "Bahia Azul Beach Resort",
    "Names": {
      "en-US": "Bahia Azul Beach Resort",
      "de-DE": "Bahia Azul Strandresort"
    },
    "ExternalHotelIDs": {
      "ProductID": "HTL-MAJ-4711",
      "Giata": "668370",
      "PeakworkGoalID": "864521"
    },
    "GlobalHotelID": "ES-MALLR-K7MP2",
    "Stars": 4.5,
    "StarsMap": {
      "default": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      },
      "project": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      }
    },
    "AccommodationType": "resort",
    "Chain": "Meliá Hotels International",
    "Brand": "Sol by Meliá",
    "Location": {
      "Latitude": 39.5696,
      "Longitude": 2.6502,
      "CountryCode": "ES",
      "Address": {
        "Street": "Carrer de la Mar 12",
        "City": "Palma",
        "CityNames": {
          "en-US": "Palma",
          "de-DE": "Palma"
        },
        "State": "Illes Balears",
        "PostalCode": "07015",
        "Phone": "+34 971 000 000",
        "Email": "info@bahia-azul.example"
      }
    },
    "FactualAttributes": [
      {
        "Key": "wifi",
        "Type": "factual",
        "Name": {
          "en-US": "Free WiFi",
          "de-DE": "Kostenloses WLAN"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": true,
        "GTCodes": [
          "GT03-INTE",
          "AT03-FRCH"
        ]
      },
      {
        "Key": "parking",
        "Type": "factual",
        "Name": {
          "en-US": "Parking",
          "de-DE": "Parkplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": false,
        "GTCodes": [
          "GT03-CAPA",
          "AT03-EXCO"
        ]
      },
      {
        "Key": "golf_course",
        "Type": "factual",
        "Name": {
          "en-US": "Golf course",
          "de-DE": "Golfplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "leisure_and_wellness",
        "IsFree": null,
        "GTCodes": [
          "GT03-GOLF"
        ],
        "IsOnSite": false
      },
      {
        "Key": "restaurant",
        "Type": "factual",
        "Name": {
          "en-US": "Restaurants",
          "de-DE": "Restaurants"
        },
        "ValueType": "group",
        "ParentKey": "food_and_drink",
        "IsFree": null,
        "GTCodes": [
          "GT03-REST"
        ],
        "Instances": [
          {
            "Name": "La Marea",
            "Details": {
              "description": "Mediterranean a la carte restaurant with sea views.",
              "hours": "19:00-23:00"
            }
          },
          {
            "Name": "Buffet Central",
            "Details": {
              "description": "Main buffet restaurant serving breakfast, lunch and dinner."
            }
          }
        ]
      }
    ],
    "POIs": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-3344556677cc",
        "Name": {
          "en-US": "Es Portitxol",
          "de-DE": "Es Portitxol"
        },
        "Type": "attraction",
        "IsArea": true,
        "InArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-2233445566bb",
        "Name": {
          "en-US": "Can Pere Antoni Beach",
          "de-DE": "Strand Can Pere Antoni"
        },
        "Type": "beach",
        "Distance": 250,
        "Unit": "m"
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-4455667788dd",
        "Name": {
          "en-US": "Palma Old Town",
          "de-DE": "Altstadt von Palma"
        },
        "Type": "attraction",
        "Distance": 2.4,
        "Unit": "km",
        "IsArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "Name": {
          "en-US": "Palma Cathedral",
          "de-DE": "Kathedrale von Palma"
        },
        "Type": "landmark",
        "Distance": 3.2,
        "Unit": "km",
        "Latitude": 39.5675,
        "Longitude": 2.6484
      }
    ],
    "CheckIn": {
      "From": "15:00"
    },
    "CheckOut": {
      "Until": "11:00"
    },
    "GeneratedTexts": {
      "en-US": {
        "Summary": {
          "Text": "Set on a quiet stretch of the Bay of Palma, Bahia Azul Beach Resort pairs direct beach access with bright, contemporary rooms and a sea-view rooftop pool.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Check-in is from 15:00 and check-out is until 11:00. Pets are not permitted. Quiet hours apply between 23:00 and 08:00.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      },
      "de-DE": {
        "Summary": {
          "Text": "Das Bahia Azul Strandresort liegt an einem ruhigen Abschnitt der Bucht von Palma und verbindet direkten Strandzugang mit hellen, modernen Zimmern und einem Dachpool mit Meerblick.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Der Check-in ist ab 15:00 Uhr und der Check-out bis 11:00 Uhr moeglich. Haustiere sind nicht gestattet. Ruhezeiten gelten zwischen 23:00 und 08:00 Uhr.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "GuestRating": {
      "ReviewScore": 93,
      "SubScores": {
        "Cleanliness": 96,
        "Facilities": 93,
        "Food": 91,
        "Location": 91,
        "Rooms": 95,
        "Service": 96,
        "Value": 90
      },
      "Texts": {
        "en-US": {
          "Summary": "Guests consistently describe their stay as a peaceful, relaxing retreat highlighted by exceptionally friendly and attentive staff. Rooms and grounds are praised for being spotless and comfortable, while the delicious breakfast and calm adults-only setting make it an ideal getaway.",
          "Pros": [
            "Warm, attentive, and professional staff",
            "Spotless rooms and well-kept grounds",
            "Peaceful, child-free atmosphere",
            "Superb and varied breakfast spread",
            "Modern, spacious guest rooms"
          ],
          "Cons": [
            "Extra charges for some premium drinks and minibar",
            "Lunch and dinner buffets can feel repetitive to some"
          ],
          "GeneratedAt": "2026-11-05T18:10:57Z",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "RenderLayouts": {
      "Summary": "prose",
      "HouseRules": "highlights"
    },
    "Images": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "URL": "https://cdn.ygo.ai/hotels/bahia-azul/exterior-pool.jpg",
        "Source": "photo",
        "Category": "exterior",
        "Features": [
          "pool",
          "sea_view"
        ],
        "Mood": [
          "relaxing"
        ],
        "Tags": [
          "rooftop",
          "sunset"
        ],
        "AppealScore": 88,
        "QualityScore": 91,
        "AppealScoreVersion": "app-v4",
        "QualityScoreVersion": "qs-v4",
        "Width": 1600,
        "Height": 1067,
        "Format": "jpeg",
        "FileSize": 412000,
        "DominantColor": "#2E6F95",
        "BlurHash": "LKO2?U%2Tw=w]~RBVZRi};RPxuwH",
        "FileMetadata": {
          "CaptureDate": "2012-06-14",
          "Copyright": "© 2012 Hotel Sol S.A."
        },
        "Descriptions": {
          "en-US": "Rooftop infinity pool overlooking the Bay of Palma at sunset."
        },
        "Compliance": {
          "AIGenerated": true
        },
        "Presence": [
          {
            "Label": "person",
            "Confidence": 0.91
          },
          {
            "Label": "adult",
            "Confidence": 0.86
          }
        ],
        "Safety": {
          "Inappropriate": 0.02,
          "OffTopic": null
        },
        "TextDetections": [
          {
            "Content": "POOL BAR",
            "Label": "signage",
            "Confidence": 0.74
          }
        ],
        "FeatureDetections": [
          {
            "Label": "pool",
            "Confidence": 0.96
          },
          {
            "Label": "sea_view",
            "Confidence": 0.9
          }
        ]
      }
    ],
    "Rooms": [
      {
        "ID": "0192fb30-2bb3-7abc-8def-99887766aabb",
        "Name": {
          "en-US": "Double Room Sea View",
          "de-DE": "Doppelzimmer mit Meerblick"
        },
        "SizeSqm": 26,
        "Beddings": [
          [
            {
              "Type": "DOUBLE",
              "Quantity": 1,
              "Name": {
                "en-US": "double bed",
                "de-DE": "Doppelbett"
              }
            }
          ],
          [
            {
              "Type": "TWIN",
              "Quantity": 2,
              "Name": {
                "en-US": "twin beds",
                "de-DE": "Einzelbetten"
              }
            }
          ]
        ],
        "FactualAttributes": [
          {
            "Key": "air_conditioning",
            "Type": "factual",
            "Name": {
              "en-US": "Air Conditioning",
              "de-DE": "Klimaanlage"
            },
            "Value": "true",
            "ValueType": "boolean",
            "ParentKey": "room_facilities",
            "IsFree": true,
            "GTCodes": [
              "GT05-AICO",
              "AT05-FRCH"
            ]
          }
        ],
        "GeneratedTexts": {
          "en-US": {
            "RoomDescription": {
              "Text": "A bright 26 sqm room with a private balcony framing the bay, a king-size bed and a walk-in rain shower.",
              "Compliance": {
                "AIGenerated": true
              }
            }
          }
        },
        "RenderLayouts": {
          "": "roomcards"
        },
        "ExternalRoomIDs": {
          "ProductRoomIDs": [
            "11824",
            "11902"
          ]
        },
        "Images": [
          {
            "ID": "0192fb31-3cc4-7abc-8def-aabbccddeeff",
            "URL": "https://cdn.ygo.ai/hotels/bahia-azul/room-seaview.jpg",
            "Category": "room",
            "Features": [
              "balcony",
              "sea_view"
            ],
            "Mood": [
              "bright"
            ],
            "Tags": [
              "king_bed"
            ],
            "AppealScore": 80,
            "QualityScore": 84,
            "AppealScoreVersion": "app-v4",
            "QualityScoreVersion": "qs-v4",
            "Width": 1500,
            "Height": 1000,
            "Format": "jpeg",
            "FileSize": 356000,
            "DominantColor": "#D9E2EC",
            "BlurHash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
            "Descriptions": {
              "en-US": "Sea-view double room with a private balcony."
            },
            "Compliance": {
              "AIGenerated": true
            }
          }
        ],
        "Status": "active",
        "CreatedAt": "2026-03-01T08:00:00Z",
        "UpdatedAt": "2026-04-10T12:30:00Z"
      }
    ],
    "Tags": [
      {
        "ID": "0192fc01-1111-7abc-8def-aaaaaaaaaaaa",
        "Name": "Summer Campaign",
        "Description": "Hotels in the 2026 summer campaign"
      }
    ],
    "Status": "active",
    "TextStatus": "generated",
    "CreatedAt": "2026-03-01T08:00:00Z",
    "UpdatedAt": "2026-04-12T09:15:00Z"
  }
}
Example response: A fully enriched Mallorca-style hotel
{
  "Data": {
    "ID": "0192fb17-5dc6-7abc-8def-123456789abc",
    "Name": "Bahia Azul Beach Resort",
    "Names": {
      "en-US": "Bahia Azul Beach Resort",
      "de-DE": "Bahia Azul Strandresort"
    },
    "ExternalHotelIDs": {
      "ProductID": "HTL-MAJ-4711",
      "Giata": "668370",
      "PeakworkGoalID": "864521"
    },
    "GlobalHotelID": "ES-MALLR-K7MP2",
    "Stars": 4.5,
    "StarsMap": {
      "default": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      },
      "project": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      }
    },
    "AccommodationType": "resort",
    "Chain": "Meliá Hotels International",
    "Brand": "Sol by Meliá",
    "Location": {
      "Latitude": 39.5696,
      "Longitude": 2.6502,
      "CountryCode": "ES",
      "Address": {
        "Street": "Carrer de la Mar 12",
        "City": "Palma",
        "CityNames": {
          "en-US": "Palma",
          "de-DE": "Palma"
        },
        "State": "Illes Balears",
        "PostalCode": "07015",
        "Phone": "+34 971 000 000",
        "Email": "info@bahia-azul.example"
      }
    },
    "FactualAttributes": [
      {
        "Key": "wifi",
        "Type": "factual",
        "Name": {
          "en-US": "Free WiFi",
          "de-DE": "Kostenloses WLAN"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": true,
        "GTCodes": [
          "GT03-INTE",
          "AT03-FRCH"
        ]
      },
      {
        "Key": "parking",
        "Type": "factual",
        "Name": {
          "en-US": "Parking",
          "de-DE": "Parkplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": false,
        "GTCodes": [
          "GT03-CAPA",
          "AT03-EXCO"
        ]
      },
      {
        "Key": "golf_course",
        "Type": "factual",
        "Name": {
          "en-US": "Golf course",
          "de-DE": "Golfplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "leisure_and_wellness",
        "IsFree": null,
        "GTCodes": [
          "GT03-GOLF"
        ],
        "IsOnSite": false
      },
      {
        "Key": "restaurant",
        "Type": "factual",
        "Name": {
          "en-US": "Restaurants",
          "de-DE": "Restaurants"
        },
        "ValueType": "group",
        "ParentKey": "food_and_drink",
        "IsFree": null,
        "GTCodes": [
          "GT03-REST"
        ],
        "Instances": [
          {
            "Name": "La Marea",
            "Details": {
              "description": "Mediterranean a la carte restaurant with sea views.",
              "hours": "19:00-23:00"
            }
          },
          {
            "Name": "Buffet Central",
            "Details": {
              "description": "Main buffet restaurant serving breakfast, lunch and dinner."
            }
          }
        ]
      }
    ],
    "POIs": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-3344556677cc",
        "Name": {
          "en-US": "Es Portitxol",
          "de-DE": "Es Portitxol"
        },
        "Type": "attraction",
        "IsArea": true,
        "InArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-2233445566bb",
        "Name": {
          "en-US": "Can Pere Antoni Beach",
          "de-DE": "Strand Can Pere Antoni"
        },
        "Type": "beach",
        "Distance": 250,
        "Unit": "m"
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-4455667788dd",
        "Name": {
          "en-US": "Palma Old Town",
          "de-DE": "Altstadt von Palma"
        },
        "Type": "attraction",
        "Distance": 2.4,
        "Unit": "km",
        "IsArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "Name": {
          "en-US": "Palma Cathedral",
          "de-DE": "Kathedrale von Palma"
        },
        "Type": "landmark",
        "Distance": 3.2,
        "Unit": "km",
        "Latitude": 39.5675,
        "Longitude": 2.6484
      }
    ],
    "CheckIn": {
      "From": "15:00"
    },
    "CheckOut": {
      "Until": "11:00"
    },
    "GeneratedTexts": {
      "en-US": {
        "Summary": {
          "Text": "Set on a quiet stretch of the Bay of Palma, Bahia Azul Beach Resort pairs direct beach access with bright, contemporary rooms and a sea-view rooftop pool.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Check-in is from 15:00 and check-out is until 11:00. Pets are not permitted. Quiet hours apply between 23:00 and 08:00.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      },
      "de-DE": {
        "Summary": {
          "Text": "Das Bahia Azul Strandresort liegt an einem ruhigen Abschnitt der Bucht von Palma und verbindet direkten Strandzugang mit hellen, modernen Zimmern und einem Dachpool mit Meerblick.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Der Check-in ist ab 15:00 Uhr und der Check-out bis 11:00 Uhr moeglich. Haustiere sind nicht gestattet. Ruhezeiten gelten zwischen 23:00 und 08:00 Uhr.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "GuestRating": {
      "ReviewScore": 93,
      "SubScores": {
        "Cleanliness": 96,
        "Facilities": 93,
        "Food": 91,
        "Location": 91,
        "Rooms": 95,
        "Service": 96,
        "Value": 90
      },
      "Texts": {
        "en-US": {
          "Summary": "Guests consistently describe their stay as a peaceful, relaxing retreat highlighted by exceptionally friendly and attentive staff. Rooms and grounds are praised for being spotless and comfortable, while the delicious breakfast and calm adults-only setting make it an ideal getaway.",
          "Pros": [
            "Warm, attentive, and professional staff",
            "Spotless rooms and well-kept grounds",
            "Peaceful, child-free atmosphere",
            "Superb and varied breakfast spread",
            "Modern, spacious guest rooms"
          ],
          "Cons": [
            "Extra charges for some premium drinks and minibar",
            "Lunch and dinner buffets can feel repetitive to some"
          ],
          "GeneratedAt": "2026-11-05T18:10:57Z",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "RenderLayouts": {
      "Summary": "prose",
      "HouseRules": "highlights"
    },
    "Images": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "URL": "https://cdn.ygo.ai/hotels/bahia-azul/exterior-pool.jpg",
        "Source": "photo",
        "Category": "exterior",
        "Features": [
          "pool",
          "sea_view"
        ],
        "Mood": [
          "relaxing"
        ],
        "Tags": [
          "rooftop",
          "sunset"
        ],
        "AppealScore": 88,
        "QualityScore": 91,
        "AppealScoreVersion": "app-v4",
        "QualityScoreVersion": "qs-v4",
        "Width": 1600,
        "Height": 1067,
        "Format": "jpeg",
        "FileSize": 412000,
        "DominantColor": "#2E6F95",
        "BlurHash": "LKO2?U%2Tw=w]~RBVZRi};RPxuwH",
        "FileMetadata": {
          "CaptureDate": "2012-06-14",
          "Copyright": "© 2012 Hotel Sol S.A."
        },
        "Descriptions": {
          "en-US": "Rooftop infinity pool overlooking the Bay of Palma at sunset."
        },
        "Compliance": {
          "AIGenerated": true
        },
        "Presence": [
          {
            "Label": "person",
            "Confidence": 0.91
          },
          {
            "Label": "adult",
            "Confidence": 0.86
          }
        ],
        "Safety": {
          "Inappropriate": 0.02,
          "OffTopic": null
        },
        "TextDetections": [
          {
            "Content": "POOL BAR",
            "Label": "signage",
            "Confidence": 0.74
          }
        ],
        "FeatureDetections": [
          {
            "Label": "pool",
            "Confidence": 0.96
          },
          {
            "Label": "sea_view",
            "Confidence": 0.9
          }
        ]
      }
    ],
    "Rooms": [
      {
        "ID": "0192fb30-2bb3-7abc-8def-99887766aabb",
        "Name": {
          "en-US": "Double Room Sea View",
          "de-DE": "Doppelzimmer mit Meerblick"
        },
        "SizeSqm": 26,
        "Beddings": [
          [
            {
              "Type": "DOUBLE",
              "Quantity": 1,
              "Name": {
                "en-US": "double bed",
                "de-DE": "Doppelbett"
              }
            }
          ],
          [
            {
              "Type": "TWIN",
              "Quantity": 2,
              "Name": {
                "en-US": "twin beds",
                "de-DE": "Einzelbetten"
              }
            }
          ]
        ],
        "FactualAttributes": [
          {
            "Key": "air_conditioning",
            "Type": "factual",
            "Name": {
              "en-US": "Air Conditioning",
              "de-DE": "Klimaanlage"
            },
            "Value": "true",
            "ValueType": "boolean",
            "ParentKey": "room_facilities",
            "IsFree": true,
            "GTCodes": [
              "GT05-AICO",
              "AT05-FRCH"
            ]
          }
        ],
        "GeneratedTexts": {
          "en-US": {
            "RoomDescription": {
              "Text": "A bright 26 sqm room with a private balcony framing the bay, a king-size bed and a walk-in rain shower.",
              "Compliance": {
                "AIGenerated": true
              }
            }
          }
        },
        "RenderLayouts": {
          "": "roomcards"
        },
        "ExternalRoomIDs": {
          "ProductRoomIDs": [
            "11824",
            "11902"
          ]
        },
        "Images": [
          {
            "ID": "0192fb31-3cc4-7abc-8def-aabbccddeeff",
            "URL": "https://cdn.ygo.ai/hotels/bahia-azul/room-seaview.jpg",
            "Category": "room",
            "Features": [
              "balcony",
              "sea_view"
            ],
            "Mood": [
              "bright"
            ],
            "Tags": [
              "king_bed"
            ],
            "AppealScore": 80,
            "QualityScore": 84,
            "AppealScoreVersion": "app-v4",
            "QualityScoreVersion": "qs-v4",
            "Width": 1500,
            "Height": 1000,
            "Format": "jpeg",
            "FileSize": 356000,
            "DominantColor": "#D9E2EC",
            "BlurHash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
            "Descriptions": {
              "en-US": "Sea-view double room with a private balcony."
            },
            "Compliance": {
              "AIGenerated": true
            }
          }
        ],
        "Status": "active",
        "CreatedAt": "2026-03-01T08:00:00Z",
        "UpdatedAt": "2026-04-10T12:30:00Z"
      }
    ],
    "Tags": [
      {
        "ID": "0192fc01-1111-7abc-8def-aaaaaaaaaaaa",
        "Name": "Summer Campaign",
        "Description": "Hotels in the 2026 summer campaign"
      }
    ],
    "Status": "active",
    "TextStatus": "generated",
    "CreatedAt": "2026-03-01T08:00:00Z",
    "UpdatedAt": "2026-04-12T09:15:00Z"
  }
}
Example response: A fully enriched Mallorca-style hotel
{
  "Data": {
    "ID": "0192fb17-5dc6-7abc-8def-123456789abc",
    "Name": "Bahia Azul Beach Resort",
    "Names": {
      "en-US": "Bahia Azul Beach Resort",
      "de-DE": "Bahia Azul Strandresort"
    },
    "ExternalHotelIDs": {
      "ProductID": "HTL-MAJ-4711",
      "Giata": "668370",
      "PeakworkGoalID": "864521"
    },
    "GlobalHotelID": "ES-MALLR-K7MP2",
    "Stars": 4.5,
    "StarsMap": {
      "default": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      },
      "project": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      }
    },
    "AccommodationType": "resort",
    "Chain": "Meliá Hotels International",
    "Brand": "Sol by Meliá",
    "Location": {
      "Latitude": 39.5696,
      "Longitude": 2.6502,
      "CountryCode": "ES",
      "Address": {
        "Street": "Carrer de la Mar 12",
        "City": "Palma",
        "CityNames": {
          "en-US": "Palma",
          "de-DE": "Palma"
        },
        "State": "Illes Balears",
        "PostalCode": "07015",
        "Phone": "+34 971 000 000",
        "Email": "info@bahia-azul.example"
      }
    },
    "FactualAttributes": [
      {
        "Key": "wifi",
        "Type": "factual",
        "Name": {
          "en-US": "Free WiFi",
          "de-DE": "Kostenloses WLAN"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": true,
        "GTCodes": [
          "GT03-INTE",
          "AT03-FRCH"
        ]
      },
      {
        "Key": "parking",
        "Type": "factual",
        "Name": {
          "en-US": "Parking",
          "de-DE": "Parkplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": false,
        "GTCodes": [
          "GT03-CAPA",
          "AT03-EXCO"
        ]
      },
      {
        "Key": "golf_course",
        "Type": "factual",
        "Name": {
          "en-US": "Golf course",
          "de-DE": "Golfplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "leisure_and_wellness",
        "IsFree": null,
        "GTCodes": [
          "GT03-GOLF"
        ],
        "IsOnSite": false
      },
      {
        "Key": "restaurant",
        "Type": "factual",
        "Name": {
          "en-US": "Restaurants",
          "de-DE": "Restaurants"
        },
        "ValueType": "group",
        "ParentKey": "food_and_drink",
        "IsFree": null,
        "GTCodes": [
          "GT03-REST"
        ],
        "Instances": [
          {
            "Name": "La Marea",
            "Details": {
              "description": "Mediterranean a la carte restaurant with sea views.",
              "hours": "19:00-23:00"
            }
          },
          {
            "Name": "Buffet Central",
            "Details": {
              "description": "Main buffet restaurant serving breakfast, lunch and dinner."
            }
          }
        ]
      }
    ],
    "POIs": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-3344556677cc",
        "Name": {
          "en-US": "Es Portitxol",
          "de-DE": "Es Portitxol"
        },
        "Type": "attraction",
        "IsArea": true,
        "InArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-2233445566bb",
        "Name": {
          "en-US": "Can Pere Antoni Beach",
          "de-DE": "Strand Can Pere Antoni"
        },
        "Type": "beach",
        "Distance": 250,
        "Unit": "m"
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-4455667788dd",
        "Name": {
          "en-US": "Palma Old Town",
          "de-DE": "Altstadt von Palma"
        },
        "Type": "attraction",
        "Distance": 2.4,
        "Unit": "km",
        "IsArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "Name": {
          "en-US": "Palma Cathedral",
          "de-DE": "Kathedrale von Palma"
        },
        "Type": "landmark",
        "Distance": 3.2,
        "Unit": "km",
        "Latitude": 39.5675,
        "Longitude": 2.6484
      }
    ],
    "CheckIn": {
      "From": "15:00"
    },
    "CheckOut": {
      "Until": "11:00"
    },
    "GeneratedTexts": {
      "en-US": {
        "Summary": {
          "Text": "Set on a quiet stretch of the Bay of Palma, Bahia Azul Beach Resort pairs direct beach access with bright, contemporary rooms and a sea-view rooftop pool.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Check-in is from 15:00 and check-out is until 11:00. Pets are not permitted. Quiet hours apply between 23:00 and 08:00.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      },
      "de-DE": {
        "Summary": {
          "Text": "Das Bahia Azul Strandresort liegt an einem ruhigen Abschnitt der Bucht von Palma und verbindet direkten Strandzugang mit hellen, modernen Zimmern und einem Dachpool mit Meerblick.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Der Check-in ist ab 15:00 Uhr und der Check-out bis 11:00 Uhr moeglich. Haustiere sind nicht gestattet. Ruhezeiten gelten zwischen 23:00 und 08:00 Uhr.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "GuestRating": {
      "ReviewScore": 93,
      "SubScores": {
        "Cleanliness": 96,
        "Facilities": 93,
        "Food": 91,
        "Location": 91,
        "Rooms": 95,
        "Service": 96,
        "Value": 90
      },
      "Texts": {
        "en-US": {
          "Summary": "Guests consistently describe their stay as a peaceful, relaxing retreat highlighted by exceptionally friendly and attentive staff. Rooms and grounds are praised for being spotless and comfortable, while the delicious breakfast and calm adults-only setting make it an ideal getaway.",
          "Pros": [
            "Warm, attentive, and professional staff",
            "Spotless rooms and well-kept grounds",
            "Peaceful, child-free atmosphere",
            "Superb and varied breakfast spread",
            "Modern, spacious guest rooms"
          ],
          "Cons": [
            "Extra charges for some premium drinks and minibar",
            "Lunch and dinner buffets can feel repetitive to some"
          ],
          "GeneratedAt": "2026-11-05T18:10:57Z",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "RenderLayouts": {
      "Summary": "prose",
      "HouseRules": "highlights"
    },
    "Images": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "URL": "https://cdn.ygo.ai/hotels/bahia-azul/exterior-pool.jpg",
        "Source": "photo",
        "Category": "exterior",
        "Features": [
          "pool",
          "sea_view"
        ],
        "Mood": [
          "relaxing"
        ],
        "Tags": [
          "rooftop",
          "sunset"
        ],
        "AppealScore": 88,
        "QualityScore": 91,
        "AppealScoreVersion": "app-v4",
        "QualityScoreVersion": "qs-v4",
        "Width": 1600,
        "Height": 1067,
        "Format": "jpeg",
        "FileSize": 412000,
        "DominantColor": "#2E6F95",
        "BlurHash": "LKO2?U%2Tw=w]~RBVZRi};RPxuwH",
        "FileMetadata": {
          "CaptureDate": "2012-06-14",
          "Copyright": "© 2012 Hotel Sol S.A."
        },
        "Descriptions": {
          "en-US": "Rooftop infinity pool overlooking the Bay of Palma at sunset."
        },
        "Compliance": {
          "AIGenerated": true
        },
        "Presence": [
          {
            "Label": "person",
            "Confidence": 0.91
          },
          {
            "Label": "adult",
            "Confidence": 0.86
          }
        ],
        "Safety": {
          "Inappropriate": 0.02,
          "OffTopic": null
        },
        "TextDetections": [
          {
            "Content": "POOL BAR",
            "Label": "signage",
            "Confidence": 0.74
          }
        ],
        "FeatureDetections": [
          {
            "Label": "pool",
            "Confidence": 0.96
          },
          {
            "Label": "sea_view",
            "Confidence": 0.9
          }
        ]
      }
    ],
    "Rooms": [
      {
        "ID": "0192fb30-2bb3-7abc-8def-99887766aabb",
        "Name": {
          "en-US": "Double Room Sea View",
          "de-DE": "Doppelzimmer mit Meerblick"
        },
        "SizeSqm": 26,
        "Beddings": [
          [
            {
              "Type": "DOUBLE",
              "Quantity": 1,
              "Name": {
                "en-US": "double bed",
                "de-DE": "Doppelbett"
              }
            }
          ],
          [
            {
              "Type": "TWIN",
              "Quantity": 2,
              "Name": {
                "en-US": "twin beds",
                "de-DE": "Einzelbetten"
              }
            }
          ]
        ],
        "FactualAttributes": [
          {
            "Key": "air_conditioning",
            "Type": "factual",
            "Name": {
              "en-US": "Air Conditioning",
              "de-DE": "Klimaanlage"
            },
            "Value": "true",
            "ValueType": "boolean",
            "ParentKey": "room_facilities",
            "IsFree": true,
            "GTCodes": [
              "GT05-AICO",
              "AT05-FRCH"
            ]
          }
        ],
        "GeneratedTexts": {
          "en-US": {
            "RoomDescription": {
              "Text": "A bright 26 sqm room with a private balcony framing the bay, a king-size bed and a walk-in rain shower.",
              "Compliance": {
                "AIGenerated": true
              }
            }
          }
        },
        "RenderLayouts": {
          "": "roomcards"
        },
        "ExternalRoomIDs": {
          "ProductRoomIDs": [
            "11824",
            "11902"
          ]
        },
        "Images": [
          {
            "ID": "0192fb31-3cc4-7abc-8def-aabbccddeeff",
            "URL": "https://cdn.ygo.ai/hotels/bahia-azul/room-seaview.jpg",
            "Category": "room",
            "Features": [
              "balcony",
              "sea_view"
            ],
            "Mood": [
              "bright"
            ],
            "Tags": [
              "king_bed"
            ],
            "AppealScore": 80,
            "QualityScore": 84,
            "AppealScoreVersion": "app-v4",
            "QualityScoreVersion": "qs-v4",
            "Width": 1500,
            "Height": 1000,
            "Format": "jpeg",
            "FileSize": 356000,
            "DominantColor": "#D9E2EC",
            "BlurHash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
            "Descriptions": {
              "en-US": "Sea-view double room with a private balcony."
            },
            "Compliance": {
              "AIGenerated": true
            }
          }
        ],
        "Status": "active",
        "CreatedAt": "2026-03-01T08:00:00Z",
        "UpdatedAt": "2026-04-10T12:30:00Z"
      }
    ],
    "Tags": [
      {
        "ID": "0192fc01-1111-7abc-8def-aaaaaaaaaaaa",
        "Name": "Summer Campaign",
        "Description": "Hotels in the 2026 summer campaign"
      }
    ],
    "Status": "active",
    "TextStatus": "generated",
    "CreatedAt": "2026-03-01T08:00:00Z",
    "UpdatedAt": "2026-04-12T09:15:00Z"
  }
}
Example response: A fully enriched Mallorca-style hotel
{
  "Data": {
    "ID": "0192fb17-5dc6-7abc-8def-123456789abc",
    "Name": "Bahia Azul Beach Resort",
    "Names": {
      "en-US": "Bahia Azul Beach Resort",
      "de-DE": "Bahia Azul Strandresort"
    },
    "ExternalHotelIDs": {
      "ProductID": "HTL-MAJ-4711",
      "Giata": "668370",
      "PeakworkGoalID": "864521"
    },
    "GlobalHotelID": "ES-MALLR-K7MP2",
    "Stars": 4.5,
    "StarsMap": {
      "default": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      },
      "project": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      }
    },
    "AccommodationType": "resort",
    "Chain": "Meliá Hotels International",
    "Brand": "Sol by Meliá",
    "Location": {
      "Latitude": 39.5696,
      "Longitude": 2.6502,
      "CountryCode": "ES",
      "Address": {
        "Street": "Carrer de la Mar 12",
        "City": "Palma",
        "CityNames": {
          "en-US": "Palma",
          "de-DE": "Palma"
        },
        "State": "Illes Balears",
        "PostalCode": "07015",
        "Phone": "+34 971 000 000",
        "Email": "info@bahia-azul.example"
      }
    },
    "FactualAttributes": [
      {
        "Key": "wifi",
        "Type": "factual",
        "Name": {
          "en-US": "Free WiFi",
          "de-DE": "Kostenloses WLAN"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": true,
        "GTCodes": [
          "GT03-INTE",
          "AT03-FRCH"
        ]
      },
      {
        "Key": "parking",
        "Type": "factual",
        "Name": {
          "en-US": "Parking",
          "de-DE": "Parkplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": false,
        "GTCodes": [
          "GT03-CAPA",
          "AT03-EXCO"
        ]
      },
      {
        "Key": "golf_course",
        "Type": "factual",
        "Name": {
          "en-US": "Golf course",
          "de-DE": "Golfplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "leisure_and_wellness",
        "IsFree": null,
        "GTCodes": [
          "GT03-GOLF"
        ],
        "IsOnSite": false
      },
      {
        "Key": "restaurant",
        "Type": "factual",
        "Name": {
          "en-US": "Restaurants",
          "de-DE": "Restaurants"
        },
        "ValueType": "group",
        "ParentKey": "food_and_drink",
        "IsFree": null,
        "GTCodes": [
          "GT03-REST"
        ],
        "Instances": [
          {
            "Name": "La Marea",
            "Details": {
              "description": "Mediterranean a la carte restaurant with sea views.",
              "hours": "19:00-23:00"
            }
          },
          {
            "Name": "Buffet Central",
            "Details": {
              "description": "Main buffet restaurant serving breakfast, lunch and dinner."
            }
          }
        ]
      }
    ],
    "POIs": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-3344556677cc",
        "Name": {
          "en-US": "Es Portitxol",
          "de-DE": "Es Portitxol"
        },
        "Type": "attraction",
        "IsArea": true,
        "InArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-2233445566bb",
        "Name": {
          "en-US": "Can Pere Antoni Beach",
          "de-DE": "Strand Can Pere Antoni"
        },
        "Type": "beach",
        "Distance": 250,
        "Unit": "m"
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-4455667788dd",
        "Name": {
          "en-US": "Palma Old Town",
          "de-DE": "Altstadt von Palma"
        },
        "Type": "attraction",
        "Distance": 2.4,
        "Unit": "km",
        "IsArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "Name": {
          "en-US": "Palma Cathedral",
          "de-DE": "Kathedrale von Palma"
        },
        "Type": "landmark",
        "Distance": 3.2,
        "Unit": "km",
        "Latitude": 39.5675,
        "Longitude": 2.6484
      }
    ],
    "CheckIn": {
      "From": "15:00"
    },
    "CheckOut": {
      "Until": "11:00"
    },
    "GeneratedTexts": {
      "en-US": {
        "Summary": {
          "Text": "Set on a quiet stretch of the Bay of Palma, Bahia Azul Beach Resort pairs direct beach access with bright, contemporary rooms and a sea-view rooftop pool.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Check-in is from 15:00 and check-out is until 11:00. Pets are not permitted. Quiet hours apply between 23:00 and 08:00.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      },
      "de-DE": {
        "Summary": {
          "Text": "Das Bahia Azul Strandresort liegt an einem ruhigen Abschnitt der Bucht von Palma und verbindet direkten Strandzugang mit hellen, modernen Zimmern und einem Dachpool mit Meerblick.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Der Check-in ist ab 15:00 Uhr und der Check-out bis 11:00 Uhr moeglich. Haustiere sind nicht gestattet. Ruhezeiten gelten zwischen 23:00 und 08:00 Uhr.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "GuestRating": {
      "ReviewScore": 93,
      "SubScores": {
        "Cleanliness": 96,
        "Facilities": 93,
        "Food": 91,
        "Location": 91,
        "Rooms": 95,
        "Service": 96,
        "Value": 90
      },
      "Texts": {
        "en-US": {
          "Summary": "Guests consistently describe their stay as a peaceful, relaxing retreat highlighted by exceptionally friendly and attentive staff. Rooms and grounds are praised for being spotless and comfortable, while the delicious breakfast and calm adults-only setting make it an ideal getaway.",
          "Pros": [
            "Warm, attentive, and professional staff",
            "Spotless rooms and well-kept grounds",
            "Peaceful, child-free atmosphere",
            "Superb and varied breakfast spread",
            "Modern, spacious guest rooms"
          ],
          "Cons": [
            "Extra charges for some premium drinks and minibar",
            "Lunch and dinner buffets can feel repetitive to some"
          ],
          "GeneratedAt": "2026-11-05T18:10:57Z",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "RenderLayouts": {
      "Summary": "prose",
      "HouseRules": "highlights"
    },
    "Images": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "URL": "https://cdn.ygo.ai/hotels/bahia-azul/exterior-pool.jpg",
        "Source": "photo",
        "Category": "exterior",
        "Features": [
          "pool",
          "sea_view"
        ],
        "Mood": [
          "relaxing"
        ],
        "Tags": [
          "rooftop",
          "sunset"
        ],
        "AppealScore": 88,
        "QualityScore": 91,
        "AppealScoreVersion": "app-v4",
        "QualityScoreVersion": "qs-v4",
        "Width": 1600,
        "Height": 1067,
        "Format": "jpeg",
        "FileSize": 412000,
        "DominantColor": "#2E6F95",
        "BlurHash": "LKO2?U%2Tw=w]~RBVZRi};RPxuwH",
        "FileMetadata": {
          "CaptureDate": "2012-06-14",
          "Copyright": "© 2012 Hotel Sol S.A."
        },
        "Descriptions": {
          "en-US": "Rooftop infinity pool overlooking the Bay of Palma at sunset."
        },
        "Compliance": {
          "AIGenerated": true
        },
        "Presence": [
          {
            "Label": "person",
            "Confidence": 0.91
          },
          {
            "Label": "adult",
            "Confidence": 0.86
          }
        ],
        "Safety": {
          "Inappropriate": 0.02,
          "OffTopic": null
        },
        "TextDetections": [
          {
            "Content": "POOL BAR",
            "Label": "signage",
            "Confidence": 0.74
          }
        ],
        "FeatureDetections": [
          {
            "Label": "pool",
            "Confidence": 0.96
          },
          {
            "Label": "sea_view",
            "Confidence": 0.9
          }
        ]
      }
    ],
    "Rooms": [
      {
        "ID": "0192fb30-2bb3-7abc-8def-99887766aabb",
        "Name": {
          "en-US": "Double Room Sea View",
          "de-DE": "Doppelzimmer mit Meerblick"
        },
        "SizeSqm": 26,
        "Beddings": [
          [
            {
              "Type": "DOUBLE",
              "Quantity": 1,
              "Name": {
                "en-US": "double bed",
                "de-DE": "Doppelbett"
              }
            }
          ],
          [
            {
              "Type": "TWIN",
              "Quantity": 2,
              "Name": {
                "en-US": "twin beds",
                "de-DE": "Einzelbetten"
              }
            }
          ]
        ],
        "FactualAttributes": [
          {
            "Key": "air_conditioning",
            "Type": "factual",
            "Name": {
              "en-US": "Air Conditioning",
              "de-DE": "Klimaanlage"
            },
            "Value": "true",
            "ValueType": "boolean",
            "ParentKey": "room_facilities",
            "IsFree": true,
            "GTCodes": [
              "GT05-AICO",
              "AT05-FRCH"
            ]
          }
        ],
        "GeneratedTexts": {
          "en-US": {
            "RoomDescription": {
              "Text": "A bright 26 sqm room with a private balcony framing the bay, a king-size bed and a walk-in rain shower.",
              "Compliance": {
                "AIGenerated": true
              }
            }
          }
        },
        "RenderLayouts": {
          "": "roomcards"
        },
        "ExternalRoomIDs": {
          "ProductRoomIDs": [
            "11824",
            "11902"
          ]
        },
        "Images": [
          {
            "ID": "0192fb31-3cc4-7abc-8def-aabbccddeeff",
            "URL": "https://cdn.ygo.ai/hotels/bahia-azul/room-seaview.jpg",
            "Category": "room",
            "Features": [
              "balcony",
              "sea_view"
            ],
            "Mood": [
              "bright"
            ],
            "Tags": [
              "king_bed"
            ],
            "AppealScore": 80,
            "QualityScore": 84,
            "AppealScoreVersion": "app-v4",
            "QualityScoreVersion": "qs-v4",
            "Width": 1500,
            "Height": 1000,
            "Format": "jpeg",
            "FileSize": 356000,
            "DominantColor": "#D9E2EC",
            "BlurHash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
            "Descriptions": {
              "en-US": "Sea-view double room with a private balcony."
            },
            "Compliance": {
              "AIGenerated": true
            }
          }
        ],
        "Status": "active",
        "CreatedAt": "2026-03-01T08:00:00Z",
        "UpdatedAt": "2026-04-10T12:30:00Z"
      }
    ],
    "Tags": [
      {
        "ID": "0192fc01-1111-7abc-8def-aaaaaaaaaaaa",
        "Name": "Summer Campaign",
        "Description": "Hotels in the 2026 summer campaign"
      }
    ],
    "Status": "active",
    "TextStatus": "generated",
    "CreatedAt": "2026-03-01T08:00:00Z",
    "UpdatedAt": "2026-04-12T09:15:00Z"
  }
}
Example response: A fully enriched Mallorca-style hotel
{
  "Data": {
    "ID": "0192fb17-5dc6-7abc-8def-123456789abc",
    "Name": "Bahia Azul Beach Resort",
    "Names": {
      "en-US": "Bahia Azul Beach Resort",
      "de-DE": "Bahia Azul Strandresort"
    },
    "ExternalHotelIDs": {
      "ProductID": "HTL-MAJ-4711",
      "Giata": "668370",
      "PeakworkGoalID": "864521"
    },
    "GlobalHotelID": "ES-MALLR-K7MP2",
    "Stars": 4.5,
    "StarsMap": {
      "default": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      },
      "project": {
        "Stars": 4.5,
        "Superior": false,
        "Garni": false
      }
    },
    "AccommodationType": "resort",
    "Chain": "Meliá Hotels International",
    "Brand": "Sol by Meliá",
    "Location": {
      "Latitude": 39.5696,
      "Longitude": 2.6502,
      "CountryCode": "ES",
      "Address": {
        "Street": "Carrer de la Mar 12",
        "City": "Palma",
        "CityNames": {
          "en-US": "Palma",
          "de-DE": "Palma"
        },
        "State": "Illes Balears",
        "PostalCode": "07015",
        "Phone": "+34 971 000 000",
        "Email": "info@bahia-azul.example"
      }
    },
    "FactualAttributes": [
      {
        "Key": "wifi",
        "Type": "factual",
        "Name": {
          "en-US": "Free WiFi",
          "de-DE": "Kostenloses WLAN"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": true,
        "GTCodes": [
          "GT03-INTE",
          "AT03-FRCH"
        ]
      },
      {
        "Key": "parking",
        "Type": "factual",
        "Name": {
          "en-US": "Parking",
          "de-DE": "Parkplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "facilities_and_services",
        "IsFree": false,
        "GTCodes": [
          "GT03-CAPA",
          "AT03-EXCO"
        ]
      },
      {
        "Key": "golf_course",
        "Type": "factual",
        "Name": {
          "en-US": "Golf course",
          "de-DE": "Golfplatz"
        },
        "Value": "true",
        "ValueType": "boolean",
        "ParentKey": "leisure_and_wellness",
        "IsFree": null,
        "GTCodes": [
          "GT03-GOLF"
        ],
        "IsOnSite": false
      },
      {
        "Key": "restaurant",
        "Type": "factual",
        "Name": {
          "en-US": "Restaurants",
          "de-DE": "Restaurants"
        },
        "ValueType": "group",
        "ParentKey": "food_and_drink",
        "IsFree": null,
        "GTCodes": [
          "GT03-REST"
        ],
        "Instances": [
          {
            "Name": "La Marea",
            "Details": {
              "description": "Mediterranean a la carte restaurant with sea views.",
              "hours": "19:00-23:00"
            }
          },
          {
            "Name": "Buffet Central",
            "Details": {
              "description": "Main buffet restaurant serving breakfast, lunch and dinner."
            }
          }
        ]
      }
    ],
    "POIs": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-3344556677cc",
        "Name": {
          "en-US": "Es Portitxol",
          "de-DE": "Es Portitxol"
        },
        "Type": "attraction",
        "IsArea": true,
        "InArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-2233445566bb",
        "Name": {
          "en-US": "Can Pere Antoni Beach",
          "de-DE": "Strand Can Pere Antoni"
        },
        "Type": "beach",
        "Distance": 250,
        "Unit": "m"
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-4455667788dd",
        "Name": {
          "en-US": "Palma Old Town",
          "de-DE": "Altstadt von Palma"
        },
        "Type": "attraction",
        "Distance": 2.4,
        "Unit": "km",
        "IsArea": true
      },
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "Name": {
          "en-US": "Palma Cathedral",
          "de-DE": "Kathedrale von Palma"
        },
        "Type": "landmark",
        "Distance": 3.2,
        "Unit": "km",
        "Latitude": 39.5675,
        "Longitude": 2.6484
      }
    ],
    "CheckIn": {
      "From": "15:00"
    },
    "CheckOut": {
      "Until": "11:00"
    },
    "GeneratedTexts": {
      "en-US": {
        "Summary": {
          "Text": "Set on a quiet stretch of the Bay of Palma, Bahia Azul Beach Resort pairs direct beach access with bright, contemporary rooms and a sea-view rooftop pool.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Check-in is from 15:00 and check-out is until 11:00. Pets are not permitted. Quiet hours apply between 23:00 and 08:00.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      },
      "de-DE": {
        "Summary": {
          "Text": "Das Bahia Azul Strandresort liegt an einem ruhigen Abschnitt der Bucht von Palma und verbindet direkten Strandzugang mit hellen, modernen Zimmern und einem Dachpool mit Meerblick.",
          "Compliance": {
            "AIGenerated": true
          }
        },
        "HouseRules": {
          "Text": "Der Check-in ist ab 15:00 Uhr und der Check-out bis 11:00 Uhr moeglich. Haustiere sind nicht gestattet. Ruhezeiten gelten zwischen 23:00 und 08:00 Uhr.",
          "GeneratedAt": "2026-04-12T09:15:00Z",
          "TextType": "rules",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "GuestRating": {
      "ReviewScore": 93,
      "SubScores": {
        "Cleanliness": 96,
        "Facilities": 93,
        "Food": 91,
        "Location": 91,
        "Rooms": 95,
        "Service": 96,
        "Value": 90
      },
      "Texts": {
        "en-US": {
          "Summary": "Guests consistently describe their stay as a peaceful, relaxing retreat highlighted by exceptionally friendly and attentive staff. Rooms and grounds are praised for being spotless and comfortable, while the delicious breakfast and calm adults-only setting make it an ideal getaway.",
          "Pros": [
            "Warm, attentive, and professional staff",
            "Spotless rooms and well-kept grounds",
            "Peaceful, child-free atmosphere",
            "Superb and varied breakfast spread",
            "Modern, spacious guest rooms"
          ],
          "Cons": [
            "Extra charges for some premium drinks and minibar",
            "Lunch and dinner buffets can feel repetitive to some"
          ],
          "GeneratedAt": "2026-11-05T18:10:57Z",
          "Compliance": {
            "AIGenerated": true
          }
        }
      }
    },
    "RenderLayouts": {
      "Summary": "prose",
      "HouseRules": "highlights"
    },
    "Images": [
      {
        "ID": "0192fb20-1aa2-7def-9abc-1122334455aa",
        "URL": "https://cdn.ygo.ai/hotels/bahia-azul/exterior-pool.jpg",
        "Source": "photo",
        "Category": "exterior",
        "Features": [
          "pool",
          "sea_view"
        ],
        "Mood": [
          "relaxing"
        ],
        "Tags": [
          "rooftop",
          "sunset"
        ],
        "AppealScore": 88,
        "QualityScore": 91,
        "AppealScoreVersion": "app-v4",
        "QualityScoreVersion": "qs-v4",
        "Width": 1600,
        "Height": 1067,
        "Format": "jpeg",
        "FileSize": 412000,
        "DominantColor": "#2E6F95",
        "BlurHash": "LKO2?U%2Tw=w]~RBVZRi};RPxuwH",
        "FileMetadata": {
          "CaptureDate": "2012-06-14",
          "Copyright": "© 2012 Hotel Sol S.A."
        },
        "Descriptions": {
          "en-US": "Rooftop infinity pool overlooking the Bay of Palma at sunset."
        },
        "Compliance": {
          "AIGenerated": true
        },
        "Presence": [
          {
            "Label": "person",
            "Confidence": 0.91
          },
          {
            "Label": "adult",
            "Confidence": 0.86
          }
        ],
        "Safety": {
          "Inappropriate": 0.02,
          "OffTopic": null
        },
        "TextDetections": [
          {
            "Content": "POOL BAR",
            "Label": "signage",
            "Confidence": 0.74
          }
        ],
        "FeatureDetections": [
          {
            "Label": "pool",
            "Confidence": 0.96
          },
          {
            "Label": "sea_view",
            "Confidence": 0.9
          }
        ]
      }
    ],
    "Rooms": [
      {
        "ID": "0192fb30-2bb3-7abc-8def-99887766aabb",
        "Name": {
          "en-US": "Double Room Sea View",
          "de-DE": "Doppelzimmer mit Meerblick"
        },
        "SizeSqm": 26,
        "Beddings": [
          [
            {
              "Type": "DOUBLE",
              "Quantity": 1,
              "Name": {
                "en-US": "double bed",
                "de-DE": "Doppelbett"
              }
            }
          ],
          [
            {
              "Type": "TWIN",
              "Quantity": 2,
              "Name": {
                "en-US": "twin beds",
                "de-DE": "Einzelbetten"
              }
            }
          ]
        ],
        "FactualAttributes": [
          {
            "Key": "air_conditioning",
            "Type": "factual",
            "Name": {
              "en-US": "Air Conditioning",
              "de-DE": "Klimaanlage"
            },
            "Value": "true",
            "ValueType": "boolean",
            "ParentKey": "room_facilities",
            "IsFree": true,
            "GTCodes": [
              "GT05-AICO",
              "AT05-FRCH"
            ]
          }
        ],
        "GeneratedTexts": {
          "en-US": {
            "RoomDescription": {
              "Text": "A bright 26 sqm room with a private balcony framing the bay, a king-size bed and a walk-in rain shower.",
              "Compliance": {
                "AIGenerated": true
              }
            }
          }
        },
        "RenderLayouts": {
          "": "roomcards"
        },
        "ExternalRoomIDs": {
          "ProductRoomIDs": [
            "11824",
            "11902"
          ]
        },
        "Images": [
          {
            "ID": "0192fb31-3cc4-7abc-8def-aabbccddeeff",
            "URL": "https://cdn.ygo.ai/hotels/bahia-azul/room-seaview.jpg",
            "Category": "room",
            "Features": [
              "balcony",
              "sea_view"
            ],
            "Mood": [
              "bright"
            ],
            "Tags": [
              "king_bed"
            ],
            "AppealScore": 80,
            "QualityScore": 84,
            "AppealScoreVersion": "app-v4",
            "QualityScoreVersion": "qs-v4",
            "Width": 1500,
            "Height": 1000,
            "Format": "jpeg",
            "FileSize": 356000,
            "DominantColor": "#D9E2EC",
            "BlurHash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
            "Descriptions": {
              "en-US": "Sea-view double room with a private balcony."
            },
            "Compliance": {
              "AIGenerated": true
            }
          }
        ],
        "Status": "active",
        "CreatedAt": "2026-03-01T08:00:00Z",
        "UpdatedAt": "2026-04-10T12:30:00Z"
      }
    ],
    "Tags": [
      {
        "ID": "0192fc01-1111-7abc-8def-aaaaaaaaaaaa",
        "Name": "Summer Campaign",
        "Description": "Hotels in the 2026 summer campaign"
      }
    ],
    "Status": "active",
    "TextStatus": "generated",
    "CreatedAt": "2026-03-01T08:00:00Z",
    "UpdatedAt": "2026-04-12T09:15:00Z"
  }
}
400 Bad Request

Bad Request: the request body failed validation.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Request validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Name of the field that failed validation.

        Example
        HotelID
      • Message string required

        Human-readable validation error message for this field.

        Example
        Provide exactly one of HotelID, GlobalHotelID, or ExternalHotelID
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        REQUIRED
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values; keys are PascalCase and depend on Code. Optional.

        Example
        {
          "Max": 100
        }
Example response: No selector provided
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Validation failed",
    "Fields": [
      {
        "Field": "HotelID",
        "Message": "Provide exactly one of HotelID, GlobalHotelID, or ExternalHotelID"
      }
    ]
  }
}
Example response: More than one selector provided
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Validation failed",
    "Fields": [
      {
        "Field": "HotelID",
        "Message": "Provide exactly one of HotelID, GlobalHotelID, or ExternalHotelID (multiple were provided)"
      }
    ]
  }
}
Example response: Unsupported ExternalHotelID sub-key
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Validation failed",
    "Fields": [
      {
        "Field": "ExternalHotelID",
        "Message": "Unsupported ExternalHotelID key: hrs"
      }
    ]
  }
}
Example response: ExternalHotelID has no supported sub-key
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Validation failed",
    "Fields": [
      {
        "Field": "ExternalHotelID",
        "Message": "ExternalHotelID must contain at least one supported sub-key"
      }
    ]
  }
}
Example response: giata is not a positive number
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Validation failed",
    "Fields": [
      {
        "Field": "ExternalHotelID",
        "Message": "ExternalHotelID.giata must be a positive number"
      }
    ]
  }
}
Example response: peakworkgoalid is not a positive number
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Validation failed",
    "Fields": [
      {
        "Field": "ExternalHotelID",
        "Message": "ExternalHotelID.peakworkgoalid must be a positive number"
      }
    ]
  }
}
Example response: HotelID is not a valid UUID
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Invalid HotelID format"
  }
}
Example response: Malformed request body
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Invalid request body"
  }
}
401 Unauthorized

Unauthorized: the API key is missing or invalid.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Request validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Name of the field that failed validation.

        Example
        HotelID
      • Message string required

        Human-readable validation error message for this field.

        Example
        Provide exactly one of HotelID, GlobalHotelID, or ExternalHotelID
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        REQUIRED
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values; keys are PascalCase and depend on Code. Optional.

        Example
        {
          "Max": 100
        }
Example response: Invalid API key
{
  "Error": {
    "Code": "UNAUTHORIZED",
    "Message": "Invalid API key"
  }
}
403 Forbidden

Forbidden: the API key may not act on this project, or does not carry the content.catalog:read permission this endpoint requires (INSUFFICIENT_SCOPE).

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Request validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Name of the field that failed validation.

        Example
        HotelID
      • Message string required

        Human-readable validation error message for this field.

        Example
        Provide exactly one of HotelID, GlobalHotelID, or ExternalHotelID
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        REQUIRED
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values; keys are PascalCase and depend on Code. Optional.

        Example
        {
          "Max": 100
        }
Example response: Missing required scope
{
  "Error": {
    "Code": "INSUFFICIENT_SCOPE",
    "Message": "token lacks scope content.catalog:read"
  }
}
Example response: Project access required
{
  "Error": {
    "Code": "FORBIDDEN",
    "Message": "Project access required"
  }
}
404 Not Found

Not Found: the hotel does not exist or is not in your project's scope.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Request validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Name of the field that failed validation.

        Example
        HotelID
      • Message string required

        Human-readable validation error message for this field.

        Example
        Provide exactly one of HotelID, GlobalHotelID, or ExternalHotelID
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        REQUIRED
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values; keys are PascalCase and depend on Code. Optional.

        Example
        {
          "Max": 100
        }
Example response: Hotel not found
{
  "Error": {
    "Code": "NOT_FOUND",
    "Message": "Hotel not found"
  }
}
429 Too Many Requests

Too Many Requests: the rate limit was exceeded. Retry-After carries the number of seconds to wait before retrying.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789
  • Retry-After integer

    Number of seconds to wait before retrying the request. Present on 429 responses.

    Example
    30
    Limits
    min 1

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Request validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Name of the field that failed validation.

        Example
        HotelID
      • Message string required

        Human-readable validation error message for this field.

        Example
        Provide exactly one of HotelID, GlobalHotelID, or ExternalHotelID
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        REQUIRED
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values; keys are PascalCase and depend on Code. Optional.

        Example
        {
          "Max": 100
        }
Example response: Limit exceeded
{
  "Error": {
    "Code": "RATE_LIMIT_EXCEEDED",
    "Message": "Rate limit exceeded. Retry after the number of seconds in the Retry-After header."
  }
}
500 Internal Server Error

Internal Server Error: unexpected server error. Quote the X-Trace-ID response header when contacting support.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Request validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Name of the field that failed validation.

        Example
        HotelID
      • Message string required

        Human-readable validation error message for this field.

        Example
        Provide exactly one of HotelID, GlobalHotelID, or ExternalHotelID
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        REQUIRED
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values; keys are PascalCase and depend on Code. Optional.

        Example
        {
          "Max": 100
        }
Example response: Internal server error
{
  "Error": {
    "Code": "INTERNAL_ERROR",
    "Message": "Failed to load hotel"
  }
}