Sign in
Datasets

Create Vrt

Changed on

Create a VRT dataset by combining existing raster datasets.

Validates sources synchronously, then defers VRT assembly to an async task. Returns a job_id for polling. Validation + queuing logic lives in ingest.service.create_vrt_job (K5 extraction).

post/ingest/vrt/create

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

Request body

source_dataset_idsstring[] required

Source raster dataset IDs to include in the VRT mosaic or band stack (2-500).

vrt_type'mosaic' | 'band_stack' required

Type of VRT to create. 'mosaic' tiles sources spatially; 'band_stack' aligns same-extent sources as multi-band output.

resolution_strategy'finest' | 'coarsest' | 'average' required

How to resolve mismatched source resolutions: 'finest' uses the highest, 'coarsest' uses the lowest, 'average' computes the mean.

titlestring required

Human-readable title for the resulting VRT dataset.

summarystring nullable

Optional description for the VRT dataset.

visibility'private' | 'restricted' | 'internal' | 'public'

Visibility level for the resulting VRT dataset.

Response

Successful Response

job_idstring uuid required

Identifier of the asynchronous VRT creation job.

statusstring

Initial job status. Always 'accepted' on creation.

messagestring required

Human-readable acceptance message.

Changes