build_knowledge_graph
Changed onBuild (or rebuild) the workspace's knowledge graph from its ingested files.
Cost class: job (corpus-level extraction and entity resolution; billed on completion).
The graph is built over every ingested file in the workspace at once — entity resolution links entities across documents, so it cannot be a per-file operation the way parsing or categorization are. Files that are not yet ingested are not in the corpus. Ingest them first, then build. A workspace with no ingested files is refused with invalid_request before a job is created. That check runs after an idempotent replay, so a retry of a build that already started still returns the original job. A workspace whose ingested files are all excluded by graph rules still starts a job. The workflow fails that job. A rebuild resumes from the durable store, re-paying only for what changed since the last build. force clears the store and rebuilds from scratch.
Once built, query the graph with the kg-info / kg-search / kg-walk context tools. A file's representations.knowledge_graph reads true once a build that covered it has finalized.
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