Skip to content
getgeolens.com
GeoLens Docs

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

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
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.

Array<string>
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

Responses

Section titled “ Responses ”

202

Section titled “202 ”

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"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}