curl --request POST \
--url https://ndi-api.nace.ai/v1/workspaces/{workspace_id}/tools/locate \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"need": "<string>"
}
'{
"pages": [
{
"head": "<string>",
"number": 123,
"paged": true,
"path": "<string>",
"score": 123,
"component": "<string>",
"line_end": 123,
"line_start": 123
}
],
"population": [
{
"path": "<string>",
"score": 123
}
],
"tables": [
{
"columns": [
"<string>"
],
"path": "<string>",
"relevant_columns": [
"<string>"
],
"score": 123,
"sql_table": "<string>",
"tab": "<string>"
}
],
"text": "<string>",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"population_unrated": 0
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}locate
Find the pages and tables that hold a piece of information.
Cost class: medium — a few seconds on a workspace the navigator has seen; the first call after an ingestion change reads the workspace’s ingestion outputs first.
A decision model walks the workspace’s files, sections and pages (built at ingestion) and names the pieces to
read, best first, with the tables to query — the locate NDI’s own navigate-mode agent runs. text is that
agent’s reply, word for word. Only files the key may see are considered, cut to path_prefix / paths.
Stateless: send back the pieces a previous call offered (exclude) and what you have read (already_read)
to be shown something new.
curl --request POST \
--url https://ndi-api.nace.ai/v1/workspaces/{workspace_id}/tools/locate \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"need": "<string>"
}
'{
"pages": [
{
"head": "<string>",
"number": 123,
"paged": true,
"path": "<string>",
"score": 123,
"component": "<string>",
"line_end": 123,
"line_start": 123
}
],
"population": [
{
"path": "<string>",
"score": 123
}
],
"tables": [
{
"columns": [
"<string>"
],
"path": "<string>",
"relevant_columns": [
"<string>"
],
"score": 123,
"sql_table": "<string>",
"tab": "<string>"
}
],
"text": "<string>",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"population_unrated": 0
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}Authorizations
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.
200Path Parameters
Workspace identifier.
Body
Request for locate: where in the workspace a piece of information is.
The navigator NDI's own agent calls as ndi-locate, over the files the caller may see. It is stateless: what a
caller was already offered (exclude) and has read (already_read) is left out of the answer only when sent
back, as a run's memory does it for NDI's agent. A call that leaves out nothing is the caller's opening and rates
more files.
What is still needed, in a few words: a year, an entity, a line item, a definition.
1 - 400Reads already done: their pieces are left out, and the navigator is told they did not settle the need.
1000Show child attributes
Show child attributes
The need names a kind of file and every one is wanted (each invoice, every statement): the navigator rates each file of that kind and lists the members in population.
Pieces earlier locates offered, left out of this answer.
1000Show child attributes
Show child attributes
How many pieces to name.
1 <= x <= 24Only files under this folder, workspace-relative; paths adds files. Omit both for the whole workspace.
Only these uploaded files (with path_prefix, its folder's files too). Unknown or inaccessible paths are refused.
11 - 1024The whole question the need is part of; every decision weighs the need within it. Omit it and the need is the whole question.
1 - 4096Response
Successful Response
Response of locate: the reply NDI's agent reads, and the same findings as fields.
The pieces named, best first.
Show child attributes
Show child attributes
Set when answering needs every file of a kind (each invoice, every contract): the members, best first.
Show child attributes
Show child attributes
The tables rated for the need, best first.
Show child attributes
Show child attributes
The reply as NDI's own agent reads it: each piece with the command that reads it and its opening text, then a population's members and the tables to query.
The external operation job.
Files in folders rated likely to hold members that the budget ran out before rating: when above 0, population is incomplete; narrow the need to a folder, kind or period and locate again with every.