NAnace
Documents

Get a job artifact

A file the job produced (parse images, transcripts, ground crops, converted files), its request echo, or its events stream, at the path the job body links to. path may span several segments.

  • 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 do.

Parse preview snapshots and events count against the per-minute limit; individual preview part reads do not. See Parse streaming.

get/v1/documents/jobs/{id}/{path}

Request

Path parameters

idstring uuid required

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

pathstring required

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

Query parameters

redirect'true' | 'false' | '0' | '1'

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.

Response

A streamed artifact, in its own content type; for a stored file with redirect=false, its signed link as a DocumentJobFileLink.

OR
unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.