automatic_search
Answer one query with fact search or the automatic search agent. Cost class: job.
With mode auto (the default), the service reads the query and optional context before retrieval and chooses a one-pass fact search for focused lookups, or an agent that locates the pages and tables it needs with a navigator over the workspace's files (on a workspace in a bring-your-own bucket or customer storage, by searching it), then reads documents, queries tables, and selects documents from the metadata catalog. When it chooses fact search and fact search cannot settle the question (it finds no answer while a table it was given was not read whole, such as a Parquet table or one too large to read, or it cites nothing, grades its answer low or speculative, or fails), the agent answers instead: routing.selected stays fact and routing.final reads agent. When fact search finds no answer in material it read whole, that is the answer, with no hand-over. In any mode, a query that asks for nothing (a keyboard mash, say) and none of whose words a document contains is answered so without a search or a charge. mode fact or agent runs that route directly, with no routing step to bill and no hand-over. This single-shot route does not ask clarification questions. Every route enforces the caller's access and its scope: path_prefix and paths resolve to one file set, the same one fact search and the agent (its catalog commands included) filter by. Each paths entry must name a visible uploaded source file.
The result contains the chosen route's output and its owning output_job_id, plus routing details. When the agent answers from the catalog, its output also carries the catalog table, whose next_cursor continues through filtered-search with a page request, without another routing decision.
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.