Skip to content

Generate area text

Notes:

  • Users of this feature are required to display the following copyright information together with the generated area text: 
    1
2
    Textvorschlag basierend auf Daten von OpenStreetMap
© OpenStreetMap-Mitwirkende (as a link to www.openstreetmap.org/copyright)

Generate a description for an area.

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

Get Permission
Supported media types:
JSON

Request

JSON (minimal example):

1
2
3
4
5
6
7
8
9
{
  "location": {
    "city": "Berlin",
    "geoCoordinates": {
      "latitude": 5.6,
      "longitude": 7.8
    }
  }
}

JSON (full example):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "location": {
    "street": "Hannoversche Str.",
    "number": "15",
    "postalCode": "10115",
    "city": "Berlin",
    "district": "Mitte",
    "geoCoordinates": {
      "lambertEuCoordinatesX": 1.2,
      "lambertEuCoordinatesY": 3.4,
      "latitude": 5.6,
      "longitude": 7.8
    }
  }
}

Response

JSON:

1
2
3
{
  "areaText": "Die Immobilie liegt in Berlin Mitte."
}

Possible Errors

400 - Invalid or missing request object. 401 - Invalid or expired authorization token. 500 - Unexpected service error.