ground
Locate caller-provided target text in a document.
Cost class: job (retrieval + model inference per target; billed on completion).
Each target is located independently and returns an honest location status: found, not_found, or failed. Ground does not verify claims and does not produce contradiction verdicts.
Up to MAX_CLAIM_BATCH targets or legacy claims per call; all are grounded against the same source.
Args: body: Ground parameters: source and the targets to locate. caller: Authenticated tenant. session: Database session. wait_seconds: Bounded inline wait. idempotency_key: Idempotent replay key. response: Injected by FastAPI for status-code management.
Returns: A :class:~ndi_service.app.platform_api.results.Job.
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.
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.