Skip to content
getgeolens.com

Create Vrt

POST
/ingest/vrt/create
curl --request POST \
--url https://example.com/api/ingest/vrt/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "source_dataset_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "vrt_type": "mosaic", "resolution_strategy": "finest", "title": "example", "summary": "example", "visibility": "private" }'

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).

Media type application/json
VrtCreateRequest
object
source_dataset_ids
required
Source Dataset Ids

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

Array<string>
>= 1 items <= 500 items
vrt_type
required
Vrt Type

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

string
Allowed values: mosaic band_stack
resolution_strategy
required
Resolution Strategy

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

string
Allowed values: finest coarsest average
title
required
Title

Human-readable title for the resulting VRT dataset.

string
<= 500 characters
summary
Any of:
string
<= 5000 characters
visibility
Visibility

Visibility level for the resulting VRT dataset.

string
default: private
Allowed values: private restricted internal public

Successful Response

Media type application/json
VrtCreateResponse
object
job_id
required
Job Id

Identifier of the asynchronous VRT creation job.

string format: uuid
status
Status

Initial job status. Always ‘accepted’ on creation.

string
default: accepted
message
required
Message

Human-readable acceptance message.

string
Example
{
"status": "accepted"
}

Bad request — invalid payload

Unauthorized — missing or invalid credentials

Forbidden — caller lacks write access

Not found

Conflict — resource state prevents the operation

Validation error

Internal server error