Commit Import

POST

/ingest/commit/{job_id}

const url = 'https://example.com/ingest/commit/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"title":"example","summary":"example","visibility":"private","srid_override":1,"token":"example","temporal_start":"2026-04-15T12:00:00Z","temporal_end":"2026-04-15T12:00:00Z","compression":"example","resampling":"example","nodata_override":1,"layer_name":"example","x_column":"example","y_column":"example","geom_column":"example","auth":{"method":"bearer","token":"example","username":"example","password":"example","header_name":"example","header_value":"example"},"strict_cog":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/ingest/commit/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "summary": "example", "visibility": "private", "srid_override": 1, "token": "example", "temporal_start": "2026-04-15T12:00:00Z", "temporal_end": "2026-04-15T12:00:00Z", "compression": "example", "resampling": "example", "nodata_override": 1, "layer_name": "example", "x_column": "example", "y_column": "example", "geom_column": "example", "auth": { "method": "bearer", "token": "example", "username": "example", "password": "example", "header_name": "example", "header_value": "example" }, "strict_cog": false }'

Commit a staged file for ingestion with user-supplied metadata.

Stores user metadata on the job and queues the ingest task. Only callable on jobs with status ‘pending’.

Authorizations

Parameters

Path Parameters

job_id

required

Job Id

string format: uuid

Request Body^required

application/json

CommitRequest

Wire-level schema for POST /ingest/commit/{job_id}.

Preserved as a flat union of all possible commit fields so that the FastAPI route signature renders correctly in OpenAPI and so that the frontend’s CommitImportRequest TypeScript type stays unchanged.

The route handler re-validates the body against a subclass chosen by _pick_commit_subclass(job) (see app.ingest.router):

VectorCommitRequest — default for file uploads
RasterCommitRequest — when job.user_metadata['file_type'] == 'raster'
ServiceCommitRequest — when job.source_url is set and job.file_path is None

For new internal code that constructs a commit view, prefer importing the appropriate subclass directly. This flat class is the wire contract, not an implementation detail.

object

title

required

Title

Human-readable dataset title.

string

>= 1 characters <= 500 characters

summary

Any of:

string
null

string

<= 5000 characters

visibility

Visibility

Dataset visibility level: ‘private’ (owner-only), ‘restricted’ (RBAC-controlled), ‘internal’ (all users), ‘public’ (anonymous access).

string

default: private

Allowed values: private restricted internal public

srid_override

Any of:

integer
null

integer

>= 1 <= 998999

token

Any of:

string
null

string

<= 1000 characters

temporal_start

Any of:

string
null

string format: date-time

temporal_end

Any of:

string
null

string format: date-time

compression

Any of:

string
null

string

resampling

Any of:

string
null

string

nodata_override

Any of:

number

layer_name

Any of:

string
null

string

x_column

Any of:

string
null

string

y_column

Any of:

string
null

string

geom_column

Any of:

string
null

string

auth

Any of:

ServiceAuthRequest
null

ServiceAuthRequest

How one request authenticates to the remote service it names.

object

method

required

Method

How the credential is presented to the remote service. Omit the whole auth object for a public service.

string

Allowed values: bearer basic header

token

Any of:

string
null

string

<= 1000 characters

username

Any of:

string
null

string

<= 255 characters

password

Any of:

string
null

string

<= 1000 characters

header_name

Any of:

string
null

string

<= 255 characters

header_value

Any of:

string
null

string

<= 1000 characters

strict_cog

Strict Cog

Raster only: reject a non-COG TIFF instead of converting it. False (the default) converts the source to a COG during ingest. True fails the job when the source is not already a compliant COG, and cannot be combined with resampling, nodata_override, srid_override or a compression other than the default DEFLATE: each of those is applied by a conversion, so the commit is refused with a 422 naming the fields that clash.

boolean

Responses

202

Successful Response

application/json

CommitResponse

object

job_id

required

Job Id

Identifier of the committed ingestion job.

string format: uuid

status

required

Status

Updated job status after commit.

string

message

required

Message

Human-readable commit result.

string

Example ^generated

{
  "job_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": "example",
  "message": "example"
}

400

Bad request — invalid payload

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Unauthorized — missing or invalid credentials

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Forbidden — caller lacks write access

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Not found

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

409

Conflict — resource state prevents the operation

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Validation error

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Too many requests — retry after the advertised interval

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Retry-After

integer

Seconds until the request may be retried

500

Internal server error

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Service unavailable — the database could not serve the request

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Privacy Apache 2.0 getgeolens.com

Commit Import

Authorizations

Parameters

Path Parameters

Request Body required

Responses

202

Example generated

400

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

Headers

500

Example

503

Example

Request Body^required

Example ^generated