Spreadsheets

Download Spreadsheet Result

Changed on

Download a completed result or a retained workbook from a timeout or validation failure

get/api/spreadsheets/{runId}/download

Request

  • Base URL
    https://api.shortcut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or API key in cookie shortcut_access_token
    • or HTTP bearer

Path parameters

runIdstring required

Unique run identifier

Response

Binary Excel file. Content-Type and filename extension match the actual workbook container, including .xlsm. X-Shortcut-Artifact-Sha256 is the SHA-256 of the served bytes and X-Shortcut-Artifact-Validation the structural validation status (not_evaluated when none was recorded, e.g. timeout partial results). Retained failed-validation results use failed; recovery does not imply readability. Any result whose stored bytes no longer match the validated digest returns 409.

string binary required

Binary Excel file. Content-Type and filename extension match the actual workbook container, including .xlsm. X-Shortcut-Artifact-Sha256 is the SHA-256 of the served bytes and X-Shortcut-Artifact-Validation the structural validation status (not_evaluated when none was recorded, e.g. timeout partial results). Retained failed-validation results use failed; recovery does not imply readability. Any result whose stored bytes no longer match the validated digest returns 409.

Changes

    • breaking

      the response body contentMediaType changed from application/vnd.openxmlformats-officedocument.spreadsheetml.sheet to for the status

    • info

      the endpoint scheme security shortcutOAuth was added to the API