get_transaction_document_download

Get transaction document file

Get a short-lived link to one buyer-owned transaction document's actual file, so it can be attached to an email you send from the buyer's own mailbox or saved for them. The link expires in minutes, covers only this document, and stops working if the buyer revokes this connection. Do not repeat the link back into the conversation as a durable reference; fetch a fresh one when it expires.

Effect: Read
Required scopes: documents:read
Workflow stages: closing, offer, transaction
Data classes: documents, transaction
Operation cost: 1 weighted units; additional domain limits may apply.
Configurations: Standard, Buyer UI v2
Muse proposal: Read. Retrieves or computes authorized information; consult the tool contract for its scopes and result. Meta makes the final classification during review.

Buyer approval and signing controls apply in addition to the scopes above. Read error and retry guidance before implementing recovery.

Input and output contracts

Returns structured content and a JSON text content block. Live discovery may compact a large output schema; execution validates the full contract below.

Input fields

Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.

Field	Required	Meaning and constraints
`documentId`string	Yes	Pattern validation applies; see the raw schema.
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Output fields

Field	Required	Meaning and constraints
`contentType`string	Yes	Maximum characters: 200. Pattern validation applies; see the raw schema.
`documentId`string	Yes	Pattern validation applies; see the raw schema.
`downloadUrl`string	Yes	Format: uri. Maximum characters: 4096.
`expiresAt`string	Yes	Format: date-time. Pattern validation applies; see the raw schema.
`filename`string	Yes	Minimum characters: 1. Maximum characters: 240.
`schemaVersion`string	Yes	Must be "1".
`sizeBytes`integer \| null	Yes	Must match at least one alternative.
sizeBytes: nested contract Alternative 1: integer Minimum: 0. Maximum: 1000000000. Alternative 2: null
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Raw input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "documentId",
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contentType": {
      "type": "string",
      "maxLength": 200,
      "pattern": "^[a-z0-9.+-]+\\/[a-z0-9.+-]+$"
    },
    "documentId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "downloadUrl": {
      "type": "string",
      "maxLength": 4096,
      "format": "uri"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 240
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "sizeBytes": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0,
          "maximum": 1000000000
        },
        {
          "type": "null"
        }
      ]
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "contentType",
    "documentId",
    "downloadUrl",
    "expiresAt",
    "filename",
    "schemaVersion",
    "sizeBytes",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

{
  "destructiveHint": false,
  "idempotentHint": false,
  "openWorldHint": false,
  "readOnlyHint": true
}

Reference 00e5441a095c7e20. Download the full catalog.