Sign in
Datasets

Preview File

Run preview on a staged file and return preview data.

For vector files: returns columns, CRS, geometry type, feature count, sample rows. For raster files: returns band count, CRS, resolution, compliance status. For a 3D Tiles tileset: returns its version, root geometric error, bounding volume kind, extent and unpacked size, read from the archive's directory and tileset.json without unpacking it. For a COPC point cloud: returns its point count and format, CRS, extent, elevation range and size, read from its header and hierarchy. Only callable on jobs with status 'pending'.

post/ingest/preview/{job_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

job_idstring uuid required

Query parameters

layer_namestring nullable

Sheet/layer name for multi-layer files

Response

Successful Response

OR
OR
OR

Changes

No recorded changes to this operation across all 50 revisions of this API.