Vepler logo
v2.149.0

Planning applications: image galleries, in-browser documents, and enrichment

The planning API can return an application's image gallery, directly renderable document files and extracted text, and a summary of its documents, all through new opt-in include options.

Added

  • Added an images expansion to include that returns a deduplicated gallery of an application's plans, elevations and photographs. Each image carries a directly-renderable CDN url, its classification, dimensions, and the source document it was drawn from.
  • Added a content expansion that attaches fileUrl (the document PDF) and ocrUrl (its extracted text, as Markdown) to every entry in documents, so files can be displayed and searched in-browser. The council sourceUrl remains as the upstream fallback.
  • Added an enrichment expansion with a summary of each application's documents and, where recorded, how they were classified.
  • All three are available on GET /v1/planning/{applicationIds}, GET /v1/planning/sources/{sourceIds} and POST /v1/planning/query. Pass them through the include option: a comma-separated string on the by-id routes (for example ?include=images,content,extractions) or the include array in the query body. Every expansion is opt-in and omitted by default, so existing integrations are unaffected.

Affected endpoints