[{"data":1,"prerenderedAt":458},["ShallowReactive",2],{"api-index":3},{"article":4,"sections":417},{"id":5,"title":6,"avatar":7,"body":8,"description":407,"docx":7,"extension":408,"meta":409,"navigation":410,"order":411,"path":412,"pdf":7,"pdfLabel":7,"procurementPack":7,"seo":413,"slug":414,"stem":415,"__hash__":416},"content\u002Fapi\u002Findex.md","API Overview",null,{"type":9,"value":10,"toc":392},"minimark",[11,16,20,25,60,64,69,78,82,125,129,176,180,183,191,195,245,248,252,255,259,307,311,358,362,388],[12,13,15],"h1",{"id":14},"headshotpro-api","HeadshotPro API",[17,18,19],"p",{},"Welcome to the HeadshotPro API documentation. Our API allows you to programmatically manage your organization's AI headshot generation workflow.",[21,22,24],"h2",{"id":23},"what-you-can-do","What you can do",[26,27,28,36,42,48,54],"ul",{},[29,30,31,35],"li",{},[32,33,34],"strong",{},"Invite team members"," - Send invitations and track their progress",[29,37,38,41],{},[32,39,40],{},"Manage teams"," - Create and organize teams within your organization",[29,43,44,47],{},[32,45,46],{},"Access headshots"," - Retrieve generated photos and favorites",[29,49,50,53],{},[32,51,52],{},"Monitor credits"," - Track your organization's credit balance",[29,55,56,59],{},[32,57,58],{},"Whitelabel integration"," - Embed HeadshotPro into your own application",[21,61,63],{"id":62},"quick-start","Quick Start",[65,66,68],"h3",{"id":67},"_1-get-your-api-key","1. Get your API key",[17,70,71,72,77],{},"Generate an API key from your ",[73,74,76],"a",{"href":75},"\u002Fapp\u002Fadmin\u002Fapi","organization settings",".",[65,79,81],{"id":80},"_2-make-your-first-request","2. Make your first request",[83,84,89],"pre",{"className":85,"code":86,"language":87,"meta":88,"style":88},"language-bash shiki shiki-themes dark-plus","curl -X GET \"https:\u002F\u002Fserver.headshotpro.com\u002Fapi\u002Fv2\u002Forganization\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"\n","bash","",[90,91,92,116],"code",{"__ignoreMap":88},[93,94,97,101,105,109,112],"span",{"class":95,"line":96},"line",1,[93,98,100],{"class":99},"sCudf","curl",[93,102,104],{"class":103},"scz_3"," -X",[93,106,108],{"class":107},"sKc5r"," GET",[93,110,111],{"class":107}," \"https:\u002F\u002Fserver.headshotpro.com\u002Fapi\u002Fv2\u002Forganization\"",[93,113,115],{"class":114},"svVle"," \\\n",[93,117,119,122],{"class":95,"line":118},2,[93,120,121],{"class":103},"  -H",[93,123,124],{"class":107}," \"Authorization: Bearer YOUR_API_KEY\"\n",[65,126,128],{"id":127},"_3-invite-a-team-member","3. Invite a team member",[83,130,132],{"className":85,"code":131,"language":87,"meta":88,"style":88},"curl -X POST \"https:\u002F\u002Fserver.headshotpro.com\u002Fapi\u002Fv2\u002Forganization\u002Finvites\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"email\": \"user@example.com\"}'\n",[90,133,134,148,157,167],{"__ignoreMap":88},[93,135,136,138,140,143,146],{"class":95,"line":96},[93,137,100],{"class":99},[93,139,104],{"class":103},[93,141,142],{"class":107}," POST",[93,144,145],{"class":107}," \"https:\u002F\u002Fserver.headshotpro.com\u002Fapi\u002Fv2\u002Forganization\u002Finvites\"",[93,147,115],{"class":114},[93,149,150,152,155],{"class":95,"line":118},[93,151,121],{"class":103},[93,153,154],{"class":107}," \"Authorization: Bearer YOUR_API_KEY\"",[93,156,115],{"class":114},[93,158,160,162,165],{"class":95,"line":159},3,[93,161,121],{"class":103},[93,163,164],{"class":107}," \"Content-Type: application\u002Fjson\"",[93,166,115],{"class":114},[93,168,170,173],{"class":95,"line":169},4,[93,171,172],{"class":103},"  -d",[93,174,175],{"class":107}," '{\"email\": \"user@example.com\"}'\n",[21,177,179],{"id":178},"base-url","Base URL",[17,181,182],{},"All API requests should be made to:",[83,184,189],{"className":185,"code":187,"language":188},[186],"language-text","https:\u002F\u002Fserver.headshotpro.com\u002Fapi\u002Fv2\n","text",[90,190,187],{"__ignoreMap":88},[21,192,194],{"id":193},"api-versions","API Versions",[196,197,198,213],"table",{},[199,200,201],"thead",{},[202,203,204,208,211],"tr",{},[205,206,207],"th",{},"Version",[205,209,210],{},"Status",[205,212,179],{},[214,215,216,232],"tbody",{},[202,217,218,222,227],{},[219,220,221],"td",{},"V2",[219,223,224],{},[32,225,226],{},"Current",[219,228,229],{},[90,230,231],{},"\u002Fapi\u002Fv2\u002Forganization\u002F...",[202,233,234,237,240],{},[219,235,236],{},"V1",[219,238,239],{},"Legacy",[219,241,242],{},[90,243,244],{},"\u002Fapi\u002Fv1\u002Forganization\u002F...",[17,246,247],{},"We recommend using V2 for all new integrations. V1 endpoints remain available for backwards compatibility.",[21,249,251],{"id":250},"response-format","Response Format",[17,253,254],{},"All responses are JSON with a consistent structure:",[65,256,258],{"id":257},"success-response","Success Response",[83,260,264],{"className":261,"code":262,"language":263,"meta":88,"style":88},"language-json shiki shiki-themes dark-plus","{\n  \"success\": true,\n  \"data\": { ... }\n}\n","json",[90,265,266,272,287,302],{"__ignoreMap":88},[93,267,268],{"class":95,"line":96},[93,269,271],{"class":270},"sTNBD","{\n",[93,273,274,278,281,284],{"class":95,"line":118},[93,275,277],{"class":276},"s3F5K","  \"success\"",[93,279,280],{"class":270},": ",[93,282,283],{"class":103},"true",[93,285,286],{"class":270},",\n",[93,288,289,292,295,299],{"class":95,"line":159},[93,290,291],{"class":276},"  \"data\"",[93,293,294],{"class":270},": { ",[93,296,298],{"class":297},"sHkYM","...",[93,300,301],{"class":270}," }\n",[93,303,304],{"class":95,"line":169},[93,305,306],{"class":270},"}\n",[65,308,310],{"id":309},"error-response","Error Response",[83,312,314],{"className":261,"code":313,"language":263,"meta":88,"style":88},"{\n  \"success\": false,\n  \"error\": \"Error message\",\n  \"code\": \"ERROR_CODE\"\n}\n",[90,315,316,320,331,343,353],{"__ignoreMap":88},[93,317,318],{"class":95,"line":96},[93,319,271],{"class":270},[93,321,322,324,326,329],{"class":95,"line":118},[93,323,277],{"class":276},[93,325,280],{"class":270},[93,327,328],{"class":103},"false",[93,330,286],{"class":270},[93,332,333,336,338,341],{"class":95,"line":159},[93,334,335],{"class":276},"  \"error\"",[93,337,280],{"class":270},[93,339,340],{"class":107},"\"Error message\"",[93,342,286],{"class":270},[93,344,345,348,350],{"class":95,"line":169},[93,346,347],{"class":276},"  \"code\"",[93,349,280],{"class":270},[93,351,352],{"class":107},"\"ERROR_CODE\"\n",[93,354,356],{"class":95,"line":355},5,[93,357,306],{"class":270},[21,359,361],{"id":360},"need-help","Need Help?",[26,363,364,372,380],{},[29,365,366,367,371],{},"Check our ",[73,368,370],{"href":369},"\u002Fapi\u002Ferrors","error codes"," for troubleshooting",[29,373,374,375,379],{},"Review ",[73,376,378],{"href":377},"\u002Fapi\u002Frate-limits","rate limits"," for usage guidelines",[29,381,382,383,387],{},"Contact ",[73,384,386],{"href":385},"mailto:support@headshotpro.com","support@headshotpro.com"," for assistance",[389,390,391],"style",{},"html pre.shiki code .sCudf, html code.shiki .sCudf{--shiki-default:#DCDCAA}html pre.shiki code .scz_3, html code.shiki .scz_3{--shiki-default:#569CD6}html pre.shiki code .sKc5r, html code.shiki .sKc5r{--shiki-default:#CE9178}html pre.shiki code .svVle, html code.shiki .svVle{--shiki-default:#D7BA7D}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 pre.shiki code .sTNBD, html code.shiki .sTNBD{--shiki-default:#D4D4D4}html pre.shiki code .s3F5K, html code.shiki .s3F5K{--shiki-default:#9CDCFE}html pre.shiki code .sHkYM, html code.shiki .sHkYM{--shiki-default:#F44747}",{"title":88,"searchDepth":118,"depth":118,"links":393},[394,395,400,401,402,406],{"id":23,"depth":118,"text":24},{"id":62,"depth":118,"text":63,"children":396},[397,398,399],{"id":67,"depth":159,"text":68},{"id":80,"depth":159,"text":81},{"id":127,"depth":159,"text":128},{"id":178,"depth":118,"text":179},{"id":193,"depth":118,"text":194},{"id":250,"depth":118,"text":251,"children":403},[404,405],{"id":257,"depth":159,"text":258},{"id":309,"depth":159,"text":310},{"id":360,"depth":118,"text":361},"HeadshotPro API documentation - Programmatically manage AI headshots for your organization","md",{},true,0,"\u002Fapi",{"title":6,"description":407},"index","api\u002Findex","0ESre1Z8KvSD-XNaYjfCA9F72mm1STN6_sRd6lj__oI",[418,419,422,425,428,431,434,438,442,446,450,454],{"title":6,"slug":414,"order":411},{"title":420,"slug":421,"order":96},"Authentication","authentication",{"title":423,"slug":424,"order":118},"Organization","organization",{"title":426,"slug":427,"order":159},"Invites","invites",{"title":429,"slug":430,"order":169},"Teams","teams",{"title":432,"slug":433,"order":355},"Team Members","team-members",{"title":435,"slug":436,"order":437},"Models","models",6,{"title":439,"slug":440,"order":441},"Photos","photos",7,{"title":443,"slug":444,"order":445},"Whitelabel","whitelabel",8,{"title":447,"slug":448,"order":449},"Errors","errors",9,{"title":451,"slug":452,"order":453},"Rate Limits","rate-limits",10,{"title":455,"slug":456,"order":457},"Webhooks","webhooks",11,1793086559336]