AI Property Descriptions

Generate professional marketing descriptions for property listings using AI. The generated text is based on the property's attributes and, optionally, its images.

Endpoint

Authentication: Required (API key or JWT)

Request Body

Provide as much property detail as possible for the best results. All fields are optional, but more data produces better descriptions.

| Field | Type | Description | |-------|------|-------------| | propertyId | string | ID of an existing property (used to verify ownership) | | propertyType | string | Property type (e.g., villa, apartment, penthouse) | | propertyCategory | string | Property category: residential, commercial, industrial, land | | listingType | string | Listing type: sale, rent, sale_or_rent, fraction | | bedrooms | number | Number of bedrooms | | bathrooms | number | Number of bathrooms | | city | string | City name | | provinceState | string | Province or state | | countryCode | string | ISO 3166-1 alpha-2 country code | | region | string | Region name | | community | string | Community or neighborhood | | livingArea | number | Living area size | | plotArea | number | Plot area size | | areaUnit | string | Unit for area fields (e.g., sqm, sqft) | | yearBuilt | number | Year of construction | | price | number | Listing price | | currency | string | ISO 4217 currency code | | hasPool | boolean | Swimming pool | | hasSeaView | boolean | Sea view | | hasGarage | boolean | Garage | | hasTerrace | boolean | Terrace | | hasGarden | boolean | Garden | | isFurnished | boolean | Furnished | | hasAirConditioning | boolean | Air conditioning | | hasLift | boolean | Elevator / lift | | additionalFeatures | object | Custom key-value features | | imageUrls | string[] | URLs of property images for AI image analysis |

Example

curl -X POST https://api.leadhql.com/properties/description/generate \
  -H "Authorization: Bearer leadhql_pk_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "propertyType": "villa",
    "propertyCategory": "residential",
    "listingType": "sale",
    "bedrooms": 4,
    "bathrooms": 3,
    "city": "Marbella",
    "region": "Costa del Sol",
    "countryCode": "ES",
    "livingArea": 320,
    "plotArea": 800,
    "areaUnit": "sqm",
    "price": 1250000,
    "currency": "EUR",
    "hasPool": true,
    "hasSeaView": true,
    "hasGarden": true,
    "imageUrls": [
      "https://cdn.example.com/property/img1.jpg",
      "https://cdn.example.com/property/img2.jpg"
    ]
  }'

Response

{
  "description": "Discover this exceptional 4-bedroom villa in the heart of Marbella's Costa del Sol, offering breathtaking sea views and a private swimming pool. Spanning 320 sqm of living space on an 800 sqm plot, this residence features beautifully landscaped gardens, spacious terraces, and contemporary finishes throughout..."
}

| Field | Type | Description | |-------|------|-------------| | description | string | AI-generated marketing description |

Tips

• Include imageUrls when available — the AI analyzes images to describe visual details like interior finishes, views, and architectural style
• Provide accurate location data (city, region, countryCode) for location-specific marketing language
• The generated description is ready to use as-is or as a starting point for editing