[{"data":1,"prerenderedAt":587},["ShallowReactive",2],{"navigation_docs":3,"-recipients-fetch-recipient-preview":104,"-recipients-fetch-recipient-preview-surround":582},[4,26,32,45,70,87],{"title":5,"path":6,"stem":7,"children":8,"page":25},"Getting Started","\u002Fgetting-started","1.getting-started",[9,13,17,21],{"title":10,"path":11,"stem":12},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":14,"path":15,"stem":16},"Authentication","\u002Fgetting-started\u002Fauthentication","1.getting-started\u002F2.authentication",{"title":18,"path":19,"stem":20},"Campaign setup","\u002Fgetting-started\u002Fcampaigns","1.getting-started\u002F3.campaigns",{"title":22,"path":23,"stem":24},"AI agent skills","\u002Fgetting-started\u002Fai-agent-skills","1.getting-started\u002F4.ai-agent-skills",false,{"title":27,"path":28,"stem":29,"children":30},"Templates","\u002Ftemplates","2.templates\u002Findex",[31],{"title":27,"path":28,"stem":29},{"title":33,"path":34,"stem":35,"children":36,"page":25},"Campaigns","\u002Fcampaigns","3.campaigns",[37,41],{"title":38,"path":39,"stem":40},"Create campaign","\u002Fcampaigns\u002Fcreate-campaign","3.campaigns\u002F1.create-campaign",{"title":42,"path":43,"stem":44},"Fetch campaign","\u002Fcampaigns\u002Ffetch-campaign","3.campaigns\u002F2.fetch-campaign",{"title":46,"path":47,"stem":48,"children":49,"page":25},"Recipients","\u002Frecipients","4.recipients",[50,54,58,62,66],{"title":51,"path":52,"stem":53},"Create recipients","\u002Frecipients\u002Fcreate-recipients","4.recipients\u002F1.create-recipients",{"title":55,"path":56,"stem":57},"Fetch recipient","\u002Frecipients\u002Ffetch-recipient","4.recipients\u002F2.fetch-recipient",{"title":59,"path":60,"stem":61},"Fetch recipient preview","\u002Frecipients\u002Ffetch-recipient-preview","4.recipients\u002F3.fetch-recipient-preview",{"title":63,"path":64,"stem":65},"Create HTML recipient","\u002Frecipients\u002Fcreate-html-recipient","4.recipients\u002F4.create-html-recipient",{"title":67,"path":68,"stem":69},"PNG API","\u002Frecipients\u002Fpng-api","4.recipients\u002F5.png-api",{"title":71,"path":72,"stem":73,"children":74,"page":25},"Partner Workflows","\u002Fpartner-workflows","5.partner-workflows",[75,79,83],{"title":76,"path":77,"stem":78},"Create partner team","\u002Fpartner-workflows\u002Fcreate-partner-team","5.partner-workflows\u002F1.create-partner-team",{"title":80,"path":81,"stem":82},"Account status","\u002Fpartner-workflows\u002Faccount-status","5.partner-workflows\u002F2.account-status",{"title":84,"path":85,"stem":86},"Checkout recipients","\u002Fpartner-workflows\u002Fcheckout-recipients","5.partner-workflows\u002F3.checkout-recipients",{"title":88,"path":89,"stem":90,"children":91,"page":25},"Webhooks","\u002Fwebhooks","6.webhooks",[92,96,100],{"title":93,"path":94,"stem":95},"Overview","\u002Fwebhooks\u002Foverview","6.webhooks\u002F0.overview",{"title":97,"path":98,"stem":99},"Manage subscriptions","\u002Fwebhooks\u002Fmanage-subscriptions","6.webhooks\u002F1.manage-subscriptions",{"title":101,"path":102,"stem":103},"QR scan events","\u002Fwebhooks\u002Fqr-code-scans","6.webhooks\u002F2.qr-code-scans",{"id":105,"title":59,"body":106,"description":575,"extension":576,"links":577,"meta":578,"navigation":579,"path":60,"seo":580,"stem":61,"__hash__":581},"docs\u002F4.recipients\u002F3.fetch-recipient-preview.md",{"type":107,"value":108,"toc":567},"minimark",[109,113,130,135,144,148,184,188,251,258,262,317,321,324,361,364,467,470,479,492,496,563],[110,111,112],"p",{},"Download a rendered PNG preview when your integration needs to show or store the generated recipient artwork.",[114,115,120],"pre",{"className":116,"code":117,"language":118,"meta":119,"style":119},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GET https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002F{recipientId}\u002Fpreview\n","http","",[121,122,123],"code",{"__ignoreMap":119},[124,125,128],"span",{"class":126,"line":127},"line",1,[124,129,117],{},[131,132,134],"h2",{"id":133},"headers","Headers",[114,136,138],{"className":116,"code":137,"language":118,"meta":119,"style":119},"X-API-Key: YOUR_API_KEY\n",[121,139,140],{"__ignoreMap":119},[124,141,142],{"class":126,"line":127},[124,143,137],{},[131,145,147],{"id":146},"path-parameters","Path parameters",[149,150,151,167],"table",{},[152,153,154],"thead",{},[155,156,157,161,164],"tr",{},[158,159,160],"th",{},"Parameter",[158,162,163],{},"Type",[158,165,166],{},"Description",[168,169,170],"tbody",{},[155,171,172,178,181],{},[173,174,175],"td",{},[121,176,177],{},"recipientId",[173,179,180],{},"string",[173,182,183],{},"Scribeless recipient ID.",[131,185,187],{"id":186},"query-parameters","Query parameters",[149,189,190,203],{},[152,191,192],{},[155,193,194,196,198,201],{},[158,195,160],{},[158,197,163],{},[158,199,200],{},"Required",[158,202,166],{},[168,204,205,232],{},[155,206,207,212,214,217],{},[173,208,209],{},[121,210,211],{},"type",[173,213,180],{},[173,215,216],{},"Yes",[173,218,219,220,223,224,227,228,231],{},"Document type to preview. One of ",[121,221,222],{},"note",", ",[121,225,226],{},"postcard",", or ",[121,229,230],{},"envelope",".",[155,233,234,239,242,245],{},[173,235,236],{},[121,237,238],{},"page",[173,240,241],{},"number",[173,243,244],{},"No",[173,246,247,248,231],{},"Zero-indexed page number. Defaults to ",[121,249,250],{},"0",[110,252,253,254,257],{},"The preview endpoint downloads PNG previews. Do not send a ",[121,255,256],{},"format"," parameter.",[131,259,261],{"id":260},"example-request","Example request",[114,263,267],{"className":264,"code":265,"language":266,"meta":119,"style":119},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --location 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002FRECIPIENT_ID\u002Fpreview?type=postcard&page=0' \\\n  --header 'X-API-Key: YOUR_API_KEY' \\\n  --output preview.png\n","bash",[121,268,269,293,308],{"__ignoreMap":119},[124,270,271,275,279,283,286,289],{"class":126,"line":127},[124,272,274],{"class":273},"sBMFI","curl",[124,276,278],{"class":277},"sfazB"," --location",[124,280,282],{"class":281},"sMK4o"," '",[124,284,285],{"class":277},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002FRECIPIENT_ID\u002Fpreview?type=postcard&page=0",[124,287,288],{"class":281},"'",[124,290,292],{"class":291},"sTEyZ"," \\\n",[124,294,296,299,301,304,306],{"class":126,"line":295},2,[124,297,298],{"class":277},"  --header",[124,300,282],{"class":281},[124,302,303],{"class":277},"X-API-Key: YOUR_API_KEY",[124,305,288],{"class":281},[124,307,292],{"class":291},[124,309,311,314],{"class":126,"line":310},3,[124,312,313],{"class":277},"  --output",[124,315,316],{"class":277}," preview.png\n",[131,318,320],{"id":319},"finding-the-right-preview","Finding the right preview",[110,322,323],{},"Create-recipient responses do not include preview URLs. To fetch a preview:",[325,326,327,331,340,358],"ol",{},[328,329,330],"li",{},"Create the recipient.",[328,332,333,334,231],{},"Fetch the recipient with ",[335,336,337],"a",{"href":56},[121,338,339],{},"GET \u002Fapi\u002Frecipients\u002F{recipientId}",[328,341,342,343,346,347,350,351,354,355,231],{},"Check that ",[121,344,345],{},"is_rendered"," is ",[121,348,349],{},"true"," and find a ",[121,352,353],{},"documents"," entry with ",[121,356,357],{},"format: \"preview\"",[328,359,360],{},"Use the document type and page number with this preview endpoint.",[110,362,363],{},"For a preview document like this:",[114,365,369],{"className":366,"code":367,"language":368,"meta":119,"style":119},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"format\": \"preview\",\n  \"src\": \"teams\u002FTEAM_ID\u002Fcampaigns\u002FCAMPAIGN_ID\u002Frecipients\u002FRECIPIENT_ID\u002Fpostcard-1.png\",\n  \"document\": {\n    \"type\": \"postcard\"\n  }\n}\n","json",[121,370,371,376,401,421,436,455,461],{"__ignoreMap":119},[124,372,373],{"class":126,"line":127},[124,374,375],{"class":281},"{\n",[124,377,378,381,384,387,390,393,396,398],{"class":126,"line":295},[124,379,380],{"class":281},"  \"",[124,382,256],{"class":383},"spNyl",[124,385,386],{"class":281},"\"",[124,388,389],{"class":281},":",[124,391,392],{"class":281}," \"",[124,394,395],{"class":277},"preview",[124,397,386],{"class":281},[124,399,400],{"class":281},",\n",[124,402,403,405,408,410,412,414,417,419],{"class":126,"line":310},[124,404,380],{"class":281},[124,406,407],{"class":383},"src",[124,409,386],{"class":281},[124,411,389],{"class":281},[124,413,392],{"class":281},[124,415,416],{"class":277},"teams\u002FTEAM_ID\u002Fcampaigns\u002FCAMPAIGN_ID\u002Frecipients\u002FRECIPIENT_ID\u002Fpostcard-1.png",[124,418,386],{"class":281},[124,420,400],{"class":281},[124,422,424,426,429,431,433],{"class":126,"line":423},4,[124,425,380],{"class":281},[124,427,428],{"class":383},"document",[124,430,386],{"class":281},[124,432,389],{"class":281},[124,434,435],{"class":281}," {\n",[124,437,439,442,444,446,448,450,452],{"class":126,"line":438},5,[124,440,441],{"class":281},"    \"",[124,443,211],{"class":273},[124,445,386],{"class":281},[124,447,389],{"class":281},[124,449,392],{"class":281},[124,451,226],{"class":277},[124,453,454],{"class":281},"\"\n",[124,456,458],{"class":126,"line":457},6,[124,459,460],{"class":281},"  }\n",[124,462,464],{"class":126,"line":463},7,[124,465,466],{"class":281},"}\n",[110,468,469],{},"Call:",[114,471,473],{"className":116,"code":472,"language":118,"meta":119,"style":119},"GET \u002Fapi\u002Frecipients\u002FRECIPIENT_ID\u002Fpreview?type=postcard&page=0\n",[121,474,475],{"__ignoreMap":119},[124,476,477],{"class":126,"line":127},[124,478,472],{},[110,480,481,482,484,485,488,489,231],{},"The ",[121,483,238],{}," query parameter is zero-indexed, so ",[121,486,487],{},"postcard-1.png"," is fetched with ",[121,490,491],{},"page=0",[131,493,495],{"id":494},"status-codes","Status codes",[149,497,498,508],{},[152,499,500],{},[155,501,502,505],{},[158,503,504],{},"Status",[158,506,507],{},"Meaning",[168,509,510,520,533,543,553],{},[155,511,512,517],{},[173,513,514],{},[121,515,516],{},"200",[173,518,519],{},"Preview PNG downloaded.",[155,521,522,527],{},[173,523,524],{},[121,525,526],{},"400",[173,528,529,530,532],{},"Missing or invalid ",[121,531,211],{}," query parameter.",[155,534,535,540],{},[173,536,537],{},[121,538,539],{},"401",[173,541,542],{},"Missing, malformed, invalid, or unauthorized API key.",[155,544,545,550],{},[173,546,547],{},[121,548,549],{},"404",[173,551,552],{},"Recipient, document type, or preview page not found. The recipient may not have rendered yet.",[155,554,555,560],{},[173,556,557],{},[121,558,559],{},"500",[173,561,562],{},"Preview could not be fetched. Retry or contact support if it persists.",[564,565,566],"style",{},"html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}",{"title":119,"searchDepth":295,"depth":295,"links":568},[569,570,571,572,573,574],{"id":133,"depth":295,"text":134},{"id":146,"depth":295,"text":147},{"id":186,"depth":295,"text":187},{"id":260,"depth":295,"text":261},{"id":319,"depth":295,"text":320},{"id":494,"depth":295,"text":495},"Download a rendered PNG preview for a Scribeless recipient.","md",null,{},true,{"title":59,"description":575},"poRO3z9h2mBGdHVjUPwPvZ3WvsQdlJqfoueihNiwIPQ",[583,585],{"title":55,"path":56,"stem":57,"description":584,"children":-1},"Get a Scribeless recipient by ID.",{"title":63,"path":64,"stem":65,"description":586,"children":-1},"Create a Scribeless recipient from custom HTML.",1780671948964]