Workspaces
Locate information
Other errors (500, 502, 503, 504) are on Errors.
Other errors (500, 502, 503, 504) are on Errors.
Authorization
bearerAuth Your API key, sent as Authorization: Bearer nace_sk_...
- Where: the dashboard's API Keys page. It is shown once, when you create it.
- Format:
nace_sk_followed by 43 URL-safe characters (A-Z,a-z,0-9,_and-). - Limit: an account can hold at most 3 active keys.
- Wrong or missing key: returns
401 authentication_error.
In: header
Path Parameters
The workspace's workspace_id.
Header Parameters
Up to 200 characters, unique per account. A call that timed out keeps running: send it again with the same key and body to get its answer instead of running it twice.
length <= 200Request Body
application/json
What is still needed, in a few words: a year, an entity, a line item, a definition.
1 <= length <= 400The whole question the need is part of; every decision weighs the need within it. Leave it out and the need is the whole question.
1 <= length <= 4096How many pieces to name.
1 <= value <= 2412The need names a kind of file and every one is wanted (each invoice, every statement): the model rates each file of that kind and lists the members in population.
falseOnly files under this folder; paths adds files. Leave both out for the whole workspace.
Only these files (with path_prefix, its folder's files too). An unknown path, or one the key can't read, is refused.
1 <= itemsPieces earlier locates offered, left out of this answer.
items <= 1000Show child attributes
Reads already done: their pieces are left out, and the model is told they did not settle the need.
items <= 1000Show child attributes
Name every page in text by its opening lines only. Leave it out and the best pages come in full, as a task's first locate wants them; a task's later locates send it, so page text does not pile up in an agent's context.
falseResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/tools/locate" \ -H "Content-Type: application/json" \ -d '{ "need": "total liabilities at year end 2024", "question": "How did total liabilities change from 2023 to 2024?" }'{ "text": "string", "pages": [ { "path": "string", "component": "string", "paged": true, "number": 0, "line_start": 0, "line_end": 0, "score": 0, "head": "string" } ], "tables": [ { "sql_table": "string", "path": "string", "tab": "string", "score": 0, "columns": [ "string" ], "relevant_columns": [ "string" ] } ], "population": [ { "path": "string", "score": 0 } ], "population_unrated": 0, "job_id": "string"}