Download OpenAPI specification:
Kubernetes-native auto-scaling and load balancing for OpenDroneMap.
{- "status": "healthy",
- "timestamp": "2025-04-05T12:00:00Z"
}| token | string Authentication token (optional) |
{- "availableMemory": 0,
- "cpuCores": 0,
- "engine": "string",
- "engineVersion": "string",
- "maxImages": 0,
- "maxParallelTasks": 0,
- "taskQueueCount": 0,
- "totalMemory": 0,
- "version": "string"
}| token | string Authentication token (optional) |
| uuid required | string UUID of the task |
{- "uuid": "string"
}{- "detail": "Property foo is required but is missing.",
- "errors": [
- {
- "location": "string",
- "message": "string",
- "value": null
}
], - "status": 400,
- "title": "Bad Request",
}Creates a new task and places it at the end of the processing queue
| token | string Authentication token (optional) |
| set-uuid | string Optional UUID to use for this task |
| dateCreated | integer <int64> Override creation timestamp (optional; defaults to current time when omitted) |
| name | string Task name (optional; defaults to 'odm-project' if empty) |
| options | string JSON array of processing options (optional; defaults to fast-orthophoto when empty) |
| readS3Path required | string S3 path (s3://bucket/path) to read imagery from |
| s3AccessKeyID | string S3 access key ID (optional, for authenticated buckets) |
| s3Endpoint | string Custom S3 endpoint (optional, for non-AWS S3 providers) |
| s3Region | string Default: "us-east-1" S3 region (default: us-east-1) |
| s3SecretAccessKey | string S3 secret access key (optional, for authenticated buckets) |
| s3SessionToken | string S3 session token (optional, for STS credentials) |
| skipPostProcessing | boolean Default: false Skip point cloud tiles generation (default: false) |
| 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) |
{- "dateCreated": 0,
- "name": "string",
- "options": "string",
- "readS3Path": "string",
- "s3AccessKeyID": "string",
- "s3Endpoint": "string",
- "s3Region": "us-east-1",
- "s3SecretAccessKey": "string",
- "s3SessionToken": "string",
- "skipPostProcessing": false,
- "webhook": "string",
- "writeS3Path": "string",
- "zipurl": "string"
}{- "uuid": "string"
}| token | string Authentication token (optional) |
| uuid required | string UUID of the task |
{- "uuid": "string"
}{- "detail": "Property foo is required but is missing.",
- "errors": [
- {
- "location": "string",
- "message": "string",
- "value": null
}
], - "status": 400,
- "title": "Bad Request",
}| token | string Authentication token (optional) |
| options | string New options (optional) |
| uuid required | string UUID of the task |
{- "options": "string",
- "uuid": "string"
}{- "detail": "Property foo is required but is missing.",
- "errors": [
- {
- "location": "string",
- "message": "string",
- "value": null
}
], - "status": 400,
- "title": "Bad Request",
}Redirects to a pre-signed URL for downloading the asset directly from S3
| uuid required | string UUID of the task |
| asset required | string Asset type (all.zip, orthophoto.tif, etc) |
| token | string Authentication token (optional) |
"string"| uuid required | string UUID of the task |
| token | string Authentication token (optional) |
| with_output | integer <int64> Default: 0 Line number to start console output from |
{- "dateCreated": 0,
- "imagesCount": 0,
- "name": "string",
- "options": [
- {
- "name": "string",
- "value": null
}
], - "output": [
- "string"
], - "processingTime": 0,
- "progress": 0,
- "status": 0,
- "uuid": "string"
}