qa
Ask a question about a workspace, as one turn of a conversation. Cost class: job.
Every turn runs the automatic search agent on its own — no router, no fixed pipeline, no opening search. The agent finds what the turn needs itself, in the light of the conversation so far: it asks a navigator over the workspace's files, sections and pages, or, on a workspace in a bring-your-own bucket or customer storage, searches it. It then reads documents, queries tables, and selects documents from the metadata catalog until it can answer. Every tool enforces the caller's access and the conversation's scope: path_prefix and paths resolve to one file set.
Pass a result's session_id to ask a follow-up: the agent resumes the conversation, so "and for 2023?" or "why?" means what it means in context. When a question is genuinely ambiguous the agent may ask back instead (allow_clarification, on by default): the result then carries clarification_questions with answer null; reply with clarification_answers and the same session_id, or rephrase.
A conversation's first question that asks for nothing (a keyboard mash, say) and none of whose words a document contains is answered so without running the agent or a charge, and starts no conversation.
The result is the agent's answer — citations, SQL receipts, confidence — plus, when it answered from a catalog query, the catalog table, whose next_cursor continues through filtered-search.
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.