[{"data":1,"prerenderedAt":512},["ShallowReactive",2],{"navigation_docs":3,"-getting-started-authentication":104,"-getting-started-authentication-surround":507},[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":14,"body":106,"description":500,"extension":501,"links":502,"meta":503,"navigation":504,"path":15,"seo":505,"stem":16,"__hash__":506},"docs\u002F1.getting-started\u002F2.authentication.md",{"type":107,"value":108,"toc":494},"minimark",[109,118,129,134,159,175,179,197,201,356,360,363,475,490],[110,111,112,113,117],"p",{},"The platform API uses the ",[114,115,116],"code",{},"X-API-Key"," header for authentication.",[110,119,120,121,128],{},"Generate an API key in ",[122,123,127],"a",{"href":124,"rel":125},"https:\u002F\u002Fplatform.scribeless.co\u002Fsettings#\u002Fapi-keys",[126],"nofollow","Scribeless API key settings",", then include it with every request.",[130,131,133],"h2",{"id":132},"create-an-api-key","Create an API key",[135,136,137,146,153,156],"ol",{},[138,139,140,141,145],"li",{},"Open ",[122,142,144],{"href":124,"rel":143},[126],"Settings > API keys",".",[138,147,148,149,145],{},"Select ",[150,151,152],"strong",{},"Create API Key",[138,154,155],{},"Copy the key immediately. Scribeless only shows the secret once.",[138,157,158],{},"Store it in your server-side secrets manager or automation platform credential store.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","X-API-Key: YOUR_API_KEY\n","http","",[114,167,168],{"__ignoreMap":165},[169,170,173],"span",{"class":171,"line":172},"line",1,[169,174,163],{},[130,176,178],{"id":177},"api-key-handling","API key handling",[180,181,182,185,191,194],"ul",{},[138,183,184],{},"Keep API keys server-side. Do not expose them in browsers, mobile apps, public repositories, or client-side JavaScript.",[138,186,187,188,145],{},"Use environment variables or a secrets manager, for example ",[114,189,190],{},"SCRIBELESS_API_KEY",[138,192,193],{},"Rotate the key if it may have been exposed.",[138,195,196],{},"If the secret is lost, create a new key.",[130,198,200],{"id":199},"example","Example",[160,202,206],{"className":203,"code":204,"language":205,"meta":165,"style":165},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --request POST 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients' \\\n  --header 'Content-Type: application\u002Fjson' \\\n  --header 'X-API-Key: YOUR_API_KEY' \\\n  --data '{\n    \"campaignId\": \"CAMPAIGN_ID\",\n    \"data\": {\n      \"firstName\": \"Ada\",\n      \"lastName\": \"Lovelace\",\n      \"address\": {\n        \"address1\": \"1 Example Street\",\n        \"city\": \"London\",\n        \"state\": \"London\",\n        \"postalCode\": \"SW1A 1AA\",\n        \"country\": \"GB\"\n      }\n    }\n  }'\n","bash",[114,207,208,235,250,264,275,281,287,293,299,305,311,317,323,329,335,341,347],{"__ignoreMap":165},[169,209,210,214,218,221,225,228,231],{"class":171,"line":172},[169,211,213],{"class":212},"sBMFI","curl",[169,215,217],{"class":216},"sfazB"," --request",[169,219,220],{"class":216}," POST",[169,222,224],{"class":223},"sMK4o"," '",[169,226,227],{"class":216},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients",[169,229,230],{"class":223},"'",[169,232,234],{"class":233},"sTEyZ"," \\\n",[169,236,238,241,243,246,248],{"class":171,"line":237},2,[169,239,240],{"class":216},"  --header",[169,242,224],{"class":223},[169,244,245],{"class":216},"Content-Type: application\u002Fjson",[169,247,230],{"class":223},[169,249,234],{"class":233},[169,251,253,255,257,260,262],{"class":171,"line":252},3,[169,254,240],{"class":216},[169,256,224],{"class":223},[169,258,259],{"class":216},"X-API-Key: YOUR_API_KEY",[169,261,230],{"class":223},[169,263,234],{"class":233},[169,265,267,270,272],{"class":171,"line":266},4,[169,268,269],{"class":216},"  --data",[169,271,224],{"class":223},[169,273,274],{"class":216},"{\n",[169,276,278],{"class":171,"line":277},5,[169,279,280],{"class":216},"    \"campaignId\": \"CAMPAIGN_ID\",\n",[169,282,284],{"class":171,"line":283},6,[169,285,286],{"class":216},"    \"data\": {\n",[169,288,290],{"class":171,"line":289},7,[169,291,292],{"class":216},"      \"firstName\": \"Ada\",\n",[169,294,296],{"class":171,"line":295},8,[169,297,298],{"class":216},"      \"lastName\": \"Lovelace\",\n",[169,300,302],{"class":171,"line":301},9,[169,303,304],{"class":216},"      \"address\": {\n",[169,306,308],{"class":171,"line":307},10,[169,309,310],{"class":216},"        \"address1\": \"1 Example Street\",\n",[169,312,314],{"class":171,"line":313},11,[169,315,316],{"class":216},"        \"city\": \"London\",\n",[169,318,320],{"class":171,"line":319},12,[169,321,322],{"class":216},"        \"state\": \"London\",\n",[169,324,326],{"class":171,"line":325},13,[169,327,328],{"class":216},"        \"postalCode\": \"SW1A 1AA\",\n",[169,330,332],{"class":171,"line":331},14,[169,333,334],{"class":216},"        \"country\": \"GB\"\n",[169,336,338],{"class":171,"line":337},15,[169,339,340],{"class":216},"      }\n",[169,342,344],{"class":171,"line":343},16,[169,345,346],{"class":216},"    }\n",[169,348,350,353],{"class":171,"line":349},17,[169,351,352],{"class":216},"  }",[169,354,355],{"class":223},"'\n",[130,357,359],{"id":358},"errors","Errors",[110,361,362],{},"If an API key is missing, malformed, or invalid, Scribeless returns an authentication error.",[160,364,368],{"className":365,"code":366,"language":367,"meta":165,"style":165},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"error\": true,\n  \"url\": \"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Ftemplates\",\n  \"statusCode\": 401,\n  \"statusMessage\": \"Server Error\",\n  \"message\": \"Invalid authentication token.\"\n}\n","json",[114,369,370,374,392,414,431,451,470],{"__ignoreMap":165},[169,371,372],{"class":171,"line":172},[169,373,274],{"class":223},[169,375,376,379,383,386,389],{"class":171,"line":237},[169,377,378],{"class":223},"  \"",[169,380,382],{"class":381},"spNyl","error",[169,384,385],{"class":223},"\"",[169,387,388],{"class":223},":",[169,390,391],{"class":223}," true,\n",[169,393,394,396,399,401,403,406,409,411],{"class":171,"line":252},[169,395,378],{"class":223},[169,397,398],{"class":381},"url",[169,400,385],{"class":223},[169,402,388],{"class":223},[169,404,405],{"class":223}," \"",[169,407,408],{"class":216},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Ftemplates",[169,410,385],{"class":223},[169,412,413],{"class":223},",\n",[169,415,416,418,421,423,425,429],{"class":171,"line":266},[169,417,378],{"class":223},[169,419,420],{"class":381},"statusCode",[169,422,385],{"class":223},[169,424,388],{"class":223},[169,426,428],{"class":427},"sbssI"," 401",[169,430,413],{"class":223},[169,432,433,435,438,440,442,444,447,449],{"class":171,"line":277},[169,434,378],{"class":223},[169,436,437],{"class":381},"statusMessage",[169,439,385],{"class":223},[169,441,388],{"class":223},[169,443,405],{"class":223},[169,445,446],{"class":216},"Server Error",[169,448,385],{"class":223},[169,450,413],{"class":223},[169,452,453,455,458,460,462,464,467],{"class":171,"line":283},[169,454,378],{"class":223},[169,456,457],{"class":381},"message",[169,459,385],{"class":223},[169,461,388],{"class":223},[169,463,405],{"class":223},[169,465,466],{"class":216},"Invalid authentication token.",[169,468,469],{"class":223},"\"\n",[169,471,472],{"class":171,"line":289},[169,473,474],{"class":223},"}\n",[110,476,477,478,481,482,485,486,145],{},"If Scribeless returns ",[114,479,480],{},"503",", API traffic may be temporarily elevated. The service is usually operational within five minutes. If the outage persists, or you receive another ",[114,483,484],{},"5xx"," error, contact ",[122,487,489],{"href":488},"mailto:team@scribeless.co","team@scribeless.co",[491,492,493],"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}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":165,"searchDepth":237,"depth":237,"links":495},[496,497,498,499],{"id":132,"depth":237,"text":133},{"id":177,"depth":237,"text":178},{"id":199,"depth":237,"text":200},{"id":358,"depth":237,"text":359},"Authenticate Scribeless API requests with X-API-Key.","md",null,{},true,{"title":14,"description":500},"3WpO_xW6l5w8sxmOHkQR1OG5nWt-qpHPVr60tFQIydc",[508,510],{"title":10,"path":11,"stem":12,"description":509,"children":-1},"Learn what the Scribeless API is for.",{"title":18,"path":19,"stem":20,"description":511,"children":-1},"Prepare a Scribeless campaign before sending recipients through the API.",1780671947975]