RenderedEnvelope

One rendered envelope. The documents array shape depends on the request's options.combinePdfs:

  • combinePdfs: false — one entry per document declared in the blueprint envelope. Each entry's key and name come from the document.
  • combinePdfs: true (default) — exactly one entry, representing the merged PDF for the whole envelope. The entry's key and name are inherited from the envelope itself (its key and subject), not from any single source document.

Consumers iterating documents[] work in both modes; if you need to distinguish, check options.combinePdfs from the request you sent.

  • documents
    Type: array object[] · RenderedBlueprintDocument[]
    required

    Rendered documents in this envelope. See the schema description for how the array shape varies with combinePdfs.

    • key
      Type: string
      required

      Identifier for this rendered output. When combinePdfs is false, this is the document's key from the blueprint envelope. When combinePdfs is true, this is the envelope's key (a single combined output stands in for the whole envelope).

    • name
      Type: string
      required

      Human-readable label. When combinePdfs is false, this is the document's name. When combinePdfs is true, this is the envelope's subject.

    • signedUrl
      Type: string
      required

      Short-lived URL to download the rendered PDF directly. Expires within minutes; not durable — re-render to get a fresh URL if needed.

  • envelopeKey
    Type: string
    required

    Matches an envelope key from the blueprint's spec.envelopes.