Get Ingestion Task
Get the details and current status of a specific ingestion task.
โถUse Cases
- Poll for task completion after uploading a file.
- Check the current processing stage of an ingestion (validating, geocoding, matching, complete).
โถStatus lifecycle
The overall_status field tracks the current processing stage:
pendingโ task created, processing has not started.processingโ file is being stored and prepared.validatingโ normalization and validation steps are running.stagedโ locations validated and staged, ready for processing.completedโ processing finished successfully.failedโ processing failed (seeerror_message; for a duplicate upload, alsoduplicate_of_asset_task_id).
โถTask attributes
Alongside overall_status, source_file, and tags, every task carries:
nameโ human-friendly task name. Caller-supplied at creation, or derived from the tags (joined with,) falling back to the source filename.descriptionโ free-form caller-supplied notes;nullwhen none was set.location_typeโfacility,plot, orshed. Reconciled to the type detected in the uploaded file once the task reachesstaged, so it may differ from the value originally requested.error_messageโ the human-readable reason. Populated whenoverall_statusisfailedorskipped, and on astagedtask the credit check refused, as<code>: <reason>(e.g.LOCATION_ALREADY_HELD,INSUFFICIENT_CREDITS); a held-location refusal lists the first five held keys and counts the rest.nullotherwise.duplicate_of_asset_task_idโ present only when this upload was rejected as a duplicate (signed-URL flow). The task isfailedand this is the id of the earlier completed task whose results to use instead. Re-submit withforce: trueto override. See Ingest Assets โ Duplicate uploads.tagsโ the tags supplied at creation, echoed verbatim. Includes anynamespace:{Column Header}per-row templates; these are expanded against each row at ingestion (they are not pre-expanded here). See Ingest Assets โ Per-row tags from columns.
โถQuery parameters
include=deforestationโ opt-in EUDR compliance roll-up. Addsattributes.deforestationto the response with plot counts (total_plots,compliant_plots,non_compliant_plots,unknown_plots) and area totals (total_area_ha,compliant_area_ha). Only meaningful once the task's deforestation processing has completed; unknown include values return 400VALIDATION_ERROR. See Query Parameters โ Per-endpoint includes.
Required scope:
ingestions:read