reconcile
Changed onDetect divergence between storage and the file ledger; optionally act on it.
Cost class: job (storage listing + hash comparison; billed on completion).
Reconciliation compares the customer-visible storage tree against the ledger and records the result there. The scan itself never modifies stored bytes or derived representations. It marks:
- discovered — objects in storage with no ledger row.
- stale — rows whose observed_hash no longer matches the stored object.
- orphans — rows whose object is gone from storage.
Set auto_ingest=true to chain a POST /workspaces/{id}/ingestions automatically when divergence is found. Without it, reconciliation still updates the ledger but starts no ingestion. The ingestion_job_id in the result points to that job so you can poll it separately.
selection.stale_only on the chained ingestion is the routine case: it re-ingests exactly the stale files and is a no-op when nothing diverged.
path_prefix scopes the scan; omit it (or pass null) to scan the whole workspace.
Request
- Base URLhttps://ndi-api.nace.ai
- AuthAPI key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Workspace identifier.
Query parameters
Bounded inline wait. 0 (the default) returns 202 immediately. Above 0 the route returns 200 with a terminal job if the work finished in time, and 202 with the still-running job if it did not. Either way, read status. Waiting does not change how an admitted job is counted and takes no max_concurrent_sync slot (that limits synchronous calls such as the legacy synchronous API and /v1/systemone). For retained jobs, the deployment may shorten the wait and return 202 with the running job; poll GET /v1/jobs/{job_id}. For parse, split, classify, categorize, extract and ground, a zero_retention tenant must pass wait_seconds above 0.
Headers
Use the same key to recover an earlier request. A replay returned as a Job carries Idempotent-Replayed: true and replayed: true without a new charge; Job credits keeps the original cost. Re-serving a settled inline tool answer reports zero credits for that call and also carries Idempotent-Replayed: true; a fresh re-execution after a transient failure carries no header. The key is kept with the job for replay and never cleared, so it must not contain personal data.
Request body
Response
Terminal job or idempotent replay of the original job; read status and replayed.
Changes
- info
added the optional property
to the response with the status - info
added the success response with the status
- info