List text templates

POST

/v2/project/content/listTextTemplates

Return the text templates configured for the calling project, ordered by template key.

Text templates control the generated texts produced during enrichment. Each template targets a hotel or a room and carries a default authoring instruction with optional per-locale overrides. Results can be filtered by lifecycle status and by target entity type, and are paginated.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Responses

🟢200

application/json

Text templates retrieved successfully.

Headers

Bodyapplication/json

🟠400listTextTemplates_BadRequest

🟠401listTextTemplates_Unauthorized

🟠403listTextTemplates_Forbidden

🟠404listTextTemplates_NotFound

🟠429listTextTemplates_TooManyRequests

🔴500listTextTemplates_InternalServerError

Request Example

Shell

JavaScript

Java

Swift

cURL

List all templates (default pagination)Active hotel templates only, with usage stats

curl --location 'https://api.ygo.ai/v2/project/content/listTextTemplates' \
--header 'X-Project-ID: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Limit": 50,
    "Offset": 0
}'

Response Example

200 - A project's hotel and room templates

{
    "Data": [
        {
            "ID": "0192fb40-1aa2-7def-9abc-1122334455aa",
            "ProjectID": "0192fb00-0000-7000-8000-000000000001",
            "TemplateKey": "summary",
            "Name": "Hotel Summary",
            "EntityType": "hotel",
            "Description": "Short marketing summary shown at the top of the hotel page.",
            "Instruction": "Write a concise, factual two-sentence summary highlighting the hotel's location, standout amenity, and overall character. Avoid superlatives.",
            "LocaleInstructions": {
                "de-DE": "Schreibe eine sachliche Zusammenfassung in zwei Saetzen und verwende die Sie-Form."
            },
            "Status": "active",
            "RenderLayout": "prose",
            "CreatedAt": "2026-03-01T08:00:00Z",
            "UpdatedAt": "2026-04-10T12:30:00Z"
        },
        {
            "ID": "0192fb40-2bb3-7def-9abc-2233445566bb",
            "ProjectID": "0192fb00-0000-7000-8000-000000000001",
            "TemplateKey": "room_description",
            "Name": "Room Description",
            "EntityType": "room",
            "Description": "Per-room descriptive paragraph used on room cards.",
            "Instruction": "Describe the room in one short paragraph: size, bedding, view, and the most notable in-room features. Keep it neutral and concrete.",
            "LocaleInstructions": {},
            "Status": "active",
            "RenderLayout": "roomcards",
            "CreatedAt": "2026-03-01T08:00:00Z",
            "UpdatedAt": "2026-03-01T08:00:00Z"
        }
    ],
    "Pagination": {
        "Total": 2,
        "Limit": 50,
        "Offset": 0
    }
}

Modified at 2026-07-01 06:49:44

Save text template

Save tag