1. Enrichment
YGO Client API
v2
  • v2
  • v1
  • Project API
    • Overview
    • Core Concepts
    • Authentication
    • Error Handling & Limits
    • Content Enrichment API
      • Text Generation
        • Generate text
        • Get text generation status
        • Preview text
      • Enrichment
        • Get enriched hotel
          POST
        • List enriched hotels
          POST
        • List enriched hotel summaries
          POST
      • Templates
        • Save text template
        • List text templates
      • Tags
        • Save tag
        • List tags
        • Delete tag
        • Add tag to hotels (bulk)
        • Remove tag from hotels (bulk)
      • Image Pins
        • Delete hotel image pin
        • Save hotel image pin
      • Settings
        • Get content settings
      • Approval Links
        • Create approval links (bulk)
        • Export approved hotel text with image URLs
        • List approval links
        • Revoke approval link
        • Rotate approval link
      • Vision AI
        • Ingest vision images
        • Get vision images
        • List vision images
    • Schemas
      • GetEnrichedHotelRequest
      • GenerateTextRequest
      • GetTextGenerationStatusRequest
      • PreviewTextRequest
      • GetEnrichedHotelsByTagRequest
      • ListEnrichedHotelsRequest
      • GetContentSettingsRequest
      • ListTextTemplatesRequest
      • SaveTextTemplateRequest
      • generateText_GenerateTextRequest
      • createApprovalLinks_CreateApprovalLinksRequest
      • GetEnrichedHotelResponse
      • GenerateTextResponse
      • GetTextGenerationStatusResponse
      • PreviewTextResponse
      • GetEnrichedHotelsByTagResponse
      • ListEnrichedHotelsResponse
      • GetContentSettingsResponse
      • ListTextTemplatesResponse
      • SaveTextTemplateResponse
      • generateText_GenerateTextResponse
      • createApprovalLinks_CreateApprovalLinksResponse
      • TextGenerationRun
      • TextGenerationStatus
      • PreviewResult
      • EnrichedHotelsByTag
      • Pagination
      • ContentSettings
      • TextTemplate
      • generateText_TextGenerationRun
      • createApprovalLinks_ApprovalLink
      • ErrorResponse
      • RunProgress
      • PreviewHotel
      • TagSummary
      • EnrichedHotelListItem
      • generateText_RunProgress
      • createApprovalLinks_ApprovalApprover
      • EnrichedHotel
      • ErrorDetail
      • PreviewCell
      • TemplateUsageStats
      • generateText_ErrorResponse
      • createApprovalLinks_ErrorResponse
      • Location
      • FieldError
      • PreviewChange
      • generateText_ErrorDetail
      • createApprovalLinks_ErrorDetail
      • Address
      • createApprovalLinks_FieldError
      • FactualAttribute
      • getTextGenerationStatus_GetTextGenerationStatusRequest
      • exportApprovedHotelText_ExportApprovedHotelTextRequest
      • FactualInstance
      • getTextGenerationStatus_GetTextGenerationStatusResponse
      • exportApprovedHotelText_ApprovedHotelTextFile
      • POI
      • getTextGenerationStatus_TextGenerationStatus
      • exportApprovedHotelText_ErrorResponse
      • CheckIn
      • getTextGenerationStatus_RunProgress
      • exportApprovedHotelText_ErrorDetail
      • CheckOut
      • getTextGenerationStatus_ErrorResponse
      • exportApprovedHotelText_FieldError
      • GeneratedTexts
      • getTextGenerationStatus_ErrorDetail
      • listApprovals_ListApprovalsRequest
      • GeneratedTextDetail
      • listApprovals_ListApprovalsResponse
      • Image
      • previewText_PreviewTextRequest
      • listApprovals_Pagination
      • EnrichedRoom
      • previewText_PreviewTextResponse
      • listApprovals_ApprovalLink
      • Bedding
      • previewText_PreviewResult
      • listApprovals_ApprovalApprover
      • previewText_PreviewHotel
      • listApprovals_ErrorResponse
      • previewText_PreviewText
      • listApprovals_ErrorDetail
      • previewText_PreviewChange
      • listApprovals_FieldError
      • previewText_ErrorResponse
      • revokeApprovalLink_RevokeApprovalLinkRequest
      • previewText_ErrorDetail
      • revokeApprovalLink_RevokeApprovalLinkResponse
      • revokeApprovalLink_ApprovalLink
      • revokeApprovalLink_ApprovalApprover
      • getEnrichedHotel_GetEnrichedHotelResponse
      • revokeApprovalLink_ErrorResponse
      • revokeApprovalLink_ErrorDetail
      • getEnrichedHotel_ProjectTagSummary
      • revokeApprovalLink_FieldError
      • getEnrichedHotel_Location
      • rotateApprovalLink_RotateApprovalLinkRequest
      • rotateApprovalLink_RotateApprovalLinkResponse
      • rotateApprovalLink_ApprovalLink
      • rotateApprovalLink_ApprovalApprover
      • getEnrichedHotel_POI
      • rotateApprovalLink_ErrorResponse
      • getEnrichedHotel_CheckIn
      • rotateApprovalLink_ErrorDetail
      • getEnrichedHotel_CheckOut
      • rotateApprovalLink_FieldError
      • getEnrichedHotel_GeneratedTexts
      • getEnrichedHotel_GeneratedTextDetail
      • getEnrichedHotel_Compliance
      • getEnrichedHotel_ProviderVariant
      • generateText_FieldError
      • getEnrichedHotel_Bedding
      • getEnrichedHotel_ErrorResponse
      • getEnrichedHotel_ErrorDetail
      • listEnrichedHotelSummaries_ListEnrichedHotelSummariesRequest
      • listEnrichedHotels_EnrichedHotelListItem
      • listEnrichedHotelSummaries_ListEnrichedHotelSummariesResponse
      • listEnrichedHotelSummaries_Pagination
      • getTextGenerationStatus_FieldError
      • listEnrichedHotelSummaries_ErrorResponse
      • listEnrichedHotelSummaries_ErrorDetail
      • listEnrichedHotels_ListEnrichedHotelsResponse
      • listEnrichedHotels_Pagination
      • listEnrichedHotels_ProjectTagSummary
      • previewText_FieldError
      • listEnrichedHotels_Location
      • getEnrichedHotel_GetEnrichedHotelRequest
      • getEnrichedHotel_EnrichedHotel
      • listEnrichedHotels_POI
      • listEnrichedHotels_CheckIn
      • getEnrichedHotel_Address
      • listEnrichedHotels_CheckOut
      • listEnrichedHotels_GeneratedTexts
      • getEnrichedHotel_FactualAttribute
      • listEnrichedHotels_GeneratedTextDetail
      • getEnrichedHotel_FactualInstance
      • listEnrichedHotels_Compliance
      • listEnrichedHotels_ProviderVariant
      • listEnrichedHotels_Bedding
      • listEnrichedHotels_ErrorResponse
      • listEnrichedHotels_ErrorDetail
      • getEnrichedHotel_DetectionConfidence
      • getEnrichedHotel_PresenceDetection
      • deleteHotelImagePin_DeleteHotelImagePinRequest
      • getEnrichedHotel_TextDetection
      • deleteHotelImagePin_DeleteHotelImagePinResponse
      • getEnrichedHotel_FeatureDetection
      • getEnrichedHotel_Image
      • deleteHotelImagePin_ClearedHotelImagePin
      • getEnrichedHotel_EnrichedRoom
      • deleteHotelImagePin_ErrorResponse
      • deleteHotelImagePin_ErrorDetail
      • saveHotelImagePin_SaveHotelImagePinRequest
      • getEnrichedHotel_FieldError
      • saveHotelImagePin_SaveHotelImagePinResponse
      • saveHotelImagePin_HotelImagePin
      • saveHotelImagePin_ErrorResponse
      • saveHotelImagePin_ErrorDetail
      • listEnrichedHotelSummaries_EnrichedHotelSummary
      • getContentSettings_GetContentSettingsRequest
      • getContentSettings_GetContentSettingsResponse
      • getContentSettings_ContentSettings
      • listEnrichedHotelSummaries_FieldError
      • listEnrichedHotels_ListEnrichedHotelsRequest
      • getContentSettings_ErrorResponse
      • getContentSettings_ErrorDetail
      • listEnrichedHotels_EnrichedHotel
      • listImageProvidersProject_ListImageProvidersRequest
      • listImageProvidersProject_ListImageProvidersResponse
      • listImageProvidersProject_ImageProviderCatalog
      • listEnrichedHotels_Address
      • listImageProvidersProject_ImageProviderCatalogEntry
      • listEnrichedHotels_FactualAttribute
      • listImageProvidersProject_ErrorResponse
      • listEnrichedHotels_FactualInstance
      • listImageProvidersProject_ErrorDetail
      • addTagToHotels_AddTagToHotelsRequest
      • addTagToHotels_AddTagToHotelsResponse
      • addTagToHotels_BulkTagResult
      • addTagToHotels_BulkTagHotelResult
      • addTagToHotels_ErrorResponse
      • addTagToHotels_ErrorDetail
      • listEnrichedHotels_DetectionConfidence
      • listEnrichedHotels_PresenceDetection
      • deleteTag_DeleteTagRequest
      • listEnrichedHotels_TextDetection
      • deleteTag_DeleteTagResponse
      • listEnrichedHotels_FeatureDetection
      • listEnrichedHotels_Image
      • deleteTag_DeletedProjectTag
      • listEnrichedHotels_EnrichedRoom
      • deleteTag_ErrorResponse
      • deleteTag_ErrorDetail
      • listTags_ListTagsRequest
      • listEnrichedHotels_FieldError
      • listTags_ListTagsResponse
      • listTags_ProjectTag
      • listTags_ErrorResponse
      • listTags_ErrorDetail
      • removeTagFromHotels_RemoveTagFromHotelsRequest
      • removeTagFromHotels_RemoveTagFromHotelsResponse
      • deleteHotelImagePin_FieldError
      • removeTagFromHotels_BulkTagResult
      • removeTagFromHotels_BulkTagHotelResult
      • removeTagFromHotels_ErrorResponse
      • removeTagFromHotels_ErrorDetail
      • saveTag_SaveTagRequest
      • saveHotelImagePin_FieldError
      • saveTag_SaveTagResponse
      • saveTag_ProjectTag
      • saveTag_ErrorResponse
      • saveTag_ErrorDetail
      • getContentSettings_FieldError
      • listTextTemplates_ListTextTemplatesRequest
      • listTextTemplates_ListTextTemplatesResponse
      • listTextTemplates_Pagination
      • listTextTemplates_TextTemplate
      • listTextTemplates_TemplateUsageStats
      • listTextTemplates_ErrorResponse
      • listTextTemplates_ErrorDetail
      • listImageProvidersProject_FieldError
      • saveTextTemplate_SaveTextTemplateResponse
      • saveTextTemplate_TextTemplate
      • saveTextTemplate_ErrorResponse
      • saveTextTemplate_ErrorDetail
      • addTagToHotels_FieldError
      • deleteTag_FieldError
      • listTags_FieldError
      • removeTagFromHotels_FieldError
      • saveTag_FieldError
      • listTextTemplates_FieldError
      • saveTextTemplate_SaveTextTemplateRequest
      • saveTextTemplate_FieldError
      • getVisionImages_GetVisionImagesRequest
      • getVisionImages_GetVisionImagesResponse
      • getVisionImages_GetVisionImagesResult
      • getVisionImages_VisionImageState
      • getVisionImages_Image
      • getVisionImages_Compliance
      • getVisionImages_DetectionConfidence
      • getVisionImages_PresenceDetection
      • getVisionImages_TextDetection
      • getVisionImages_FeatureDetection
      • getVisionImages_ErrorResponse
      • getVisionImages_ErrorDetail
      • getVisionImages_FieldError
      • ingestVisionImages_IngestVisionImagesRequest
      • ingestVisionImages_VisionImageSubmission
      • ingestVisionImages_IngestVisionImagesResponse
      • ingestVisionImages_IngestVisionImagesResult
      • ingestVisionImages_IngestedImage
      • ingestVisionImages_ErrorResponse
      • ingestVisionImages_ErrorDetail
      • ingestVisionImages_FieldError
      • listVisionImages_ListVisionImagesRequest
      • listVisionImages_ListVisionImagesResponse
      • listVisionImages_Pagination
      • listVisionImages_ListVisionImage
      • listVisionImages_Image
      • listVisionImages_Compliance
      • listVisionImages_DetectionConfidence
      • listVisionImages_PresenceDetection
      • listVisionImages_TextDetection
      • listVisionImages_FeatureDetection
      • listVisionImages_ErrorResponse
      • listVisionImages_ErrorDetail
      • listVisionImages_FieldError
  1. Enrichment

