POST/api/external/v1/image-generation/async

Generate Image (Async)

Asynchronously generates an aerial image. The result is delivered via a webhook callback to the URL specified in the x-callback-url header.

Request URL

plaintext

https://api.genaerial.com/api/external/v1/image-generation/async

Headers

Parameter	Type	Required	Description
`x-callback-url`(required)	string	Required	URL that will receive the success or error callback when generation completes.

Request Body

application/jsonSame image generation parameters as the synchronous endpoint.

json

1{
2  "coordinates": {
3    "lat": 40.7484,
4    "lng": -73.9857
5  },
6  "resolution": "UHD",
7  "zoom": "High",
8  "bearing": "NorthEast",
9  "angle": "Medium",
10  "weather": "GoldenHour",
11  "daytime": "Dusk",
12  "aspectRatio": "Landscape",
13  "epoch": "Nowadays",
14  "tags": []
15}

Body Parameters

Parameter	Type	Required	Description
`coordinates`(required)	object	Required	Geographic coordinates with lat and lng properties.
`resolution`(required)	string	Required	Output image resolution. `HDFHDUHD`
`zoom`(required)	string	Required	Zoom level for the aerial view. `ExtraLowLowMediumHighExtraHigh`
`bearing`(required)	string	Required	Compass direction. `NorthNorthEastEastSouthEastSouthSouthWestWestNorthWest`
`angle`(required)	string	Required	Camera angle. `LowMediumHighTop`
`weather`(required)	string	Required	Weather conditions. `SunnyRainyCloudyGoldenHourSnow`
`daytime`(required)	string	Required	Time of day. `DuskDayDawnNight`
`aspectRatio`(required)	string	Required	Aspect ratio. `SquareLandscapePortraitStandard`
`epoch`(required)	string	Required	Historical period. `NowadaysHistoricalAncient`
`includeContext`(optional)	boolean	Optional	Enable landmark-specific enhancement for recognized locations.
`includeSurroundings`(optional)	boolean	Optional	Include surrounding area in the generated image. Default: `true`
`improveOutput`(optional)	boolean	Optional	Apply quality enhancement to the output.
`saveImage`(optional)	boolean	Optional	Persist the generated image in your history. Default: `true`
`tags`(required)	array	Required	Descriptive tags for the image (maximum 10).
`prompt`(optional)	string	Optional	Custom enhancement instructions for the generation.

Responses

202Accepted

Request accepted. The result will be delivered via webhook.

json

{
  "requestId": "req_xyz789",
  "status": "processing"
}

400Bad Request

Invalid request or missing callback URL.

402Payment Required

Insufficient credits.

Code Examples

bash

curl -X POST "https://api.genaerial.com/api/external/v1/image-generation/async" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-callback-url: https://your-server.com/webhook" \
  -H "Content-Type: application/json" \
  -d '{
    "coordinates": { "lat": 40.7484, "lng": -73.9857 },
    "resolution": "UHD",
    "zoom": "High",
    "bearing": "NorthEast",
    "angle": "Medium",
    "weather": "GoldenHour",
    "daytime": "Dusk",
    "aspectRatio": "Landscape",
    "epoch": "Nowadays",
    "tags": []
  }'