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) answer302with a signed storage link that works for 5 minutes without your API key. Withredirect=false, they answer200with 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;
eventsandrequestdo.
Other errors (500, 502, 503, 504, 529) are on Errors.
Authorization
bearerAuth Your API key from the dashboard's API Keys page: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -), shown once when you create it. Send it as Authorization: Bearer nace_sk_... Any other value returns 401 authentication_error. An account can hold at most 3 active keys.
In: header
Path Parameters
The job's job_id, as returned when it was created.
uuidThe rest of the link, for example parse-images/<ref>.
Query Parameters
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.
"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}