← Tool reference

create_disclosure_upload

Start disclosure upload

Start uploading a seller disclosure package the buyer has as files (a combined PDF, separate PDFs, a ZIP, or images): declare each file's byte size, content type, and filename and get one upload target per file, exactly as the review room's upload does. Omit packageId for a new package or pass an existing one to add a newer version. PUT each file's bytes to its uploadUrl (gcs_resumable accepts one PUT of the whole file with Content-Length; emulator_single_put is one PUT), then call finalize_disclosure_upload with the source ids before uploadExpiresAt. Reuse idempotencyKey only for an exact retry; it returns the same session. Nothing is analyzed, signed, or sent by starting an upload. Rate limited per buyer; available when the deployment has disclosure uploads enabled.

Effect
Draft or workspace edit
Required scopes
documents:write
Workflow stages
offer, transaction
Data classes
disclosures, documents
Operation cost
2 weighted units; additional domain limits may apply.
Configurations
Standard, Buyer UI v2
Muse proposal
Write. Creates or updates draft, document, or workspace data within the authorized workflow. 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.

FieldRequiredMeaning and constraints
filesarray<object>Yes

Minimum items: 1.

Maximum items: 100.

files: nested contract
Array item contract

Extra fields are not allowed.

FieldRequiredMeaning and constraints
bytesintegerYes

Maximum: 9007199254740991.

Greater than: 0.

contentTypestringYes

Minimum characters: 1.

Maximum characters: 120.

filenamestringYes

Minimum characters: 1.

Maximum characters: 240.

representationstringNo

Allowed: "combined_pdf", "separate_archive", "single_document", "image", "multi_file".

idempotencyKeystringYes

A fresh random UUID (v4) you generate for this request. Send the same UUID only to retry the identical request; never a readable label.

Format: uuid.

Pattern validation applies; see the raw schema.

packageIdstringNo

Pattern validation applies; see the raw schema.

workspaceIdstringYes

Pattern validation applies; see the raw schema.

Output 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.

FieldRequiredMeaning and constraints
idempotencyKeystringYes

Format: uuid.

Pattern validation applies; see the raw schema.

packageIdstringYes

Pattern validation applies; see the raw schema.

schemaVersionstringYes

Must be "1".

uploadExpiresAtstringYes

Format: date-time.

Pattern validation applies; see the raw schema.

uploadsarray<object>Yes

Minimum items: 1.

Maximum items: 100.

uploads: nested contract
Array item contract

Extra fields are not allowed.

FieldRequiredMeaning and constraints
bytesintegerYes

Maximum: 9007199254740991.

Greater than: 0.

contentTypestringYes

Minimum characters: 1.

Maximum characters: 120.

filenamestringYes

Minimum characters: 1.

Maximum characters: 240.

sourceIdstringYes

Pattern validation applies; see the raw schema.

uploadProtocolstringYes

Allowed: "emulator_single_put", "gcs_resumable".

uploadUrlstringYes

Format: uri.

Maximum characters: 4000.

versionIdstringYes

Pattern validation applies; see the raw schema.

versionNumberintegerYes

Maximum: 9007199254740991.

Greater than: 0.

workspaceIdstringYes

Pattern validation applies; see the raw schema.

Raw input schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "files": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bytes": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "contentType": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "filename": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "representation": {
            "type": "string",
            "enum": [
              "combined_pdf",
              "separate_archive",
              "single_document",
              "image",
              "multi_file"
            ]
          }
        },
        "required": [
          "bytes",
          "contentType",
          "filename"
        ],
        "additionalProperties": false
      }
    },
    "idempotencyKey": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "A fresh random UUID (v4) you generate for this request. Send the same UUID only to retry the identical request; never a readable label."
    },
    "packageId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "files",
    "idempotencyKey",
    "workspaceId"
  ],
  "additionalProperties": false
}
Full output schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "idempotencyKey": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "packageId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "uploadExpiresAt": {
      "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)))$"
    },
    "uploads": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bytes": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "contentType": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "filename": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "sourceId": {
            "type": "string",
            "pattern": "^[A-Za-z0-9_-]{1,200}$"
          },
          "uploadProtocol": {
            "type": "string",
            "enum": [
              "emulator_single_put",
              "gcs_resumable"
            ]
          },
          "uploadUrl": {
            "type": "string",
            "maxLength": 4000,
            "format": "uri"
          }
        },
        "required": [
          "bytes",
          "contentType",
          "filename",
          "sourceId",
          "uploadProtocol",
          "uploadUrl"
        ],
        "additionalProperties": false
      }
    },
    "versionId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "versionNumber": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "idempotencyKey",
    "packageId",
    "schemaVersion",
    "uploadExpiresAt",
    "uploads",
    "versionId",
    "versionNumber",
    "workspaceId"
  ],
  "additionalProperties": false
}
Tool annotations
{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": false
}

Reference 00e5441a095c7e20. Download the full catalog.