One POST per tool, all generated from the same manifest the in-app tools run on. This page derives from the live catalog: names, parameters and flags cannot drift from the backend.
Same base URL, same auth, same envelope — per tool.
Every tool is a single POST under the API base. Authentication and the response envelope are documented in the Reference; this page adds what varies per tool: the fields, the ceilings and the response.
POST https://haiyz.net/api/enterprise/v1/gis/buffer
X-Api-Key: haiyz_pk_live_xxxxxxxxxxxx
X-Api-Secret: haiyz_sk_live_xxxxxxxxxxxxxxxxxxxxxxxxTwo shapes: a stored file, or an inline JSON result.
File-producing tools store the output and answer with the standard envelope: the storage key, the suggested output filename, your input's key, per-tool result fields, and a usage block. Vector tools include the feature count, output CRS and geometry type:
keyoutputFilenameinputKeyusagefeatureCountcrsgeometryTypeThe bytes are fetched separately: with the returned key in the app, or from the run's artifact URL on the API (GET /runs/{runId}) — Content-Disposition carries the filename.
JSON tools (coordinate conversion, measurement, point-in-polygon…) return their result inline in data — no stored file unless the tool says otherwise.
About X-Output-Filename and X-CRS
Safety rails that apply before any per-tool limit.
1 tools
POST /validate-convertValidate and convert shapefiles, GeoJSON, and KML files.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
sourceCrsrepairedCountbbox1 tools
POST /extract-exifRead where, when and in which direction each photo was taken, and get the photos as a point layer.
| Field | Type | Required | Details |
|---|---|---|---|
files | file | yes | repeat the field once per file |
imagesinputKeysgeotaggedCounttotalCountgeojsonOutput12 tools
POST /line-to-polygonConvert a coordinate sequence into a closed polygon and compute geodetic area, perimeter, and shape statistics.
| Field | Type | Required | Details |
|---|---|---|---|
coordinates | array | yes | an array of [lon, lat] pairs — at least 3 |
POST /line-to-polygon/file| Field | Type | Required | Details |
|---|---|---|---|
file | file | yes |
keyinputKeystatsusagePOST /simplifyReduce the vertices of a layer by a tolerance in metres, and keep the borders neighbouring polygons share.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
methodMethod | string | optional | douglas | coverage · default douglas |
tolerance_mTolerance | number | optional | min 0.001 · max 100000 · default 10 · in the unit `unit` names; min and max are metres |
unitDistance unit | string | optional | m | km | ft | mi · default m |
preserve_topologyPreserve topology (avoid self-intersections) | boolean | optional | default true |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
verticesBeforeverticesAfterinputFeatureCountmethodSend tolerance_m (on the ground, in unit). The older tolerance, in degrees, is still read when tolerance_m is not sent.
POST /bounding-shapeDraw the outline that encloses your features — a convex or concave hull, an extent box or a circle — round the whole layer, each group or each feature.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
shapeShape | string | optional | convex | concave | envelope | circle · default convex |
ratioTightness | number | optional | min 0.05 · max 1 · default 0.3 |
scopeDraw it round | string | optional | layer | group | feature · default layer |
byGroup by column | string | optional | max 5 · a JSON list of column names read from `file`, such as ["district","use"] |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountgroupFieldskippedCountThe older routes /convex-hull and /concave-hull still answer as they did; new work should call /bounding-shape. by is required when scope is group.
POST /centroidsReplace every feature with its centroid point — turn polygons or lines into a points layer.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
methodPoint placement | string | optional | centroid | inside · default centroid |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputGeometryTypePOST /bufferCreate buffer zones around points, lines or polygons — by one distance, by each feature's own from a column, or as rings — measured on the ground.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
distance_byDistance from | string | optional | value | column | rings · default value |
distance_mBuffer distance | number | optional | min -100000 · max 100000 · default 100 · in the unit `unit` names; min and max are metres |
distance_fieldDistance column | string | yes | a column name read from `file` |
ringsRing distances | string | yes | |
unitDistance unit | string | optional | m | km | ft | mi · default m |
dissolveDissolve overlapping buffers into one geometry | boolean | optional | default false |
dissolve_byDissolve by column | string | optional | a column name read from `file` |
cap_styleCap style (buffer ends) | string | optional | round | flat | square · default round |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
dissolveddistanceMinputFeatureCountringCountskippedCountGive one of distance_m, distance_field or rings. distance_m may be negative to shrink polygons; zero is rejected.
POST /dissolveMerge features that share the values of one or more columns into one shape, with the statistics you choose.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
byGroup by column | string | optional | max 5 · a JSON list of column names read from `file`, such as ["district","use"] |
statsStatistics | string | optional | a JSON list of statistics over the columns of `file`, each with a field and an op; op is one of: sum | mean | min | max | median | std | range | first | last | unique | join · max 20 |
single_partOne feature per connected piece | boolean | optional | default false |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountgroupsgroupFieldPOST /clipCut a layer down to a boundary layer, keeping only the parts that fall inside it.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
maskClip boundary (polygons) | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountdroppedCountPOST /eraseRemove the parts of a layer that fall inside an erase layer — Clip's opposite, keeping what lies outside.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
maskErase layer (polygons) | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountchangedCountdroppedCountPOST /random-pointsPlace random points inside polygons — a count per polygon or for the whole layer, with optional spacing and a repeatable seed.
| Field | Type | Required | Details |
|---|---|---|---|
filePolygon layer | file | yes | vector geodata (see the accepted-extensions list above) |
countNumber of points | number | optional | min 1 · max 10000 · default 10 |
perCount for | string | optional | polygon | layer · default polygon |
min_distance_mMinimum spacing | number | optional | min 0 · max 100000 · default 0 |
seedSeed (optional) | string | optional | |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountrequestedCountpointCountPOST /explodeSplit multipart features into one feature per part, so every polygon or line stands on its own row.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountmultipartCountpartsCreatedPOST /repairFix invalid geometries — self-intersections, unclosed rings and empty shapes — so the layer loads cleanly in any GIS.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountinvalidBeforeinvalidAfterdroppedCountPOST /gridGenerate a regular grid of square cells across a layer's extent, at a cell size you choose in metres.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
cell_size_mCell size | number | optional | min 1 · max 5000000 · default 1000 |
clip_to_extentClip grid to the input | boolean | optional | default false |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountrowscolscellSizeM2 tools
POST /distance-bearingCompute geodesic distance and forward/back bearing between a sequence of points.
| Field | Type | Required | Details |
|---|---|---|---|
points | array | yes | an array of { lon, lat } objects — at least 2 |
segmentstotal_distance_mtotal_distance_kmstraight_distance_mstraight_distance_kmis_closedpoint_countsegment_countPOST /area-lengthWrite area, perimeter, length, centroid, vertex and part counts into columns — measured on the ellipsoid, in the units you choose.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
propertiesCalculate | string | optional | area | perimeter | length | centroid | vertices | parts · min 1 · default area,perimeter,length |
area_unitArea unit | string | optional | m2 | km2 | ha | ft2 | ac · default m2 |
length_unitLength unit | string | optional | m | km | ft | mi · default m |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCounttotalAreaM2totalLengthMmeasuredAreasmeasuredLengthspropertiesWith no properties, the tool writes area_m2, area_km2, area_ha, length_m and length_km, as Area & Length always did.
5 tools
POST /mergeMerge 2–5 geo-files (shapefile, GeoJSON, KML) into a single layer with a unified CRS — each feature tagged with its source file.
| Field | Type | Required | Details |
|---|---|---|---|
filesFiles to merge (2–5) | file | yes | vector geodata (see the accepted-extensions list above) · 2–5 files |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
fileCountPOST /intersectCut two layers by each other and keep the pieces they share — each with the columns of both.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
overlayOverlay layer (polygons) | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
prefixPrefix for the added columns (optional) | string | optional | |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountoverlayFeatureCountThe overlay layer must be polygons. Union needs polygons on both sides.
POST /unionCombine two polygon layers into every piece of either, each with the columns of the layers it came from.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
overlayOverlay layer (polygons) | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
prefixPrefix for the added columns (optional) | string | optional | |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountoverlayFeatureCountThe overlay layer must be polygons. Union needs polygons on both sides.
POST /inside-checkCheck whether each feature lies inside a polygon layer — wholly, partly, or by a share — and which area it falls in.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
referenceReference layer (polygons) | file | yes | vector geodata (see the accepted-extensions list above) |
rulePasses when | string | optional | inside | partial | percent · default inside |
percentShare inside | number | optional | min 0 · max 100 · default 50 |
match_fieldsFields to report from the reference (optional) | string | optional | |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
insideCountpartialCountoutsideCountpassedCountPOST /spatial-joinAttach the attributes of one layer to another by location — by spatial relationship, by the nearest feature, or within a distance.
| Field | Type | Required | Details |
|---|---|---|---|
fileInput file | file | yes | vector geodata (see the accepted-extensions list above) |
joinLayer to join from | file | yes | vector geodata (see the accepted-extensions list above) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
predicateSpatial relationship | string | optional | intersects | within | contains | crosses | touches | overlaps | nearest | dwithin · default intersects |
distance_mDistance | number | optional | min 0.001 · max 5000000 · in the unit `unit` names; min and max are metres |
unitDistance unit | string | optional | m | km | ft | mi · default m |
matchRows per input feature | string | optional | all | first | largest | summary · default all |
fieldsColumns to bring | string | optional | a JSON list of column names read from `join`, such as ["district","use"] · max 20 |
statsStatistics | string | optional | a JSON list of statistics over the columns of `join`, each with a field and an op; op is one of: sum | mean | min | max | median | std | range | first | last | unique | join · max 20 |
prefixPrefix for the added columns (optional) | string | optional | |
howFeatures to keep | string | optional | inner | left · default inner |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountjoinFeatureCountmatchedCountunmatchedCountmatchTotalpredicatematchdistance_m is required for dwithin and optional for nearest; both write distance_m on the ground. stats are computed when match is summary.
1 tools
POST /raster-inspectUpload a GeoTIFF/DEM to see its CRS, bounds, resolution, and per-band statistics, plus a quick preview image.
| Field | Type | Required | Details |
|---|---|---|---|
file | file | yes |
inputKeypreviewKeypreviewPngB64crswidthheightbandCountresolutionboundsbandsusage2 tools
POST /cog-optimizeCheck a GeoTIFF against the Cloud-Optimized GeoTIFF structure — tiles, overviews, and the order of its directories and data — see each finding, and download an optimized copy.
| Field | Type | Required | Details |
|---|---|---|---|
fileRaster (GeoTIFF) | file | yes | GeoTIFF (.tif, .tiff, .geotiff) |
validfindingsoptimizedValidwasAlreadyCogissueswidthheightbandCountoriginalTiledoriginalOverviewCountoriginalCompressionoptimizedOverviewCountoptimizedCompressionvalid is the verdict on the file as sent (wasAlreadyCog repeats it). findings lists each one with a code, a level and a message, the level being error, warning or note; a file with no overviews is valid with a warning, as GDAL's validator says. Checked from the header and directories: tiling, overviews, and the order of directories and data. Not checked: each tile's leader and trailer bytes, and an internal mask's directories.
POST /zonal-statsSummarise raster values inside each polygon zone — mean, min, max, sum and count per feature.
| Field | Type | Required | Details |
|---|---|---|---|
fileZone polygons | file | yes | vector geodata (see the accepted-extensions list above) |
rasterRaster (GeoTIFF) | file | yes | GeoTIFF (.tif, .tiff, .geotiff) |
target_formatOutput format | string | yes | geojson | shp | kml | gml | gpkg | fgb | kmz | parquet |
bandRaster band | number | optional | min 1 · max 100 · default 1 |
statsStatistics | string | optional | min | max | mean | median | std | sum | count · min 1 · default min,max,mean,count |
all_touchedCount every pixel the zone touches | boolean | optional | default false |
zero_is_nodataTreat 0 as no data | boolean | optional | default true |
source_crsCoordinate system of the file | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
output_crsCoordinate system of the result | string | optional | an authority code such as EPSG:32638; see Coordinate systems in Hyz tools |
inputFeatureCountzoneszonesWithDatabandstats5 tools
POST /remove-backgroundRemove the background from a photo automatically — leave it transparent, put a colour behind the subject, or take the mask.
| Field | Type | Required | Details |
|---|---|---|---|
fileImage | file | yes | PNG, JPEG, WebP, BMP |
outputResult | string | optional | image | mask · default image |
backgroundBehind the subject | string | optional | transparent | white | black | color · default transparent |
background_colorColour | string | yes | |
refineClean the edge | boolean | optional | default false |
mattingKeep soft edges (hair, fur) | boolean | optional | default false |
outputbackgroundPOST /enhance-qualityRe-encode an image at a chosen quality — lighter for the web, or full resolution with an optional 2× upscale for Pro members.
| Field | Type | Required | Details |
|---|---|---|---|
fileImage | file | yes | PNG, JPEG, WebP, BMP, TIFF, GIF |
upscale2× upscale | boolean | optional | default false |
POST /convert-formatConvert an image between PNG, JPG, WebP, BMP, TIFF, and GIF.
| Field | Type | Required | Details |
|---|---|---|---|
fileImage | file | yes | PNG, JPEG, WebP, BMP, TIFF, GIF |
target_formatTarget format | string | optional | png | jpeg | webp | bmp | tiff | gif · default png |
POST /image-watermarkAdd a text or logo watermark to a photo or graphic.
| Field | Type | Required | Details |
|---|---|---|---|
fileImage | file | yes | PNG, JPEG, WebP, BMP, TIFF, GIF |
wm_modeWatermark type | string | optional | text | image · default text |
textWatermark text | string | yes | |
logoImage to stamp | file | yes | PNG, JPEG, WebP, BMP, TIFF, GIF |
positionPosition | string | optional | diagonal | center | top-left | top-right | bottom-left | bottom-right · default bottom-right |
opacityOpacity | number | optional | min 0.05 · max 1 · default 0.4 |
Provide exactly one of text or logo — the engine rejects both or neither.
POST /merge-imagesStitch multiple images into one — stacked, side by side, or as a grid.
| Field | Type | Required | Details |
|---|---|---|---|
filesImages | file | yes | PNG, JPEG, WebP, BMP, TIFF, GIF · 2–12 files |
layoutLayout | string | optional | vertical | horizontal | grid · default vertical |
fileCountwidthheight11 tools
POST /ocrRead the text of a scanned image or PDF — English, Arabic, or both — and get it back as text or as a searchable PDF.
| Field | Type | Required | Details |
|---|---|---|---|
file | file | yes | an image, or a PDF of scanned pages (up to 30) |
lang | string | optional | eng | ara | eng+ara · default eng |
mode | string | optional | auto | block | sparse · default auto |
output | string | optional | text | pdf · default text |
orientation | boolean | optional | default true |
keypdfKeyinputKeytextlangcharCountpageCountconfidencelowConfidencerotatedPagespagesusageconfidence is 0–100, per page and overall; lowConfidence is true below 60. With output=pdf the searchable PDF is stored and answered as pdfKey.
POST /pdf-to-wordConvert a PDF's text and layout into an editable Word document.
| Field | Type | Required | Details |
|---|---|---|---|
filePDF file | file | yes |
POST /document-signPlace an image of your signature on a PDF — draw it, upload it, or reuse a saved one — with your name and the date under it. A stamp, not a certified digital signature.
| Field | Type | Required | Details |
|---|---|---|---|
file | file | yes | |
signature | file | yes | PNG only |
placements | json-string | yes | a JSON string: an array of { page, x, y, w, h } boxes in page fractions (0–1) |
caption | string | optional | one line under each stamp — a name and a date; up to 120 characters |
placementCounthadDigitalSignaturecaptionedThis stamps a signature image into the pages — it is not a certified digital signature. hadDigitalSignature is true when the PDF already carried one, which the stamp stops verifying.
POST /merge-pdfCombine up to 20 PDFs into one document, in the order you choose.
| Field | Type | Required | Details |
|---|---|---|---|
filesPDF files (2–20) | file | yes | PDF · 2–20 files |
fileCountpageCountPOST /split-pdfExtract pages or page ranges from a PDF — as one part or several.
| Field | Type | Required | Details |
|---|---|---|---|
filePDF file | file | yes | |
rangesPages to extract | string | yes |
partCountA single range returns a PDF; several ranges return a ZIP (the real name is in outputFilename).
POST /compress-pdfShrink a PDF's file size by re-encoding its images and cleaning up its structure.
| Field | Type | Required | Details |
|---|---|---|---|
filePDF file | file | yes | |
qualityQuality | string | optional | screen | ebook | print · default ebook |
pageCountoriginalBytescompressedBytesalreadyOptimizedPOST /pdf-to-imagesRender each page of a PDF as a high-quality PNG image.
| Field | Type | Required | Details |
|---|---|---|---|
filePDF file | file | yes | |
dpiResolution (DPI) | string | optional | 72 | 150 | 300 · default 150 |
pageCountAlways returns a ZIP of page images.
POST /pdf-watermarkStamp text or a logo across every page of a PDF.
| Field | Type | Required | Details |
|---|---|---|---|
filePDF file | file | yes | |
wm_modeWatermark type | string | optional | text | image · default text |
textWatermark text | string | yes | |
logoImage to stamp | file | yes | PNG, JPEG, WebP, BMP, TIFF, GIF |
positionPosition | string | optional | diagonal | center | top-left | top-right | bottom-left | bottom-right · default diagonal |
opacityOpacity | number | optional | min 0.05 · max 1 · default 0.15 |
pageCountProvide exactly one of text or logo — the engine rejects both or neither.
POST /images-to-pdfTurn photos and scans into a single PDF, one image per page.
| Field | Type | Required | Details |
|---|---|---|---|
filesImages | file | yes | PNG, JPEG, WebP, BMP, TIFF, GIF · 1–20 files |
page_modePage size | string | optional | a4 | fit · default a4 |
pageCountfileCountPOST /fill-pdfType into a PDF's own form fields and download the filled document.
| Field | Type | Required | Details |
|---|---|---|---|
file | file | yes | |
values | json-string | yes | a JSON string: an object of AcroForm field name → value (up to the form-values limit) |
flatten | string | optional | true | false · default false |
fieldCountfilledCountflattenedPOST /rotate-pagesFix page orientation and drop unwanted pages, right on the thumbnails.
| Field | Type | Required | Details |
|---|---|---|---|
file | file | yes | |
operations | json-string | yes | a JSON string: { "rotations": { "<page>": 90|180|270 }, "delete": [pages] } — pages are 0-based; at least one operation |
pageCountrotatedCountdeletedCountIn the manifest, not in the catalog.
Two tools have no standalone page and never appear in the browsable catalog — they are invoked from inside other surfaces, and over the API. They are gated and metered like every other tool.
POST /workspace-exportConvert the workspace's visible layers to Shapefile, KML or CSV.
| Field | Type | Required | Details |
|---|---|---|---|
file | file | yes | the workspace layer as GeoJSON |
target_format | string | yes | shp | kml | csv | geojson |
base_name | string | optional |
featureCounttruncatedFieldsPOST /map-exportCompose a print-ready map sheet with a title, legend and north arrow.
| Field | Type | Required | Details |
|---|---|---|---|
image | file | yes | repeat the field once per fileone PNG capture per map block, repeated |
logo | file | optional | |
spec | json-string | yes | a JSON string describing the sheet: page (a4|a3|letter), orientation, title, legend items, attribution, CRS label and more |