fact_search
Run the fixed single-shot search pipeline over a workspace. Cost class: job.
One retrieval pass (hybrid search, plus the knowledge graph when the workspace has one, fused when both legs return candidates), targeted page reads or retrieved passages for prose (specialized engines for tables or images), then one answering pass — so it returns in seconds where deep-search may take minutes. The caller receives a 202 with a queued :class:~ndi_service.app.platform_api.results.Job and polls GET /jobs/{id} for the :class:~ndi_service.app.platform_api.results.IntelligentSearchResult — the identical result shape deep-search lands, evidences and coverage included.
Single-shot: a fact-search run keeps no conversation, so the result's session_id is always null and the request body has no session_id field. For a thread you can ask follow-ups in, call deep-search. It always answers — the result carries a direct grounded answer, with reasoning stating how the pipeline read the query — and never asks back: the body has no allow_clarification either (a fixed pipeline has no agent who could pose the question).
paths scopes the run to exactly those uploaded files: every retrieval leg sees only them and the content ingested from them, enforced server-side against the stored job. Each entry must name a visible uploaded source file (file_not_found / access_denied otherwise, before any job is created). With path_prefix the two add up: the run covers the folder's files plus the named ones.
Retrieval only: this job never grounds. To pin a quote to a region of its source document, call document-operations ground on the file the evidence names (source_file_id) with its quote as the target text.
Args: body: Search parameters: query, context, path_prefix, paths, top_k. context: Resolved workspace plus the caller's access predicate. session: Database session. wait_seconds: Bounded inline wait (0 → immediate 202). idempotency_key: Replaying with the same key returns the original job. response: Injected by FastAPI for status-code management.
Returns: A queued :class:~ndi_service.app.platform_api.results.Job. On success the result is an :class:~ndi_service.app.platform_api.results.IntelligentSearchResult with evidences, the answer and reasoning, coverage, and the pipeline's step trace.
Request
- Base URLhttps://ndi-api.nace.ai (the document declares no server; this is the origin it was published from)
- 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.
Headers
Replaying a request with the same key returns the original job with 200, never a second job. The key is kept with the job for replay and never cleared, so it must not contain personal data.
Request body
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.