ScaleODM API (dev)

Download OpenAPI specification:

URL: https://slack.hotosm.org License: AGPL-3.0-only

Kubernetes-native auto-scaling and load balancing for OpenDroneMap.

system

Dependency heartbeat

Returns dependency readiness status

Authorizations:

tokenAuthNone

Responses

Response samples

200
400
default

Content type

application/json

{"$schema": "https://example.com/schemas/ReadinessResponseBody.json",
"checks": {"property1": "string",
"property2": "string"
},
"ready": true,
"status": "ready",
"timestamp": "2025-04-05T12:00:00Z"
}

Load balancer heartbeat

Returns lightweight process heartbeat

Authorizations:

tokenAuthNone

Responses

Response samples

200
400
default

Content type

application/json

{"$schema": "https://example.com/schemas/HealthResponseBody.json",
"status": "healthy",
"timestamp": "2025-04-05T12:00:00Z"
}

Health check alias

Compatibility alias for /lbheartbeat

Authorizations:

tokenAuthNone

Responses

Response samples

200
400
default

Content type

application/json

{"$schema": "https://example.com/schemas/HealthResponseBody.json",
"status": "healthy",
"timestamp": "2025-04-05T12:00:00Z"
}

Readiness check alias

Compatibility alias for /heartbeat

Authorizations:

tokenAuthNone

Responses

Response samples

200
400
default

Content type

application/json

{"$schema": "https://example.com/schemas/ReadinessResponseBody.json",
"checks": {"property1": "string",
"property2": "string"
},
"ready": true,
"status": "ready",
"timestamp": "2025-04-05T12:00:00Z"
}

server

Retrieves information about this node

Authorizations:

tokenAuthNone

query Parameters

token

string

Authentication token (optional)

Responses

Response samples

200
400
default

Content type

application/json

{"$schema": "https://example.com/schemas/InfoResponseBody.json",
"availableMemory": 0,
"cpuCores": 0,
"engine": "string",
"engineVersion": "string",
"maxImages": 0,
"maxParallelTasks": 0,
"taskQueueCount": 0,
"totalMemory": 0,
"version": "string"
}

Retrieves command line options for task processing

Authorizations:

tokenAuthNone

query Parameters

token

string

Authentication token (optional)

Responses

Response samples

200
400
default

Content type

application/json

[{"domain": "string",
"help": "string",
"name": "string",
"type": "string",
"value": "string"
}
]

task

Cancels a task

Authorizations:

tokenAuthNone

query Parameters

token

string

Authentication token (optional)

Request Body schema: application/json
required

uuid

required

string

UUID of the task

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string"
}

Response samples

400
default

Content type

application/problem+json

