[{"data":1,"prerenderedAt":1047},["ShallowReactive",2],{"navigation":3,"\u002Freference\u002Faccount":80,"\u002Freference\u002Faccount-surround":1042},[4,30,60,75],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":6},"Getting Started",false,"\u002Fgetting-started","1.getting-started",[10,15,20,25],{"title":11,"path":12,"stem":13,"icon":14},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction","i-lucide-house",{"title":16,"path":17,"stem":18,"icon":19},"WordPress plugin","\u002Fgetting-started\u002Fwordpress-plugin","1.getting-started\u002F2.wordpress-plugin","i-lucide-download",{"title":21,"path":22,"stem":23,"icon":24},"API quickstart","\u002Fgetting-started\u002Fapi-quickstart","1.getting-started\u002F3.api-quickstart","i-lucide-terminal",{"title":26,"path":27,"stem":28,"icon":29},"FAQ","\u002Fgetting-started\u002Ffaq","1.getting-started\u002F4.faq","i-lucide-circle-help",{"title":31,"path":32,"stem":33,"children":34,"page":6},"Reference","\u002Freference","2.reference",[35,40,45,50,55],{"title":36,"path":37,"stem":38,"icon":39},"Optimize API","\u002Freference\u002Foptimize-api","2.reference\u002F1.optimize-api","i-lucide-image",{"title":41,"path":42,"stem":43,"icon":44},"Smart crop","\u002Freference\u002Fsmartcrop","2.reference\u002F2.smartcrop","i-lucide-crop",{"title":46,"path":47,"stem":48,"icon":49},"Job polling","\u002Freference\u002Fjobs","2.reference\u002F3.jobs","i-lucide-list-checks",{"title":51,"path":52,"stem":53,"icon":54},"Plans & limits","\u002Freference\u002Fplans-and-limits","2.reference\u002F4.plans-and-limits","i-lucide-credit-card",{"title":56,"path":57,"stem":58,"icon":59},"Account usage","\u002Freference\u002Faccount","2.reference\u002F5.account","i-lucide-gauge",{"title":61,"path":62,"stem":63,"children":64,"page":6},"AI","\u002Fai","3.ai",[65,70],{"title":66,"path":67,"stem":68,"icon":69},"AI alt text & SEO","\u002Fai\u002Falt-text-and-seo","3.ai\u002F1.alt-text-and-seo","i-lucide-sparkles",{"title":71,"path":72,"stem":73,"icon":74},"AI background removal","\u002Fai\u002Fbackground-removal","3.ai\u002F2.background-removal","i-lucide-scissors",{"title":76,"path":77,"stem":78,"icon":79},"Account API","\u002Faccount-api","4.account-api","i-lucide-key-round",{"id":81,"title":56,"body":82,"description":1035,"extension":1036,"links":1037,"meta":1038,"navigation":1039,"path":57,"seo":1040,"stem":58,"__hash__":1041},"docs\u002F2.reference\u002F5.account.md",{"type":83,"value":84,"toc":1024},"minimark",[85,89,94,111,149,153,158,403,407,432,557,561,569,688,692,927,950,954,961,965,1020],[86,87,88],"p",{},"Returns the current UTC-month usage for the website your API key belongs to,\nplus — on the Free plan — how close your account is to the monthly image\ncap.",[90,91,93],"h2",{"id":92},"request","Request",[95,96,101],"pre",{"className":97,"code":98,"language":99,"meta":100,"style":100},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GET \u002Fv1\u002Faccount\n","http","",[102,103,104],"code",{"__ignoreMap":100},[105,106,109],"span",{"class":107,"line":108},"line",1,[105,110,98],{},[95,112,117],{"className":113,"code":114,"filename":115,"language":116,"meta":100,"style":100},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl https:\u002F\u002Fapi.helloimg.io\u002Fv1\u002Faccount \\\n  -H \"Authorization: Bearer \u003Cyour API key>\"\n","Terminal","bash",[102,118,119,133],{"__ignoreMap":100},[105,120,121,125,129],{"class":107,"line":108},[105,122,124],{"class":123},"sBMFI","curl",[105,126,128],{"class":127},"sfazB"," https:\u002F\u002Fapi.helloimg.io\u002Fv1\u002Faccount",[105,130,132],{"class":131},"sTEyZ"," \\\n",[105,134,136,139,143,146],{"class":107,"line":135},2,[105,137,138],{"class":127},"  -H",[105,140,142],{"class":141},"sMK4o"," \"",[105,144,145],{"class":127},"Authorization: Bearer \u003Cyour API key>",[105,147,148],{"class":141},"\"\n",[90,150,152],{"id":151},"response","Response",[154,155,157],"h3",{"id":156},"free-plan","Free plan",[95,159,163],{"className":160,"code":161,"language":162,"meta":100,"style":100},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"plan\": \"free\",\n  \"month\": \"2026-08\",\n  \"website\": {\n    \"domain\": \"example.com\",\n    \"images\": 12,\n    \"bytes_saved\": 3456789\n  },\n  \"limit\": {\n    \"monthly_images\": 1000,\n    \"used\": 34,\n    \"remaining\": 966,\n    \"over_limit\": false,\n    \"resets_at\": \"2026-09-01T00:00:00Z\"\n  }\n}\n","json",[102,164,165,170,195,216,231,253,271,286,292,306,323,340,357,372,391,397],{"__ignoreMap":100},[105,166,167],{"class":107,"line":108},[105,168,169],{"class":141},"{\n",[105,171,172,175,179,182,185,187,190,192],{"class":107,"line":135},[105,173,174],{"class":141},"  \"",[105,176,178],{"class":177},"spNyl","plan",[105,180,181],{"class":141},"\"",[105,183,184],{"class":141},":",[105,186,142],{"class":141},[105,188,189],{"class":127},"free",[105,191,181],{"class":141},[105,193,194],{"class":141},",\n",[105,196,198,200,203,205,207,209,212,214],{"class":107,"line":197},3,[105,199,174],{"class":141},[105,201,202],{"class":177},"month",[105,204,181],{"class":141},[105,206,184],{"class":141},[105,208,142],{"class":141},[105,210,211],{"class":127},"2026-08",[105,213,181],{"class":141},[105,215,194],{"class":141},[105,217,219,221,224,226,228],{"class":107,"line":218},4,[105,220,174],{"class":141},[105,222,223],{"class":177},"website",[105,225,181],{"class":141},[105,227,184],{"class":141},[105,229,230],{"class":141}," {\n",[105,232,234,237,240,242,244,246,249,251],{"class":107,"line":233},5,[105,235,236],{"class":141},"    \"",[105,238,239],{"class":123},"domain",[105,241,181],{"class":141},[105,243,184],{"class":141},[105,245,142],{"class":141},[105,247,248],{"class":127},"example.com",[105,250,181],{"class":141},[105,252,194],{"class":141},[105,254,256,258,261,263,265,269],{"class":107,"line":255},6,[105,257,236],{"class":141},[105,259,260],{"class":123},"images",[105,262,181],{"class":141},[105,264,184],{"class":141},[105,266,268],{"class":267},"sbssI"," 12",[105,270,194],{"class":141},[105,272,274,276,279,281,283],{"class":107,"line":273},7,[105,275,236],{"class":141},[105,277,278],{"class":123},"bytes_saved",[105,280,181],{"class":141},[105,282,184],{"class":141},[105,284,285],{"class":267}," 3456789\n",[105,287,289],{"class":107,"line":288},8,[105,290,291],{"class":141},"  },\n",[105,293,295,297,300,302,304],{"class":107,"line":294},9,[105,296,174],{"class":141},[105,298,299],{"class":177},"limit",[105,301,181],{"class":141},[105,303,184],{"class":141},[105,305,230],{"class":141},[105,307,309,311,314,316,318,321],{"class":107,"line":308},10,[105,310,236],{"class":141},[105,312,313],{"class":123},"monthly_images",[105,315,181],{"class":141},[105,317,184],{"class":141},[105,319,320],{"class":267}," 1000",[105,322,194],{"class":141},[105,324,326,328,331,333,335,338],{"class":107,"line":325},11,[105,327,236],{"class":141},[105,329,330],{"class":123},"used",[105,332,181],{"class":141},[105,334,184],{"class":141},[105,336,337],{"class":267}," 34",[105,339,194],{"class":141},[105,341,343,345,348,350,352,355],{"class":107,"line":342},12,[105,344,236],{"class":141},[105,346,347],{"class":123},"remaining",[105,349,181],{"class":141},[105,351,184],{"class":141},[105,353,354],{"class":267}," 966",[105,356,194],{"class":141},[105,358,360,362,365,367,369],{"class":107,"line":359},13,[105,361,236],{"class":141},[105,363,364],{"class":123},"over_limit",[105,366,181],{"class":141},[105,368,184],{"class":141},[105,370,371],{"class":141}," false,\n",[105,373,375,377,380,382,384,386,389],{"class":107,"line":374},14,[105,376,236],{"class":141},[105,378,379],{"class":123},"resets_at",[105,381,181],{"class":141},[105,383,184],{"class":141},[105,385,142],{"class":141},[105,387,388],{"class":127},"2026-09-01T00:00:00Z",[105,390,148],{"class":141},[105,392,394],{"class":107,"line":393},15,[105,395,396],{"class":141},"  }\n",[105,398,400],{"class":107,"line":399},16,[105,401,402],{"class":141},"}\n",[154,404,406],{"id":405},"unlimited-unlimited-ai-and-reseller-ai","Unlimited, Unlimited + AI, and Reseller + AI",[86,408,409,410,412,413,416,417,419,420,423,424,427,428,431],{},"Same shape, but ",[102,411,299],{}," is always ",[102,414,415],{},"null"," — none of these plans have an\nimage cap. ",[102,418,178],{}," is ",[102,421,422],{},"\"unlimited\"",", ",[102,425,426],{},"\"unlimited_ai\"",", or ",[102,429,430],{},"\"reseller_ai\"","\nrespectively:",[95,433,435],{"className":160,"code":434,"language":162,"meta":100,"style":100},"{\n  \"plan\": \"unlimited\",\n  \"month\": \"2026-08\",\n  \"website\": {\n    \"domain\": \"example.com\",\n    \"images\": 41230,\n    \"bytes_saved\": 8912345671\n  },\n  \"limit\": null\n}\n",[102,436,437,441,460,478,490,508,523,536,540,553],{"__ignoreMap":100},[105,438,439],{"class":107,"line":108},[105,440,169],{"class":141},[105,442,443,445,447,449,451,453,456,458],{"class":107,"line":135},[105,444,174],{"class":141},[105,446,178],{"class":177},[105,448,181],{"class":141},[105,450,184],{"class":141},[105,452,142],{"class":141},[105,454,455],{"class":127},"unlimited",[105,457,181],{"class":141},[105,459,194],{"class":141},[105,461,462,464,466,468,470,472,474,476],{"class":107,"line":197},[105,463,174],{"class":141},[105,465,202],{"class":177},[105,467,181],{"class":141},[105,469,184],{"class":141},[105,471,142],{"class":141},[105,473,211],{"class":127},[105,475,181],{"class":141},[105,477,194],{"class":141},[105,479,480,482,484,486,488],{"class":107,"line":218},[105,481,174],{"class":141},[105,483,223],{"class":177},[105,485,181],{"class":141},[105,487,184],{"class":141},[105,489,230],{"class":141},[105,491,492,494,496,498,500,502,504,506],{"class":107,"line":233},[105,493,236],{"class":141},[105,495,239],{"class":123},[105,497,181],{"class":141},[105,499,184],{"class":141},[105,501,142],{"class":141},[105,503,248],{"class":127},[105,505,181],{"class":141},[105,507,194],{"class":141},[105,509,510,512,514,516,518,521],{"class":107,"line":255},[105,511,236],{"class":141},[105,513,260],{"class":123},[105,515,181],{"class":141},[105,517,184],{"class":141},[105,519,520],{"class":267}," 41230",[105,522,194],{"class":141},[105,524,525,527,529,531,533],{"class":107,"line":273},[105,526,236],{"class":141},[105,528,278],{"class":123},[105,530,181],{"class":141},[105,532,184],{"class":141},[105,534,535],{"class":267}," 8912345671\n",[105,537,538],{"class":107,"line":288},[105,539,291],{"class":141},[105,541,542,544,546,548,550],{"class":107,"line":294},[105,543,174],{"class":141},[105,545,299],{"class":177},[105,547,181],{"class":141},[105,549,184],{"class":141},[105,551,552],{"class":141}," null\n",[105,554,555],{"class":107,"line":308},[105,556,402],{"class":141},[154,558,560],{"id":559},"older-api-keys","Older API keys",[86,562,563,564,568],{},"A ",[565,566,567],"strong",{},"legacy"," key — one issued before self-service, per-website key\nmanagement existed — returns a simpler shape: no website or limit details,\njust the key's own usage.",[95,570,572],{"className":160,"code":571,"language":162,"meta":100,"style":100},"{\n  \"plan\": \"legacy\",\n  \"month\": \"2026-08\",\n  \"website\": null,\n  \"usage\": {\n    \"images\": 512,\n    \"bytes_saved\": 91234567\n  },\n  \"limit\": null\n}\n",[102,573,574,578,596,614,627,640,655,668,672,684],{"__ignoreMap":100},[105,575,576],{"class":107,"line":108},[105,577,169],{"class":141},[105,579,580,582,584,586,588,590,592,594],{"class":107,"line":135},[105,581,174],{"class":141},[105,583,178],{"class":177},[105,585,181],{"class":141},[105,587,184],{"class":141},[105,589,142],{"class":141},[105,591,567],{"class":127},[105,593,181],{"class":141},[105,595,194],{"class":141},[105,597,598,600,602,604,606,608,610,612],{"class":107,"line":197},[105,599,174],{"class":141},[105,601,202],{"class":177},[105,603,181],{"class":141},[105,605,184],{"class":141},[105,607,142],{"class":141},[105,609,211],{"class":127},[105,611,181],{"class":141},[105,613,194],{"class":141},[105,615,616,618,620,622,624],{"class":107,"line":218},[105,617,174],{"class":141},[105,619,223],{"class":177},[105,621,181],{"class":141},[105,623,184],{"class":141},[105,625,626],{"class":141}," null,\n",[105,628,629,631,634,636,638],{"class":107,"line":233},[105,630,174],{"class":141},[105,632,633],{"class":177},"usage",[105,635,181],{"class":141},[105,637,184],{"class":141},[105,639,230],{"class":141},[105,641,642,644,646,648,650,653],{"class":107,"line":255},[105,643,236],{"class":141},[105,645,260],{"class":123},[105,647,181],{"class":141},[105,649,184],{"class":141},[105,651,652],{"class":267}," 512",[105,654,194],{"class":141},[105,656,657,659,661,663,665],{"class":107,"line":273},[105,658,236],{"class":141},[105,660,278],{"class":123},[105,662,181],{"class":141},[105,664,184],{"class":141},[105,666,667],{"class":267}," 91234567\n",[105,669,670],{"class":107,"line":288},[105,671,291],{"class":141},[105,673,674,676,678,680,682],{"class":107,"line":294},[105,675,174],{"class":141},[105,677,299],{"class":177},[105,679,181],{"class":141},[105,681,184],{"class":141},[105,683,552],{"class":141},[105,685,686],{"class":107,"line":308},[105,687,402],{"class":141},[90,689,691],{"id":690},"fields","Fields",[693,694,695,711],"table",{},[696,697,698],"thead",{},[699,700,701,705,708],"tr",{},[702,703,704],"th",{},"Field",[702,706,707],{},"Type",[702,709,710],{},"Description",[712,713,714,743,757,772,784,797,809,830,843,855,871,889,910],"tbody",{},[699,715,716,721,724],{},[717,718,719],"td",{},[102,720,178],{},[717,722,723],{},"string",[717,725,726,423,728,423,730,423,733,427,736,738,739,742],{},[102,727,189],{},[102,729,455],{},[102,731,732],{},"unlimited_ai",[102,734,735],{},"reseller_ai",[102,737,567],{}," — see ",[740,741,51],"a",{"href":52},".",[699,744,745,749,751],{},[717,746,747],{},[102,748,202],{},[717,750,723],{},[717,752,753,754,742],{},"The UTC calendar month these numbers cover, as ",[102,755,756],{},"YYYY-MM",[699,758,759,763,766],{},[717,760,761],{},[102,762,223],{},[717,764,765],{},"object | null",[717,767,768,769,771],{},"The website your API key belongs to. ",[102,770,415],{}," for a legacy key — no website is on file for it.",[699,773,774,779,781],{},[717,775,776],{},[102,777,778],{},"website.domain",[717,780,723],{},[717,782,783],{},"The website's domain.",[699,785,786,791,794],{},[717,787,788],{},[102,789,790],{},"website.images",[717,792,793],{},"number",[717,795,796],{},"Images processed this month, summed across every active key on this website (a website can have up to 2).",[699,798,799,804,806],{},[717,800,801],{},[102,802,803],{},"website.bytes_saved",[717,805,793],{},[717,807,808],{},"Total bytes saved this month for this website.",[699,810,811,815,818],{},[717,812,813],{},[102,814,633],{},[717,816,817],{},"object",[717,819,820,821,823,824,826,827,829],{},"Legacy keys only — the same ",[102,822,260],{}," \u002F ",[102,825,278],{}," shape as ",[102,828,223],{},", for the key itself.",[699,831,832,836,838],{},[717,833,834],{},[102,835,299],{},[717,837,765],{},[717,839,840,842],{},[102,841,415],{}," on every plan except Free — no other plan has an image cap.",[699,844,845,850,852],{},[717,846,847],{},[102,848,849],{},"limit.monthly_images",[717,851,793],{},[717,853,854],{},"The Free plan's monthly image cap (1,000).",[699,856,857,862,864],{},[717,858,859],{},[102,860,861],{},"limit.used",[717,863,793],{},[717,865,866,867,870],{},"Images processed this month, across your ",[565,868,869],{},"whole account"," — every website, not just this one. See the callout below.",[699,872,873,878,880],{},[717,874,875],{},[102,876,877],{},"limit.remaining",[717,879,793],{},[717,881,882,885,886,742],{},[102,883,884],{},"monthly_images - used",", floored at ",[102,887,888],{},"0",[699,890,891,896,899],{},[717,892,893],{},[102,894,895],{},"limit.over_limit",[717,897,898],{},"boolean",[717,900,901,904,905,907,908,742],{},[102,902,903],{},"true"," once ",[102,906,330],{}," reaches ",[102,909,313],{},[699,911,912,917,919],{},[717,913,914],{},[102,915,916],{},"limit.resets_at",[717,918,723],{},[717,920,921,922,924,925,742],{},"ISO 8601 timestamp for the start of next UTC month, when ",[102,923,330],{}," resets to ",[102,926,888],{},[928,929,930],"callout",{},[86,931,932,934,935,938,939,941,942,945,946,949],{},[102,933,861],{}," is your ",[565,936,937],{},"account's"," total, not just this website's — the Free\nplan's 1,000-image cap is shared across every website on the account, while\n",[102,940,790],{}," reports only this one site. A Free-plan account with two\nwebsites could see ",[102,943,944],{},"website.images: 12"," here and ",[102,947,948],{},"limit.used: 340"," if the\nother website processed the rest.",[90,951,953],{"id":952},"caching","Caching",[86,955,956,957,960],{},"The response is cached for ",[565,958,959],{},"up to 60 seconds"," per API key — a burst of\ncalls right after processing a batch of images may not reflect the very\nlatest count immediately.",[90,962,964],{"id":963},"errors","Errors",[693,966,967,980],{},[696,968,969],{},[699,970,971,974,977],{},[702,972,973],{},"Status",[702,975,976],{},"Body",[702,978,979],{},"Cause",[712,981,982,1005],{},[699,983,984,989,994],{},[717,985,986],{},[102,987,988],{},"401",[717,990,991],{},[102,992,993],{},"{ \"error\": \"invalid api key\" }",[717,995,996,997,1000,1001,1004],{},"Missing or malformed ",[102,998,999],{},"Authorization"," header. Applies to every ",[102,1002,1003],{},"\u002Fv1\u002F*"," route — one shared check in front of all of them.",[699,1006,1007,1012,1017],{},[717,1008,1009],{},[102,1010,1011],{},"503",[717,1013,1014],{},[102,1015,1016],{},"{ \"error\": \"usage unavailable\" }",[717,1018,1019],{},"Usage data is temporarily unavailable. Retry shortly.",[1021,1022,1023],"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 .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}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":100,"searchDepth":108,"depth":135,"links":1025},[1026,1027,1032,1033,1034],{"id":92,"depth":135,"text":93},{"id":151,"depth":135,"text":152,"children":1028},[1029,1030,1031],{"id":156,"depth":197,"text":157},{"id":405,"depth":197,"text":406},{"id":559,"depth":197,"text":560},{"id":690,"depth":135,"text":691},{"id":952,"depth":135,"text":953},{"id":963,"depth":135,"text":964},"GET \u002Fv1\u002Faccount — current-month usage for your API key's website, and (Free plan) how close you are to the monthly cap.","md",null,{},{"icon":59},{"title":56,"description":1035},"NarBE2pz8QrRR3OrO1-n81p2xAkK7A7b6UOr6uIQOlU",[1043,1045],{"title":51,"path":52,"stem":53,"description":1044,"icon":54,"children":-1},"Free, Unlimited, and Unlimited + AI — what each plan includes.",{"title":66,"path":67,"stem":68,"description":1046,"icon":69,"children":-1},"POST \u002Fv1\u002Fai\u002Fseo — generate alt text, captions, descriptions, and titles from an image URL.",1787466466329]