Start Processing Job
start_processing_jobRun a QGIS Processing algorithm as a background job and get its job ID immediately, so QGIS stays usable; poll progress or cancel as needed.
Instructions
Run a Processing algorithm as a QGIS background task, with no time limit, and return its job id at once. QGIS stays usable while it runs. Poll get_processing_job for progress and the result; cancel_processing_job stops it. Use it instead of execute_processing for anything that may take more than a minute. Same parameters as execute_processing. A 'TEMPORARY_OUTPUT'/'memory:' vector (feature sink) output needs load_results=True, since that memory layer ends with the job; temporary files stay on disk. Algorithms that must run on QGIS's main thread are refused: use execute_processing for those.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"algorithm": "<algorithm>",
"parameters": "<parameters>"
},
"name": "start_processing_job"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| algorithm | Yes | ||
| ellipsoid | No | ||
| parameters | Yes | ||
| load_results | No |