Skip to content

Generate property text

Generate a headline and description for a property.

POST /restapi/api/ai/v1.0/nlg/listing/property/generate

Supported media types:
JSON

Request

Body Values

The following table lists the enumerations that apply to the request body. See the JSON examples below for an overview of the full request body.

PARAMETER CONSTRAINTS
realEstateType* house, apartment
transactionType* rent, sale
(apartmentDetails|houseDetails).condition NO_INFORMATION, FIRST_TIME_USE, FIRST_TIME_USE_AFTER_REFURBISHMENT, MINT_CONDITION, REFURBISHED, MODERNIZED, FULLY_RENOVATED, WELL_KEPT, NEED_OF_RENOVATION, NEGOTIABLE, RIPE_FOR_DEMOLITION
(apartmentDetails|houseDetails).buildingEnergyRatingType ENERGY_REQUIRED, ENERGY_CONSUMPTION
(apartmentDetails|houseDetails).heatingType NO_INFORMATION, CENTRAL_HEATING, COMBINED_HEAT_AND_POWER_PLANT, DISTRICT_HEATING, ELECTRIC_HEATING, FLOOR_HEATING, GAS_HEATING, HEAT_PUMP, NIGHT_STORAGE_HEATER, OIL_HEATING, SELF_CONTAINED_CENTRAL_HEATING, SOLAR_HEATING, STOVE_HEATING, WOOD_PELLET_HEATING
(apartmentDetails|houseDetails).interiorQuality NO_INFORMATION, LUXURY, SOPHISTICATED, NORMAL, SIMPLE
apartmentDetails.buildingType NO_INFORMATION, ATTIC, GROUND_FLOOR, APARTMENT, ENTRESOL, LOFT, DUPLEX, PENTHOUSE, BASEMENT, TERRACE, OTHER
houseDetails.buildingType NO_INFORMATION, SINGLE_FAMILY_HOUSE, MID_TERRACE_HOUSE, END_TERRACE_HOUSE, MULTI_FAMILY_HOUSE, BUNGALOW, FARMHOUSE, SEMIDETACHED_HOUSE, VILLA, CASTLE_MANOR_HOUSE, SPECIAL_REAL_ESTATE, OTHER
houseDetails.constructionPhase NO_INFORMATION, PROJECTED, UNDER_CONSTRUCTION, COMPLETED
houseDetails.parkingSpaceType OUTSIDE, CARPORT, DUPLEX, GARAGE, CAR_PARK, UNDERGROUND_GARAGE

JSON (apartment):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
  "realEstateType": "apartment",
  "transactionType": "rent",
  "location": {
    "street": "Bundesstraße",
    "number": "6",
    "postalCode": "87538",
    "city": "Fischen",
    "district": "Langenwang",
    "geoCoordinates": {
      "lambertEuCoordinatesX": 20494,
      "lambertEuCoordinatesY": 1950073,
      "latitude": 47.43796,
      "longitude": 10.27554
    }
  },
  "apartmentDetails": {
    "additionalCosts": 120,
    "balconyTerrace": true,
    "basement": false,
    "buildingEnergyRatingType": "ENERGY_CONSUMPTION",
    "buildingType": "APARTMENT",
    "certificateOfEligibilityNeeded": false,
    "condition": "FULLY_RENOVATED",
    "constructionYear": 2012,
    "consumptionContainsWarmWater": false,
    "deposit": "1470,00",
    "efficiencyClass": "NO_INFORMATION",
    "elevator": false,
    "energyCertificateAvailability": "AVAILABLE",
    "energyCertificateCreationDate": "FROM_01_05_2014",
    "equippedKitchen": true,
    "floor": 1,
    "firingType": [
      "GAS"
    ],
    "flatShareSuitable": false,
    "garageParkingSpace": true,
    "guestToilet": false,
    "handicappedAccessible": false,
    "heatingCostsOption": "heatingCostsIncluded",
    "heatingType": "CENTRAL_HEATING",
    "interiorQuality": "NO_INFORMATION",
    "lastRefurbishment": 2015,
    "livingSpace": 65,
    "monthlyRent": 490,
    "moveInDate": "01.06.2017",
    "noBathrooms": 1,
    "noFloors": 2,
    "noRooms": 2,    
    "parkingSpaceRent": 0,
    "parkingSpaceType": "OUTSIDE",
    "noParkingSpaces": 2,
    "petsAllowed": "NEGOTIABLE",    
    "price": 610,
    "rented": true,
    "rentalIncome": 600,
    "rentSubsidy": 201.5,
    "sharedGarden": false,
    "thermalCharacteristic": 110,
    "demand": 1000,
    "noSimilarObjects": 73
  }
}

JSON (house):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
  "realEstateType": "house",
  "transactionType": "rent",
  "location": {
    "street": "Hauptstraße",
    "number": "1234",
    "city": "Sendai",
    "district": "Queens"
  },
  "houseDetails": {
    "basement": false,
    "buildingType": "NO_INFORMATION",
    "buildingEnergyRatingType": "ENERGY_REQUIRED",    
    "condition": "RIPE_FOR_DEMOLITION",
    "constructionYear": 1930,
    "constructionPhase": "NO_INFORMATION",
    "equippedKitchen": true,
    "floorPlan": true,
    "flatShareSuitable": true,
    "guestToilet": true,
    "garageParkingSpace": true,
    "heatingType": "WOOD_PELLET_HEATING",
    "handicappedAccessible": true,
    "interiorQuality": "NORMAL",
    "livingSpace": 3.14,
    "lastRefurbishment": 1930,
    "monument": true,
    "moveInDate": "25.12.2099",    
    "noRooms": 1,
    "noFloors": 5,
    "noBathrooms": 1,
    "price": 3.14,
    "propertySize": 3.14,
    "parkingSpaceType": "OUTSIDE",    
    "summerResidencePractical": true
  }
}

Response

JSON:

1
2
3
4
{
  "propertyText": "Zum 01.06.2017 kann in die ansprechende, vollständig renovierte Wohnung, die in der ersten Etage liegt, eingezogen werden. Die zwei einladende Zimmer können Sie nach Ihrem persönlichen Geschmack einrichten. Ein aktueller Energieausweis ist vorhanden. Zum Apartment gehört auch ein Balkon, auf dem es sich wunderbar vom Alltag erholen lässt. Eine Einbauküche sowie ein Stellplatz für Ihr Auto stehen Ihnen außerdem zur Verfügung.",
  "headline": "Vollständig renovierte Wohnung mit zwei Zimmern sowie Balkon und EBK in Fischen"
}

Possible Errors

400 - Invalid or missing request object. 401 - Invalid or expired authorization token. 403 - The user is not entitled to use this service. 500 - Unexpected service error.