1. Text Generation
YGO Client API
v2
  • v2
  • v1
  • Project API
    • Overview
    • Core Concepts
    • Authentication
    • Error Handling & Limits
    • Content Enrichment API
      • Text Generation
        • Generate text
          POST
        • Get text generation status
          POST
        • Preview text
          POST
      • Enrichment
        • Get enriched hotel
        • List enriched hotels
        • List enriched hotel summaries
      • Templates
        • Save text template
        • List text templates
      • Tags
        • Save tag
        • List tags
        • Delete tag
        • Add tag to hotels (bulk)
        • Remove tag from hotels (bulk)
      • Settings
        • Get content settings
        • List the selectable image-provider catalog
    • Schemas
      • GetEnrichedHotelRequest
      • GenerateTextRequest
      • GetTextGenerationStatusRequest
      • PreviewTextRequest
      • GetEnrichedHotelsByTagRequest
      • ListEnrichedHotelsRequest
      • GetContentSettingsRequest
      • ListTextTemplatesRequest
      • SaveTextTemplateRequest
      • generateText_GenerateTextRequest
      • GetEnrichedHotelResponse
      • GenerateTextResponse
      • GetTextGenerationStatusResponse
      • PreviewTextResponse
      • GetEnrichedHotelsByTagResponse
      • ListEnrichedHotelsResponse
      • GetContentSettingsResponse
      • ListTextTemplatesResponse
      • SaveTextTemplateResponse
      • generateText_GenerateTextResponse
      • TextGenerationRun
      • TextGenerationStatus
      • PreviewResult
      • EnrichedHotelsByTag
      • Pagination
      • ContentSettings
      • TextTemplate
      • generateText_TextGenerationRun
      • ErrorResponse
      • RunProgress
      • PreviewHotel
      • TagSummary
      • EnrichedHotelListItem
      • generateText_RunProgress
      • EnrichedHotel
      • ErrorDetail
      • PreviewCell
      • TemplateUsageStats
      • generateText_ErrorResponse
      • Location
      • FieldError
      • PreviewChange
      • generateText_ErrorDetail
      • Address
      • generateText_FieldError
      • FactualAttribute
      • getTextGenerationStatus_GetTextGenerationStatusRequest
      • FactualInstance
      • getTextGenerationStatus_GetTextGenerationStatusResponse
      • POI
      • getTextGenerationStatus_TextGenerationStatus
      • CheckIn
      • getTextGenerationStatus_RunProgress
      • CheckOut
      • getTextGenerationStatus_ErrorResponse
      • GeneratedTexts
      • getTextGenerationStatus_ErrorDetail
      • GeneratedTextDetail
      • getTextGenerationStatus_FieldError
      • Image
      • previewText_PreviewTextRequest
      • EnrichedRoom
      • previewText_PreviewTextResponse
      • Bedding
      • previewText_PreviewResult
      • previewText_PreviewHotel
      • previewText_PreviewText
      • previewText_PreviewChange
      • previewText_ErrorResponse
      • previewText_ErrorDetail
      • previewText_FieldError
      • getEnrichedHotel_GetEnrichedHotelRequest
      • getEnrichedHotel_GetEnrichedHotelResponse
      • getEnrichedHotel_EnrichedHotel
      • getEnrichedHotel_ProjectTagSummary
      • getEnrichedHotel_Location
      • getEnrichedHotel_Address
      • getEnrichedHotel_FactualAttribute
      • getEnrichedHotel_FactualInstance
      • getEnrichedHotel_POI
      • getEnrichedHotel_CheckIn
      • getEnrichedHotel_CheckOut
      • getEnrichedHotel_GeneratedTexts
      • getEnrichedHotel_GeneratedTextDetail
      • getEnrichedHotel_Image
      • getEnrichedHotel_EnrichedRoom
      • getEnrichedHotel_Bedding
      • getEnrichedHotel_ErrorResponse
      • getEnrichedHotel_ErrorDetail
      • getEnrichedHotel_FieldError
      • listEnrichedHotelSummaries_ListEnrichedHotelSummariesRequest
      • listEnrichedHotelSummaries_ListEnrichedHotelSummariesResponse
      • listEnrichedHotels_EnrichedHotelListItem
      • listEnrichedHotelSummaries_Pagination
      • listEnrichedHotelSummaries_EnrichedHotelSummary
      • listEnrichedHotelSummaries_ErrorResponse
      • listEnrichedHotelSummaries_ErrorDetail
      • listEnrichedHotelSummaries_FieldError
      • listEnrichedHotels_ListEnrichedHotelsRequest
      • listEnrichedHotels_ListEnrichedHotelsResponse
      • listEnrichedHotels_Pagination
      • listEnrichedHotels_EnrichedHotel
      • listEnrichedHotels_ProjectTagSummary
      • listEnrichedHotels_Location
      • listEnrichedHotels_Address
      • listEnrichedHotels_FactualAttribute
      • listEnrichedHotels_FactualInstance
      • listEnrichedHotels_POI
      • listEnrichedHotels_CheckIn
      • listEnrichedHotels_CheckOut
      • listEnrichedHotels_GeneratedTexts
      • listEnrichedHotels_GeneratedTextDetail
      • listEnrichedHotels_Image
      • listEnrichedHotels_EnrichedRoom
      • listEnrichedHotels_Bedding
      • listEnrichedHotels_ErrorResponse
      • listEnrichedHotels_ErrorDetail
      • listEnrichedHotels_FieldError
      • getContentSettings_GetContentSettingsRequest
      • getContentSettings_GetContentSettingsResponse
      • getContentSettings_ContentSettings
      • getContentSettings_ErrorResponse
      • getContentSettings_ErrorDetail
      • getContentSettings_FieldError
      • listImageProvidersProject_ListImageProvidersRequest
      • listImageProvidersProject_ListImageProvidersResponse
      • listImageProvidersProject_ImageProviderCatalog
      • listImageProvidersProject_ImageProviderCatalogEntry
      • listImageProvidersProject_ErrorResponse
      • listImageProvidersProject_ErrorDetail
      • listImageProvidersProject_FieldError
      • addTagToHotels_AddTagToHotelsRequest
      • addTagToHotels_AddTagToHotelsResponse
      • addTagToHotels_BulkTagResult
      • addTagToHotels_BulkTagHotelResult
      • addTagToHotels_ErrorResponse
      • addTagToHotels_ErrorDetail
      • addTagToHotels_FieldError
      • deleteTag_DeleteTagRequest
      • deleteTag_DeleteTagResponse
      • deleteTag_DeletedProjectTag
      • deleteTag_ErrorResponse
      • deleteTag_ErrorDetail
      • deleteTag_FieldError
      • listTags_ListTagsRequest
      • listTags_ListTagsResponse
      • listTags_ProjectTag
      • listTags_ErrorResponse
      • listTags_ErrorDetail
      • listTags_FieldError
      • removeTagFromHotels_RemoveTagFromHotelsRequest
      • removeTagFromHotels_RemoveTagFromHotelsResponse
      • removeTagFromHotels_BulkTagResult
      • removeTagFromHotels_BulkTagHotelResult
      • removeTagFromHotels_ErrorResponse
      • removeTagFromHotels_ErrorDetail
      • removeTagFromHotels_FieldError
      • saveTag_SaveTagRequest
      • saveTag_SaveTagResponse
      • saveTag_ProjectTag
      • saveTag_ErrorResponse
      • saveTag_ErrorDetail
      • saveTag_FieldError
      • listTextTemplates_ListTextTemplatesRequest
      • listTextTemplates_ListTextTemplatesResponse
      • listTextTemplates_Pagination
      • listTextTemplates_TextTemplate
      • listTextTemplates_TemplateUsageStats
      • listTextTemplates_ErrorResponse
      • listTextTemplates_ErrorDetail
      • listTextTemplates_FieldError
      • saveTextTemplate_SaveTextTemplateRequest
      • saveTextTemplate_SaveTextTemplateResponse
      • saveTextTemplate_TextTemplate
      • saveTextTemplate_ErrorResponse
      • saveTextTemplate_ErrorDetail
      • saveTextTemplate_FieldError
  1. Text Generation

