get_document_upload_handoff

Get document upload handoff

Last resort for taking a file: a signed-in Ohvii page where the buyer adds it themselves, for when the buyer cannot attach it in this chat (add_documents_from_chat), the card's upload button does not work here, and you cannot read the file's bytes yourself. Name the document in plain words ("Proof of funds", "Pre-approval letter", "Inspection report"); the page shows that ask with a Choose file button. With kind disclosure_package the page opens the seller disclosure uploader instead (label it "Seller disclosures"). Hand the buyer the uploadUrl, then continue when the file appears in list_transaction_documents or list_disclosure_packages. Nothing is sent by uploading.

Effect: Read
Required scopes: documents:read
Workflow stages: closing, offer, transaction
Data classes: documents
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
`kind`string	No	Allowed: "documents", "disclosure_package".
`label`string	Yes	Minimum characters: 1. Maximum characters: 80.
`purpose`string	No	Allowed: "offer_support", "repair_evidence", "repair_seller_response".
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Output fields

Field	Required	Meaning and constraints
`label`string	Yes	Minimum characters: 1. Maximum characters: 80.
`next`string	Yes	Must be "open_upload_page".
`purpose`string \| null	Yes	Must match at least one alternative.
purpose: nested contract Alternative 1: string Allowed: "offer_support", "repair_evidence", "repair_seller_response". Alternative 2: null
`schemaVersion`string	Yes	Must be "1".
`uploadUrl`string	Yes	Format: uri. Maximum characters: 2048.
`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": {
    "kind": {
      "type": "string",
      "enum": [
        "documents",
        "disclosure_package"
      ]
    },
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "purpose": {
      "type": "string",
      "enum": [
        "offer_support",
        "repair_evidence",
        "repair_seller_response"
      ]
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "label",
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "next": {
      "type": "string",
      "const": "open_upload_page"
    },
    "purpose": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "offer_support",
            "repair_evidence",
            "repair_seller_response"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "uploadUrl": {
      "type": "string",
      "maxLength": 2048,
      "format": "uri"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "label",
    "next",
    "purpose",
    "schemaVersion",
    "uploadUrl",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

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

Reference 00e5441a095c7e20. Download the full catalog.