NaceDocs
DashboardGet an API key
DocumentationAPI ReferenceSDKsCLI

Perception

Get a job artifact

- Stored files (ground-crops, ground-transcript, parse-images, parse-transcript, converted-pdf, spreadsheet-cell-maps) answer 302 with a signed storage link that works for 5 minutes without your API key. With redirect=false, they answer 200 with that link as JSON. - Everything else (request, events, document-content, spreadsheet-content, spreadsheet-rows) is streamed. - Rate limits: file downloads don't count against the per-minute limit; events and request use the independent job-read window (600/min free, 3000/min paid; 5x the tier or account RPM override), separate from creates.

GET
/v1/documents/jobs/{id}/{path}
  • Stored files (ground-crops, ground-transcript, parse-images, parse-transcript, converted-pdf, spreadsheet-cell-maps) answer 302 with a signed storage link that works for 5 minutes without your API key. With redirect=false, they answer 200 with that link as JSON.
  • Everything else (request, events, document-content, spreadsheet-content, spreadsheet-rows) is streamed.
  • Rate limits: file downloads don't count against the per-minute limit; events and request use the independent job-read window (600/min free, 3000/min paid; 5x the tier or account RPM override), separate from creates.

Parse preview snapshots and events count against that independent job-read window; individual preview part reads do not. See Parse streaming.

Other errors (500, 502, 503, 504, 529) are on Errors.

Authorization

bearerAuth
AuthorizationBearer <token>

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

idstringrequired

The job's job_id, as returned when it was created.

Formatuuid
pathstringrequired

The rest of the link, for example parse-images/<ref>.

Query Parameters

redirectstring

For a stored file, false (or 0) returns the signed link as JSON instead of redirecting to it. Browser code needs this: it can't read a cross-origin redirect, and storage sends no CORS headers.

Default"true"
Value in"true""false""0""1"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08/string"
{  "url": "http://example.com",  "expires_at": 0}

Cancel or delete a job DELETE

Cancels the job if it is still running, removes it from the list and queues content erasure.

Create an upload grant POST

A short-lived token for uploading one file straight to the document service, into the workspace workspace_id names, or, without one, for your document jobs.