[{"data":1,"prerenderedAt":261},["ShallowReactive",2],{"navigation_docs":3,"-getting-started-introduction":104,"-getting-started-introduction-surround":258},[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":10,"body":106,"description":251,"extension":252,"links":253,"meta":254,"navigation":255,"path":11,"seo":256,"stem":12,"__hash__":257},"docs\u002F1.getting-started\u002F1.introduction.md",{"type":107,"value":108,"toc":244},"minimark",[109,113,116,138,143,182,186,202,206,229,233,240],[110,111,112],"p",{},"The Scribeless API lets you create campaigns, add recipients, render handwriting assets, and create custom HTML mail pieces from your own systems.",[110,114,115],{},"Use it when you need to:",[117,118,119,123,126,129,132,135],"ul",{},[120,121,122],"li",{},"Create a campaign.",[120,124,125],{},"Add one or more recipients to a campaign.",[120,127,128],{},"Pass recipient address fields and custom variables into a campaign.",[120,130,131],{},"Render handwriting as a PNG.",[120,133,134],{},"Create a custom HTML recipient when your system generates the mail-piece artwork.",[120,136,137],{},"Receive webhook events when a generated Smart QR code is scanned.",[139,140,142],"h2",{"id":141},"before-you-start","Before you start",[144,145,146,157,160,168,171,179],"ol",{},[120,147,148,149,156],{},"Sign in to ",[150,151,155],"a",{"href":152,"rel":153},"https:\u002F\u002Fplatform.scribeless.co",[154],"nofollow","platform.scribeless.co",".",[120,158,159],{},"Set up your team.",[120,161,162,163,156],{},"Create an API key in ",[150,164,167],{"href":165,"rel":166},"https:\u002F\u002Fplatform.scribeless.co\u002Fsettings#\u002Fapi-keys",[154],"Settings > API keys",[120,169,170],{},"For standard recipient creation, create the Scribeless campaign you want to send recipients to, then use its campaign ID.",[120,172,173,174,178],{},"For custom HTML recipients, choose the ",[175,176,177],"code",{},"product_key"," for the mail format.",[120,180,181],{},"Include your API key with each request.",[139,183,185],{"id":184},"base-url","Base URL",[187,188,193],"pre",{"className":189,"code":190,"language":191,"meta":192,"style":192},"language-txt shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","https:\u002F\u002Fplatform.scribeless.co\u002Fapi\n","txt","",[175,194,195],{"__ignoreMap":192},[196,197,200],"span",{"class":198,"line":199},"line",1,[196,201,190],{},[139,203,205],{"id":204},"related-help-center-articles","Related Help Center articles",[117,207,208,215,222],{},[120,209,210],{},[150,211,214],{"href":212,"rel":213},"https:\u002F\u002Fhelp.scribeless.co\u002Fen\u002Farticles\u002F14896353-send-postcards-with-the-scribeless-api",[154],"Send postcards with the Scribeless API",[120,216,217],{},[150,218,221],{"href":219,"rel":220},"https:\u002F\u002Fhelp.scribeless.co\u002Fen\u002Farticles\u002F8800702-developers",[154],"Developers",[120,223,224],{},[150,225,228],{"href":226,"rel":227},"https:\u002F\u002Fhelp.scribeless.co\u002Fen\u002Farticles\u002F8800855-campaign-recipient-statuses",[154],"Campaign and recipient statuses",[139,230,232],{"id":231},"need-help","Need help?",[110,234,235,236,156],{},"Email ",[150,237,239],{"href":238},"mailto:team@scribeless.co","team@scribeless.co",[241,242,243],"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);}",{"title":192,"searchDepth":245,"depth":245,"links":246},2,[247,248,249,250],{"id":141,"depth":245,"text":142},{"id":184,"depth":245,"text":185},{"id":204,"depth":245,"text":205},{"id":231,"depth":245,"text":232},"Learn what the Scribeless API is for.","md",null,{},true,{"title":10,"description":251},"PZEwYxSWHUMf368mgT9IOGNrxuDpnHFeVMGZSM_rWmw",[253,259],{"title":14,"path":15,"stem":16,"description":260,"children":-1},"Authenticate Scribeless API requests with X-API-Key.",1780671947975]