API Reference

GenAerial API

Generate AI-powered aerial images from any location on Earth. The GenAerial API allows you to programmatically create realistic aerial photography using coordinates and customizable environmental parameters.

https://api.genaerial.comVersion 1.0

Authentication

Learn how to authenticate your API requests

Quickstart

Generate your first aerial image in minutes

Endpoints

Explore all available API endpoints

Authentication

All API requests require authentication via the x-api-key header. You can generate API keys in your GenAerial dashboard.

API Keyx-api-key

bash

curl -X GET "https://api.genaerial.com/api/external/v1/image-generation" \
  -H "x-api-key: YOUR_API_KEY"

Important: Keep your API key secure. Never expose it in client-side code or public repositories.

Quickstart

Follow these steps to generate your first aerial image using the GenAerial API.

Get your API key

Get API Key

Make your first request

Use the following example to generate an aerial image of the Statue of Liberty in New York.

bash

curl -X POST "https://api.genaerial.com/api/external/v1/image-generation" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "coordinates": {
      "latitude": 40.6892,
      "longitude": -74.0445
    },
    "resolution": "FHD",
    "zoom": "Medium",
    "bearing": "N",
    "angle": "Medium",
    "weather": "Sunny",
    "daytime": "Day",
    "aspectRatio": "Landscape",
    "epoch": "Nowadays"
  }' \
  --output statue-of-liberty.jpg

View your generated image

The API returns a high-quality JPEG image. Open statue-of-liberty.jpg to see your generated aerial photograph.

Endpoints

Explore the available API endpoint groups below.

Image Generation

Generate AI-powered aerial images from geographical coordinates and environmental parameters.

GET/api/external/v1/image-generationList Generated Images POST/api/external/v1/image-generationGenerate Image POST/api/external/v1/image-generation/asyncGenerate Image (Async)DELETE/api/external/v1/image-generation/{id}Delete Image

Error Handling

The API returns standard HTTP status codes and JSON error responses when something goes wrong.

json

{
  "status": 400,
  "error": "ValidationFailed",
  "message": "A developer-friendly error message describing what went wrong"
}

Error Code	Description
`ValidationFailed`	Request parameters failed validation
`InsufficientCredits`	Account has insufficient credits for the operation
`ErrorGeneratingImage`	An error occurred during image generation
`NotFound`	Requested resource was not found

Webhooks

When using async image generation, the API will POST results to your callback URL.

Success Payload

json

{
  "requestId": "req_xyz789",
  "signedUrl": "https://s3.amazonaws.com/...",
  "generatedImageId": "img_abc123",
  "creditsUsed": 10
}

Error Payload

json

{
  "requestId": "req_xyz789",
  "errorCode": "ErrorGeneratingImage",
  "errorMessage": "An error occurred while generating the image"
}

Rate Limits

API requests are rate limited based on your plan. Contact us if you need higher limits for your use case.

Requests per minute

Concurrent generations

Unlimited

Images in history