Skip to content
Spatial.Properties

Generate Report

POST
/report/generate

Generate a PDF feasibility report from scoring results.

Accepts scoring data and parcel geometries (which may be Point centroids as fallbacks). Resolves actual parcel Polygon geometries via DuckDB cadastre layer lookup. Streams progress events via SSE and delivers the final PDF as base64 in the report_complete event.

Streaming: This endpoint returns text/event-stream (Server-Sent Events). The response is a stream of SSE events, not a single JSON body.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
ReportGenerateRequest

Request body for report generation.

object
scores
required
Scores
Array<object>
object
key
additional properties
any
parcel_geojsons
required
Parcel Geojsons
Array<object>
ParcelGeometry

GeoJSON geometry for a parcel. Accepts Point (centroid fallback) or Polygon/MultiPolygon.

object
type
required
Type
string
coordinates
required
Coordinates
pack_id
Pack Id
string
""
location
Any of:
string
top_n
Top N
integer
default: 5

Responses

Section titled “ Responses ”

200

Section titled “200 ”

SSE event stream

string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object