Get enriched hotel

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 built and returned synchronously. Resolve the hotel with exactly one selector, and every selector 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 and giata; several are AND-combined, so the hotel must match every key.
No selector, more than one, an unsupported sub-key or a non-numeric giata returns 400.
The hotel must belong to your project; an unknown or out-of-scope hotel returns 404.
429 means the rate limit was hit; wait Retry-After seconds.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Enriched hotel retrieved successfully.
Headers

Bodyapplication/json

🟠400getEnrichedHotel_BadRequest
🟠401getEnrichedHotel_Unauthorized
🟠403getEnrichedHotel_Forbidden
🟠404getEnrichedHotel_NotFound
🟠429getEnrichedHotel_TooManyRequests
🔴500getEnrichedHotel_InternalServerError
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.ygo.ai/v2/project/content/getEnrichedHotel' \
--header 'X-Project-ID: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "HotelID": "0192fb17-5dc6-7abc-8def-123456789abc"
}'
Response Response Example
200 - 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": "IBS-MAJ-4711",
            "Giata": "668370"
        },
        "GlobalHotelID": "ES-MALLR-K7MP2",
        "Stars": 4,
        "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"
            }
        },
        "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": "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-1122334455aa",
                "Name": {
                    "en-US": "Palma Cathedral",
                    "de-DE": "Kathedrale von Palma"
                },
                "Type": "landmark",
                "Distance": 3.2,
                "Unit": "km"
            },
            {
                "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"
            }
        ],
        "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
                    }
                }
            }
        },
        "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,
                "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
                        }
                    ]
                ],
                "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,
                        "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"
            }
        ],
        "Status": "active",
        "CreatedAt": "2026-03-01T08:00:00Z",
        "UpdatedAt": "2026-04-12T09:15:00Z"
    }
}
Modified at 2026-09-14 07:24:05
Previous
Preview text
Next
List enriched hotels
Built with