ingest
Changed onQueue an ingestion run for one file, a batch, or an entire folder.
Cost class: job (pipeline compute per file; billed on completion).
Pass a :class:~ndi_service.app.platform_api.contracts.IngestionSelection to say what to process:
- {"type": "file_ids", "file_ids": [...]} — explicit file list.
- {"type": "path_prefix", "path_prefix": "reports/"} — a folder; stale_only=true restricts the run to files whose hash diverged.
The ingestion lane (PDF, Excel, audio, …) is chosen per file from its type; a caller does not name a lane.
Per-file outcomes, not a single verdict. A file already ingested at the same hash is skipped_unchanged (free) unless reingest_unchanged is set. A valid zero-row raw Parquet file is skipped_empty (free) and produces no searchable table. One corrupt file in a folder of 400 does not fail the run. It appears as a failed entry in result.outcomes. A job where every attempted file failed is failed. Its error.code is taken from the files, and error.detail carries the per-file reasons. That job has no result. Partial failures stay outcomes on a succeeded job.
This is the only call that makes files searchable. Uploading a file to the workspace ledger registers it; ingesting it builds the representations (search index, knowledge-graph nodes) that queries read.
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