Generate text

POST
/v2/project/content/generateText
Queue an asynchronous text-generation run for a selection of the project's hotels and return the created run object.
The run starts in the queued state and is processed in the background. Use the returned run ID with getTextGenerationStatus to poll its status and progress until it reaches complete or failed.
Hotels are selected by HotelIDs and/or TagIDs (combined and deduplicated, capped at 100), and every selected hotel must belong to the calling project. If a selected hotel already has a run in progress, the request is rejected with 409.

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
Text-generation run queued successfully. The run is processed asynchronously; poll getTextGenerationStatus with the returned run ID.
Headers

Bodyapplication/json

🟠400generateText_BadRequest
🟠401generateText_Unauthorized
🟠403generateText_Forbidden
🟠404generateText_NotFound
🟠409generateText_Conflict
🟠429generateText_TooManyRequests
🔴500generateText_InternalServerError
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.ygo.ai/v2/project/content/generateText' \
--header 'X-Project-ID: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "HotelIDs": [
        "0192fb17-5dc6-7abc-8def-123456789abc",
        "0192fb18-6ed7-7abc-8def-223456789abc"
    ]
}'
Response Response Example
200 - A freshly queued run for two hotels
{
    "Data": {
        "ID": "0192fb50-8bb2-7abc-8def-112233445566",
        "Status": "queued",
        "Progress": {
            "Total": 2,
            "Generated": 0,
            "Failed": 0,
            "Skipped": 0
        },
        "CreatedAt": "2026-06-26T09:15:00Z",
        "UpdatedAt": "2026-06-26T09:15:00Z"
    }
}
Modified at 2026-07-01 06:49:44
Previous
Content Enrichment API
Next
Get text generation status
Built with