operations

create_job_download_link

Changed on

Sign a short-lived link to one file a succeeded job's result names.

The file is authorized exactly as its stable /jobs/{job_id}/{resource}/{ref} URL authorizes it (per tenant, and for a service key per external account); the link then fetches the bytes without API-key headers until expires_at: from S3 when presigned, or from the API's token download on the local backend.

post/v1/jobs/{job_id}/download-links

Request

  • Base URL
    https://ndi-api.nace.ai
  • Auth
    API key in header X-API-Key

Path parameters

job_idstring uuid required

Job identifier.

Request body

resource'split-artifacts' | 'ground-crops' | 'ground-transcript' | 'parse-images' | 'parse-transcript' | 'converted-pdf' | 'spreadsheet-cell-maps' required

Route segment of the job file, as in its stable URL /v1/jobs/{job_id}/{resource}/{ref}.

refstring required

Opaque file ref, the last segment of that stable URL.

disposition'inline' | 'attachment'

Whether a browser should render the file in place or save it. Types unsafe to render are always attachments.

Response

Successful Response

urlstring required

Signed download URL. Treat it as a temporary credential. Customer-workspace links recheck storage access and job availability when opened; other links remain valid until expiry.

expires_atinteger required

Expiry of the URL, as Unix epoch seconds.

file_namestring required

Name the file is served under.

content_typestring required

Media type the file is served with.

disposition'inline' | 'attachment' required

Disposition the file is served with.

Changes

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status