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
- 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