[{"data":1,"prerenderedAt":823},["ShallowReactive",2],{"navigation_docs":3,"-recipients-png-api":104,"-recipients-png-api-surround":818},[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":67,"body":106,"description":811,"extension":812,"links":813,"meta":814,"navigation":815,"path":68,"seo":816,"stem":69,"__hash__":817},"docs\u002F4.recipients\u002F5.png-api.md",{"type":107,"value":108,"toc":801},"minimark",[109,113,130,133,138,154,158,202,206,420,445,449,455,535,543,547,699,703,710,719,723,749,753,797],[110,111,112],"p",{},"Render handwritten text as a PNG image.",[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","POST https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fgenerate\u002Fpng\n","http","",[121,122,123],"code",{"__ignoreMap":119},[124,125,128],"span",{"class":126,"line":127},"line",1,[124,129,117],{},[110,131,132],{},"This endpoint requires API-key authentication, the generate API enabled for your account, and an active Scribeless subscription. Preview and final renders are tracked as subscription usage.",[134,135,137],"h2",{"id":136},"headers","Headers",[114,139,141],{"className":116,"code":140,"language":118,"meta":119,"style":119},"Content-Type: application\u002Fjson\nX-API-Key: YOUR_API_KEY\n",[121,142,143,148],{"__ignoreMap":119},[124,144,145],{"class":126,"line":127},[124,146,147],{},"Content-Type: application\u002Fjson\n",[124,149,151],{"class":126,"line":150},2,[124,152,153],{},"X-API-Key: YOUR_API_KEY\n",[134,155,157],{"id":156},"query-parameters","Query parameters",[159,160,161,177],"table",{},[162,163,164],"thead",{},[165,166,167,171,174],"tr",{},[168,169,170],"th",{},"Parameter",[168,172,173],{},"Required",[168,175,176],{},"Description",[178,179,180],"tbody",{},[165,181,182,188,191],{},[183,184,185],"td",{},[121,186,187],{},"preview",[183,189,190],{},"No",[183,192,193,194,197,198,201],{},"Use ",[121,195,196],{},"true"," to generate a preview render. Defaults to ",[121,199,200],{},"false",".",[134,203,205],{"id":204},"request-body","Request body",[159,207,208,220],{},[162,209,210],{},[165,211,212,215,218],{},[168,213,214],{},"Field",[168,216,217],{},"Type",[168,219,176],{},[178,221,222,235,254,271,286,306,329,344,364,383,398],{},[165,223,224,229,232],{},[183,225,226],{},[121,227,228],{},"content",[183,230,231],{},"string",[183,233,234],{},"Required. Handwritten content. May include simple HTML such as paragraphs and line breaks.",[165,236,237,242,244],{},[183,238,239],{},[121,240,241],{},"width",[183,243,231],{},[183,245,246,247,250,251,201],{},"Optional. Output width with unit, for example ",[121,248,249],{},"152mm",". Defaults to ",[121,252,253],{},"100mm",[165,255,256,261,263],{},[183,257,258],{},[121,259,260],{},"height",[183,262,231],{},[183,264,265,266,250,269,201],{},"Optional. Output height with unit, for example ",[121,267,268],{},"102mm",[121,270,253],{},[165,272,273,278,280],{},[183,274,275],{},[121,276,277],{},"fontFamily",[183,279,231],{},[183,281,282,283,201],{},"Optional. Handwriting style. Defaults to ",[121,284,285],{},"Stafford",[165,287,288,293,295],{},[183,289,290],{},[121,291,292],{},"fontSize",[183,294,231],{},[183,296,297,298,301,302,305],{},"Optional. Font size with unit, for example ",[121,299,300],{},"15pt",". When ",[121,303,304],{},"autoResize"," is enabled, this is the maximum font size.",[165,307,308,313,315],{},[183,309,310],{},[121,311,312],{},"color",[183,314,231],{},[183,316,317,318,321,322,325,326,201],{},"Optional. ",[121,319,320],{},"black",", ",[121,323,324],{},"blue",", or ",[121,327,328],{},"darkBlue",[165,330,331,336,338],{},[183,332,333],{},[121,334,335],{},"padding",[183,337,231],{},[183,339,340,341,201],{},"Optional. Padding with unit. Defaults to ",[121,342,343],{},"1mm",[165,345,346,351,353],{},[183,347,348],{},[121,349,350],{},"textAlign",[183,352,231],{},[183,354,317,355,321,358,325,361,201],{},[121,356,357],{},"left",[121,359,360],{},"center",[121,362,363],{},"right",[165,365,366,371,373],{},[183,367,368],{},[121,369,370],{},"verticalAlign",[183,372,231],{},[183,374,317,375,321,378,325,380,201],{},[121,376,377],{},"top",[121,379,360],{},[121,381,382],{},"bottom",[165,384,385,390,392],{},[183,386,387],{},[121,388,389],{},"backgroundColor",[183,391,231],{},[183,393,394,395,201],{},"Optional. CSS background color. Defaults to ",[121,396,397],{},"transparent",[165,399,400,404,407],{},[183,401,402],{},[121,403,304],{},[183,405,406],{},"boolean",[183,408,409,410,301,412,414,415,417,418,201],{},"Optional. Defaults to ",[121,411,200],{},[121,413,196],{},", the renderer reduces the font size so the handwriting fits within the fixed ",[121,416,241],{}," and ",[121,419,260],{},[110,421,422,417,424,426,427,321,429,321,432,325,435,437,438,441,442,444],{},[121,423,241],{},[121,425,260],{}," must be explicit dimensions such as ",[121,428,249],{},[121,430,431],{},"6in",[121,433,434],{},"500px",[121,436,300],{},"; they do not accept ",[121,439,440],{},"auto",". Use ",[121,443,304],{}," when you need variable-length content to fit a fixed output size.",[134,446,448],{"id":447},"handwriting-styles","Handwriting styles",[110,450,451,452,454],{},"Use one of these case-sensitive ",[121,453,277],{}," values:",[159,456,457,464],{},[162,458,459],{},[165,460,461],{},[168,462,463],{},"Style",[178,465,466,473,480,487,494,501,508,515,522,529],{},[165,467,468],{},[183,469,470],{},[121,471,472],{},"Arthur",[165,474,475],{},[183,476,477],{},[121,478,479],{},"Carpenter",[165,481,482],{},[183,483,484],{},[121,485,486],{},"Foster",[165,488,489],{},[183,490,491],{},[121,492,493],{},"George",[165,495,496],{},[183,497,498],{},[121,499,500],{},"Grogan",[165,502,503],{},[183,504,505],{},[121,506,507],{},"Knowles",[165,509,510],{},[183,511,512],{},[121,513,514],{},"Nightingale",[165,516,517],{},[183,518,519],{},[121,520,521],{},"Robinson",[165,523,524],{},[183,525,526],{},[121,527,528],{},"Singh",[165,530,531],{},[183,532,533],{},[121,534,285],{},[110,536,537,538,540,541,201],{},"If you omit ",[121,539,277],{},", Scribeless uses ",[121,542,285],{},[134,544,546],{"id":545},"example-request","Example request",[114,548,552],{"className":549,"code":550,"language":551,"meta":119,"style":119},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --request POST 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fgenerate\u002Fpng?preview=true' \\\n  --header 'Content-Type: application\u002Fjson' \\\n  --header 'X-API-Key: YOUR_API_KEY' \\\n  --data '{\n    \"content\": \"\u003Cp>Hello from Scribeless\u003C\u002Fp>\",\n    \"width\": \"152mm\",\n    \"height\": \"102mm\",\n    \"fontFamily\": \"Stafford\",\n    \"fontSize\": \"15pt\",\n    \"color\": \"darkBlue\",\n    \"textAlign\": \"left\",\n    \"verticalAlign\": \"top\",\n    \"backgroundColor\": \"transparent\",\n    \"autoResize\": true\n  }' \\\n  --output handwriting.png\n","bash",[121,553,554,581,595,609,620,626,632,638,644,650,656,662,668,674,680,690],{"__ignoreMap":119},[124,555,556,560,564,567,571,574,577],{"class":126,"line":127},[124,557,559],{"class":558},"sBMFI","curl",[124,561,563],{"class":562},"sfazB"," --request",[124,565,566],{"class":562}," POST",[124,568,570],{"class":569},"sMK4o"," '",[124,572,573],{"class":562},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fgenerate\u002Fpng?preview=true",[124,575,576],{"class":569},"'",[124,578,580],{"class":579},"sTEyZ"," \\\n",[124,582,583,586,588,591,593],{"class":126,"line":150},[124,584,585],{"class":562},"  --header",[124,587,570],{"class":569},[124,589,590],{"class":562},"Content-Type: application\u002Fjson",[124,592,576],{"class":569},[124,594,580],{"class":579},[124,596,598,600,602,605,607],{"class":126,"line":597},3,[124,599,585],{"class":562},[124,601,570],{"class":569},[124,603,604],{"class":562},"X-API-Key: YOUR_API_KEY",[124,606,576],{"class":569},[124,608,580],{"class":579},[124,610,612,615,617],{"class":126,"line":611},4,[124,613,614],{"class":562},"  --data",[124,616,570],{"class":569},[124,618,619],{"class":562},"{\n",[124,621,623],{"class":126,"line":622},5,[124,624,625],{"class":562},"    \"content\": \"\u003Cp>Hello from Scribeless\u003C\u002Fp>\",\n",[124,627,629],{"class":126,"line":628},6,[124,630,631],{"class":562},"    \"width\": \"152mm\",\n",[124,633,635],{"class":126,"line":634},7,[124,636,637],{"class":562},"    \"height\": \"102mm\",\n",[124,639,641],{"class":126,"line":640},8,[124,642,643],{"class":562},"    \"fontFamily\": \"Stafford\",\n",[124,645,647],{"class":126,"line":646},9,[124,648,649],{"class":562},"    \"fontSize\": \"15pt\",\n",[124,651,653],{"class":126,"line":652},10,[124,654,655],{"class":562},"    \"color\": \"darkBlue\",\n",[124,657,659],{"class":126,"line":658},11,[124,660,661],{"class":562},"    \"textAlign\": \"left\",\n",[124,663,665],{"class":126,"line":664},12,[124,666,667],{"class":562},"    \"verticalAlign\": \"top\",\n",[124,669,671],{"class":126,"line":670},13,[124,672,673],{"class":562},"    \"backgroundColor\": \"transparent\",\n",[124,675,677],{"class":126,"line":676},14,[124,678,679],{"class":562},"    \"autoResize\": true\n",[124,681,683,686,688],{"class":126,"line":682},15,[124,684,685],{"class":562},"  }",[124,687,576],{"class":569},[124,689,580],{"class":579},[124,691,693,696],{"class":126,"line":692},16,[124,694,695],{"class":562},"  --output",[124,697,698],{"class":562}," handwriting.png\n",[134,700,702],{"id":701},"response","Response",[110,704,705,706,709],{},"The response is an ",[121,707,708],{},"image\u002Fpng"," binary.",[114,711,713],{"className":116,"code":712,"language":118,"meta":119,"style":119},"Content-Type: image\u002Fpng\n",[121,714,715],{"__ignoreMap":119},[124,716,717],{"class":126,"line":127},[124,718,712],{},[134,720,722],{"id":721},"notes","Notes",[724,725,726,733,739,742],"ul",{},[727,728,193,729,732],"li",{},[121,730,731],{},"preview=true"," while validating size, colour, style, and line breaks.",[727,734,735,736,738],{},"Enable ",[121,737,304],{}," for variable-length content, such as AI-generated notes, that must fit a fixed image size.",[727,740,741],{},"Store the returned PNG if you need to reuse it. Do not re-render the same text unnecessarily.",[727,743,744,745,748],{},"For campaign recipient creation, use ",[121,746,747],{},"POST \u002Fapi\u002Frecipients"," instead. This endpoint only renders a handwriting image.",[134,750,752],{"id":751},"errors","Errors",[159,754,755,765],{},[162,756,757],{},[165,758,759,762],{},[168,760,761],{},"Status",[168,763,764],{},"Meaning",[178,766,767,777,787],{},[165,768,769,774],{},[183,770,771],{},[121,772,773],{},"400",[183,775,776],{},"Invalid request body, including invalid dimensions or unsupported enum values.",[165,778,779,784],{},[183,780,781],{},[121,782,783],{},"401",[183,785,786],{},"Missing, malformed, revoked, or invalid API key.",[165,788,789,794],{},[183,790,791],{},[121,792,793],{},"500",[183,795,796],{},"No active subscription was found or rendering failed. Contact support if this persists.",[798,799,800],"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}",{"title":119,"searchDepth":150,"depth":150,"links":802},[803,804,805,806,807,808,809,810],{"id":136,"depth":150,"text":137},{"id":156,"depth":150,"text":157},{"id":204,"depth":150,"text":205},{"id":447,"depth":150,"text":448},{"id":545,"depth":150,"text":546},{"id":701,"depth":150,"text":702},{"id":721,"depth":150,"text":722},{"id":751,"depth":150,"text":752},"Render Scribeless handwriting text as a PNG.","md",null,{},true,{"title":67,"description":811},"YrMlKgTQUCLnUVVmot3tEBTd1d-cCgGkDEVYnu0waWQ",[819,821],{"title":63,"path":64,"stem":65,"description":820,"children":-1},"Create a Scribeless recipient from custom HTML.",{"title":76,"path":77,"stem":78,"description":822,"children":-1},"Provision a Scribeless customer team from an approved partner account.",1780671949162]