RenderBlueprintResp

Result of a blueprint preview render: one entry per envelope declared in the blueprint, plus optional warnings.

envelopes
Type: array object[] · RenderedEnvelope[]
required

Rendered envelopes in the same order they appear in the blueprint's spec.envelopes.
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.
- envelopeKey
  Type: string
  required
  
  Matches an envelope key from the blueprint's spec.envelopes.
warnings
Type: array object[] · PreviewResourceWarning[]

Non-fatal warnings raised during rendering. Surface in your authoring UI; safe to ignore for finished previews.
Non-fatal warning emitted during render — the document was produced, but a referenced resource may have an issue worth flagging in your authoring UI.
- message
  Type: string
  required
  
  Human-readable warning text.
- resourceId
  Type: string
  required
  
  Identifier of the resource the warning relates to.
- source
  Type: stringenum
  required
  
  Where the resource came from when the warning was raised.
  
  values
  yaml
  database