Generate Palette PDF
palette_pdfGenerate a premium branded PDF specification sheet from a palette of archive entries. Returns a downloadable PDF with full-bleed colour panels, archive names, provenance notes, RAL nearest match, LRV, chroma, WCAG contrast data, and Colour Memory branding. Use this to create client deliverables, specification sheets, and print assets. TRUST BOUNDARY: every colour rendered in this PDF is verified server-side against the real archive by (name, hex, archive_source) before it is drawn -- any claim_strength, primary_source, colour_notes, colour_basis, or hex_confidence supplied in entries/sections is IGNORED and replaced with Colour Memory's own record for that colour; an entry that matches no real archive record refuses the whole request (PDF_ENTRY_NOT_VERIFIED) rather than being dropped or rendered with the caller's claim. Two supported entry sources: (1) the flat entries array from query_hex or palette_from_concept -- each item needs name, hex, archive_source (colour_notes/primary_source/zone may be supplied but are ignored/overwritten by the server-verified record); or (2) archive_report_brief's output -- pass report['presented_cards'] as entries, NOT report['colour_cards'] (the legacy field is kept only for backward compatibility and does not carry family-card presentation). presented_cards may mix three card shapes, all rendered as exactly one page each regardless of how many underlying records they represent: single_cultivar (a normal flat card), colour_family (card_type='colour_family', many near-identical records summarised as one card with member_count/supported_by/family_delta_e_max -- every member is verified individually, and representative_hex must be one of the verified members' own hexes), and conservative-mode hero cards (a single_cultivar card carrying family_grouping_suppressed=true and also_supported_by, representing a larger natural family that was folded into one promoted cultivar instead of shown as a group). delivery controls how the PDF is returned: 'url' (default) gives a signed, time-limited R2 download link; 'base64' returns the PDF bytes inline in the response for callers that need the file directly rather than a link. This tool requires a valid, authenticated API key EXCEPT when using house_ref alone (anonymous house_ref access is unchanged) -- entries, sections, and project_id all require a key; a keyless request to those returns 401. No extra credit is charged for the key check itself. Alternative input mode: pass sections instead of entries for a grouped, multi-section document (e.g. house_specify's rooms) instead of one page per flat colour card. Each section has entries (verified exactly like the flat-entries path above) and, optionally, grouping_basis/hero_hex. DO NOT send title, subtitle, rationale, or application_notes on a section -- these are requester free text, and this renderer cannot currently keep them cleanly separated from Colour Memory's own evidence, so any of them being present REFUSES THE WHOLE REQUEST with a 400 (REQUESTER_FREE_TEXT_NOT_ALLOWED) naming the offending field(s); a section with only entries still renders, with an auto-numbered heading. presentation.template picks the layout: 'sectioned_specification' (clean grid-per-section spec sheet) or 'colour_drenched_lookbook' (hero colour fills the page, swatches cover most of it, citations collected into a final appendix rather than shrunk onto every page). Third input mode: pass house_ref (NOT house) -- the reference string house_specify's own response returns -- for the flagship document-plan pipeline: a complete, editorial multi-archetype publication with a cover, a house_thesis argument page, a whole_house_progression chart, one room_hero + one implementation (practical specification) page per room, and a redesigned source_appendix, all sharing one design system. house_ref (or project_id, for an authenticated caller's own durable project) is the ONLY way to reach this pipeline: passing the house_specify response object itself as an inline house field is REFUSED outright (400, INLINE_HOUSE_NOT_ALLOWED) -- this PDF is Colour Memory-branded, and it can only render a house Colour Memory itself created and still holds, never one relayed back through the request body, even unmodified. Call house_specify first, then pass the house_ref it returns here. house_ref/project_id takes priority over sections/entries when supplied.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| house | No | DO NOT USE. Inline house objects are REFUSED outright (400, INLINE_HOUSE_NOT_ALLOWED), even alongside a valid house_ref/project_id -- this PDF is Colour Memory-branded and can only render a house Colour Memory itself created and still holds, never one relayed back through the request body. Call house_specify, then pass the house_ref it returns in `house_ref` below instead. | |
| query | No | Optional title for the palette e.g. Ottoman imperial luxury | |
| source | No | Optional source label e.g. brand, conceptual | archive |
| entries | No | Array of colour cards. Either the flat entries array from query_hex/palette_concept, or report['presented_cards'] from archive_report_brief (single_cultivar, colour_family, and conservative-mode hero cards are all supported -- see tool description). Omit if using `sections` instead. EVIDENCE FIELDS ARE SERVER-VERIFIED: each entry's name+hex(+archive_source) must match a real archive record -- any claim_strength/primary_source/colour_notes/colour_basis/hex_confidence supplied here is ignored and replaced with Colour Memory's own record; a non-matching entry refuses the whole request. Requires a valid API key. | |
| delivery | No | 'url' (default): signed, time-limited R2 download link. 'base64': PDF bytes returned inline as pdf_base64 for callers that need the file directly. | |
| sections | No | Alternative to `entries` -- one entry per document section, e.g. house_specify's rooms. Each: {grouping_basis?, hero_hex?, entries: [...colour cards, server-verified exactly like the flat `entries` field above...]}. DO NOT include title/subtitle/rationale/application_notes -- this renderer cannot currently keep that requester free text cleanly separated from Colour Memory's own evidence, so any of them present REFUSES THE WHOLE REQUEST with 400 REQUESTER_FREE_TEXT_NOT_ALLOWED naming the field(s); a section with only `entries` still renders, with an auto-numbered heading. Requires a valid API key. | |
| house_ref | No | THE way to render the flagship document-plan publication -- the house_ref string house_specify's own response returns (valid for 30 minutes after that call, or per project_persistence for a durable/temporary project). Renders the identical flagship document without resending the house object over the wire, and without it ever being treated as caller-supplied evidence. Anonymous house_ref access needs no API key, unchanged; do not send `house` alongside it. | |
| project_id | No | Alternative to house_ref for an authenticated (keyed) caller's own durable project -- the project_id house_specify returned. Requires the same API key that created the project. | |
| presentation | No | Used with `sections` or `house_ref`/`project_id`. {template: 'sectioned_specification'|'colour_drenched_lookbook' (sections only), page_size?: 'A4-portrait'|'A4-landscape'|'16:9', minimum_colour_coverage?: number (default 0.55 for lookbook), source_display?: 'inline'|'appendix', max_body_words_per_page?: integer, min_body_font_pt?: number (default 10.5), min_label_font_pt?: number (default 9, swatch colour-name labels), min_citation_font_pt?: number (default 7.5, appendix citations and page furniture)}. No rendered text falls below its category's floor -- names that don't fit are truncated with an ellipsis, never shrunk past the floor. | |
| project_version | No | Used with either house_ref or project_id -- render this specific immutable version instead of the project's current version. Omit to render the current version. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||