{"$schema": "https://example.com/schemas/ErrorModel.json",
"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Gets the list of tasks

Authorizations:

tokenAuthNone

query Parameters

token

string

Authentication token (optional)

Responses

Response samples

200
400
default

Content type

application/json

[{"uuid": "string"
}
]

Creates a new task

Creates a new task and places it at the end of the processing queue

Authorizations:

tokenAuthNone

query Parameters

token

string

Authentication token (optional)

header Parameters

set-uuid

string

Optional UUID to use for this task

Request Body schema: application/json
required

capacityType	string Node capacity type for workflow pods: 'spot' (default) or 'on-demand' for VIP jobs.
dateCreated	integer <int64> Override creation timestamp (optional; defaults to current time when omitted)
excludePaths	string JSON array of rclone-style exclude patterns appended to the default set
name	string Task name (optional; defaults to 'odm-project' if empty)
options	string JSON array of processing options (optional; empty runs standard ODM with no extra flags)
processingMode	string Pipeline mode: 'standard' (default). Reserved: 'merge-existing', 'thermal', 'city-scale'.
readS3Path required	string S3 path (s3://bucket/path) to read imagery from
s3Endpoint	string Custom S3 endpoint (optional, for non-AWS S3 providers)
s3Region	string Default: "us-east-1" S3 region (default: us-east-1, or garage when s3Endpoint is set)
s3ScanDepth	integer <int64> Max depth for the rclone scan beneath readS3Path (default 1, max 10). Use >1 to pick up imagery under nested task subdirs.
skipPostProcessing	boolean Default: false Skip point cloud tiles generation (default: false)
useDefaultExcludes	boolean Apply the built-in ODM-output exclude list (default: true)
webhook	string Webhook URL (optional)
writeS3Path	string S3 path (s3://bucket/path) to write final products to (default: readS3Path + 'output/')
zipurl	string URL of zip file containing images (deprecated, use readS3Path)

Responses

Request samples

Payload

Content type

application/json

{"capacityType": "string",
"dateCreated": 0,
"excludePaths": "string",
"name": "string",
"options": "string",
"processingMode": "string",
"readS3Path": "string",
"s3Endpoint": "string",
"s3Region": "us-east-1",
"s3ScanDepth": 0,
"skipPostProcessing": false,
"useDefaultExcludes": true,
"webhook": "string",
"writeS3Path": "string",
"zipurl": "string"
}

Response samples

200
400
default

Content type

application/json

{"$schema": "https://example.com/schemas/TaskNewResponseBody.json",
"uuid": "string"
}

Removes a task and deletes all assets

Authorizations:

tokenAuthNone

query Parameters

token

string

Authentication token (optional)

Request Body schema: application/json
required

uuid

required

string

UUID of the task

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string"
}

Response samples

400
default

Content type

application/problem+json

{"$schema": "https://example.com/schemas/ErrorModel.json",
"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Restarts a task

Authorizations:

tokenAuthNone

query Parameters

token

string

Authentication token (optional)

Request Body schema: application/json
required

options	string New options (optional)
uuid required	string UUID of the task

Responses

Request samples

Payload

Content type

application/json

{"options": "string",
"uuid": "string"
}

Response samples

400
default

Content type

application/problem+json

{"$schema": "https://example.com/schemas/ErrorModel.json",
"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Lists primary and optional additional output assets

Authorizations:

tokenAuthNone

path Parameters

uuid

required

string

UUID of the task

query Parameters

token	string Authentication token (optional)
includeAdditional	boolean Default: false Include additional discovered files
additionalLimit	integer <int64> Default: 100 Maximum number of additional files to return (clamped to 1000)

Responses

Response samples

200
400
default

Content type

application/json

{"$schema": "https://example.com/schemas/TaskAssets.json",
"additional": [{"asset": "string",
"downloadUrl": "string"
}
],
"primary": [{"asset": "string",
"downloadUrl": "string",
"exists": true,
"id": "string"
}
]
}

Gets information about a task

Authorizations:

tokenAuthNone

path Parameters

uuid

required

string

UUID of the task

query Parameters

token	string Authentication token (optional)
with_output	integer <int64> Default: 0 Line number to start console output from

Responses

Response samples

200
400
default

Content type

application/json

{"$schema": "https://example.com/schemas/TaskInfo.json",
"dateCreated": 0,
"imagesCount": 0,
"name": "string",
"options": [{"name": "string",
"value": null
}
],
"output": ["string"
],
"processingTime": 0,
"progress": 0,
"status": {"code": 0,
"errorMessage": "string"
},
"uuid": "string"
}

Retrieves console output

Authorizations:

tokenAuthNone

path Parameters

uuid

required

string

UUID of the task

query Parameters

token	string Authentication token (optional)
line	integer <int64> Default: 0 Line number to start from

Responses

Response samples

200
400
default

Content type

application/json

"string"

ScaleODM API (dev)

system

Dependency heartbeat

Authorizations:

Responses

Response samples

Load balancer heartbeat

Authorizations:

Responses

Response samples

Health check alias

Authorizations:

Responses

Response samples

Readiness check alias

Authorizations:

Responses

Response samples

server

Retrieves information about this node

Authorizations:

query Parameters

Responses

Response samples

Retrieves command line options for task processing

Authorizations:

query Parameters

Responses

Response samples

task

Cancels a task

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Gets the list of tasks

Authorizations:

query Parameters

Responses

Response samples

Creates a new task

Authorizations:

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Removes a task and deletes all assets

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Restarts a task

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Lists primary and optional additional output assets

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Gets information about a task

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Retrieves console output

Authorizations:

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required