[{"data":1,"prerenderedAt":1049},["ShallowReactive",2],{"/docs-api":3},{"id":4,"title":5,"body":6,"description":17,"extension":1040,"meta":1041,"navigation":1044,"path":1045,"seo":1046,"stem":1047,"__hash__":1048},"content/docs-api.md","URL scheme API",{"type":7,"value":8,"toc":998},"minimark",[9,18,23,26,29,35,38,43,47,137,141,237,284,329,375,421,512,550,554,623,627,712,716,754,774,778,798,818,838,842,872,876,897,917,921],[10,11,12],"p",{},[13,14,17],"span",{"className":15},[16],"lead","Our macOS app exposes actions that let pro users and developers of other apps send commands to CleanShot. This page explains how it works.",[19,20,22],"h2",{"id":21},"overview","Overview",[10,24,25],{},"URL scheme is a special type of link that works just like a normal https:// link you use every day. Instead of opening a webpage, it performs a specific action in the CleanShot macOS app.",[10,27,28],{},"Commands are sent to CleanShot by constructing a special URL:",[10,30,31],{},[32,33,34],"code",{},"cleanshot://command-name?parameter1=value1&parameter2=value2",[10,36,37],{},"Opening these links will launch the app and execute the command. For example, here's how you would tell CleanShot to take a fullscreen screenshot:",[10,39,40],{},[32,41,42],{},"cleanshot://capture-fullscreen",[19,44,46],{"id":45},"all-in-one-mode","✨  All-In-One mode",[48,49,50,55,58,61,98,101,106,109,114],"info-box",{},[51,52,54],"h3",{"id":53},"all-in-one","/all-in-one",[10,56,57],{},"Launch the \"All-In-One\" mode. You can also provide the optional parameters to open the tool at specific location. Point (0,0) is located in the lower left corner of the screen.",[10,59,60],{},"Parameters:",[62,63,64,71,79,85,91],"ul",{},[65,66,67,70],"li",{},[13,68,69],{},"x"," (optional) ",[65,72,73,78],{},[13,74,77],{"className":75},[76],"monospace","y"," (optional)",[65,80,81,78],{},[13,82,84],{"className":83},[76],"width",[65,86,87,78],{},[13,88,90],{"className":89},[76],"height",[65,92,93,97],{},[13,94,96],{"className":95},[76],"display"," (optional) - Capture a specified display: 1 is the main display, 2 is the secondary, etc. If not specified, CleanShot will use the display which the cursor is on.",[10,99,100],{},"Example:",[10,102,103],{},[32,104,105],{},"cleanshot://all-in-one",[10,107,108],{},"or",[10,110,111],{},[32,112,113],{},"cleanshot://all-in-one?x=100&y=120&width=200&height=150&display=1",[115,116,118],"template",{"v-slot:note":117},"",[10,119,120,121,123,124,123,127,123,130,123,133,136],{},"Requires CleanShot 4.2 or later. Parameters ",[13,122,69],{},", ",[13,125,77],{"className":126},[76],[13,128,84],{"className":129},[76],[13,131,90],{"className":132},[76],[13,134,96],{"className":135},[76]," require version 4.7 or later.",[19,138,140],{"id":139},"screenshots","📸  Screenshots",[48,142,143,147,150,152,207,209,214,216,221,223,228],{},[51,144,146],{"id":145},"capture-area","/capture-area",[10,148,149],{},"Opens the standard \"Capture Area\" mode. You can also provide the optional parameters and capture the screen instantly. Point (0,0) is located in the lower left corner of the screen.",[10,151,60],{},[62,153,154,158,163,168,173,178],{},[65,155,156,70],{},[13,157,69],{},[65,159,160,78],{},[13,161,77],{"className":162},[76],[65,164,165,78],{},[13,166,84],{"className":167},[76],[65,169,170,78],{},[13,171,90],{"className":172},[76],[65,174,175,97],{},[13,176,96],{"className":177},[76],[65,179,180,184,185,189,190,189,194,189,198,189,202,206],{},[13,181,183],{"className":182},[76],"action"," (optional) - Perform a specific action after taking a screenshot: (",[13,186,188],{"className":187},[76],"copy","/",[13,191,193],{"className":192},[76],"save",[13,195,197],{"className":196},[76],"annotate",[13,199,201],{"className":200},[76],"upload",[13,203,205],{"className":204},[76],"pin",").",[10,208,100],{},[10,210,211],{},[32,212,213],{},"cleanshot://capture-area",[10,215,108],{},[10,217,218],{},[32,219,220],{},"cleanshot://capture-area?action=annotate",[10,222,108],{},[10,224,225],{},[32,226,227],{},"cleanshot://capture-area?x=100&y=120&width=200&height=150&display=1",[115,229,230],{"v-slot:note":117},[10,231,232,233,236],{},"Requires CleanShot 3.5.1 or later. Parameter ",[13,234,183],{"className":235},[76]," requires version 4.7 or later.",[48,238,239,243,246,248,270,272,277],{},[51,240,242],{"id":241},"capture-previous-area","/capture-previous-area",[10,244,245],{},"Repeats last taken screenshot.",[10,247,60],{},[62,249,250],{},[65,251,252,184,254,189,257,189,260,189,263,189,266,269],{},[13,253,183],{},[13,255,188],{"className":256},[76],[13,258,193],{"className":259},[76],[13,261,197],{"className":262},[76],[13,264,201],{"className":265},[76],[13,267,205],{"className":268},[76],")",[10,271,100],{},[10,273,274],{},[32,275,276],{},"cleanshot://capture-previous-area",[115,278,279],{"v-slot:note":117},[10,280,232,281,236],{},[13,282,183],{"className":283},[76],[48,285,286,290,293,295,316,318,322],{},[51,287,289],{"id":288},"capture-fullscreen","/capture-fullscreen",[10,291,292],{},"Takes a fullscreen screenshot.",[10,294,60],{},[62,296,297],{},[65,298,299,184,301,189,304,189,307,189,310,189,313,269],{},[13,300,183],{},[13,302,188],{"className":303},[76],[13,305,193],{"className":306},[76],[13,308,197],{"className":309},[76],[13,311,201],{"className":312},[76],[13,314,205],{"className":315},[76],[10,317,100],{},[10,319,320],{},[32,321,42],{},[115,323,324],{"v-slot:note":117},[10,325,232,326,236],{},[13,327,183],{"className":328},[76],[48,330,331,335,338,340,361,363,368],{},[51,332,334],{"id":333},"capture-window","/capture-window",[10,336,337],{},"Opens \"Capture Window\" mode.",[10,339,60],{},[62,341,342],{},[65,343,344,184,346,189,349,189,352,189,355,189,358,269],{},[13,345,183],{},[13,347,188],{"className":348},[76],[13,350,193],{"className":351},[76],[13,353,197],{"className":354},[76],[13,356,201],{"className":357},[76],[13,359,205],{"className":360},[76],[10,362,100],{},[10,364,365],{},[32,366,367],{},"cleanshot://capture-window",[115,369,370],{"v-slot:note":117},[10,371,232,372,236],{},[13,373,183],{"className":374},[76],[48,376,377,381,384,386,407,409,414],{},[51,378,380],{"id":379},"self-timer","/self-timer",[10,382,383],{},"Opens \"Capture Area\" mode with self-timer.",[10,385,60],{},[62,387,388],{},[65,389,390,184,392,189,395,189,398,189,401,189,404,269],{},[13,391,183],{},[13,393,188],{"className":394},[76],[13,396,193],{"className":397},[76],[13,399,197],{"className":400},[76],[13,402,201],{"className":403},[76],[13,405,205],{"className":406},[76],[10,408,100],{},[10,410,411],{},[32,412,413],{},"cleanshot://self-timer",[115,415,416],{"v-slot:note":117},[10,417,232,418,236],{},[13,419,183],{"className":420},[76],[48,422,423,427,430,432,486,488,493,495,500],{},[51,424,426],{"id":425},"scrolling-capture","/scrolling-capture",[10,428,429],{},"Opens \"Scrolling Capture\" mode. You can also provide the optional parameters to open the tool at specific location. Point (0,0) is located in the lower left corner of the screen.",[10,431,60],{},[62,433,434,438,443,448,453,458,473],{},[65,435,436,70],{},[13,437,69],{},[65,439,440,78],{},[13,441,77],{"className":442},[76],[65,444,445,78],{},[13,446,84],{"className":447},[76],[65,449,450,78],{},[13,451,90],{"className":452},[76],[65,454,455,97],{},[13,456,96],{"className":457},[76],[65,459,460,464,465,189,469,269],{},[13,461,463],{"className":462},[76],"start"," (optional) - Automatically start capture (",[13,466,468],{"className":467},[76],"true",[13,470,472],{"className":471},[76],"false",[65,474,475,479,480,189,483,269],{},[13,476,478],{"className":477},[76],"autoscroll"," (optional) - Enable auto-scroll mode (",[13,481,468],{"className":482},[76],[13,484,472],{"className":485},[76],[10,487,100],{},[10,489,490],{},[32,491,492],{},"cleanshot://scrolling-capture",[10,494,108],{},[10,496,497],{},[32,498,499],{},"cleanshot://scrolling-capture?x=100&y=120&width=200&height=150&start=true&autoscroll=true",[115,501,502],{"v-slot:note":117},[10,503,504,505,508,509,136],{},"Requires CleanShot 3.5.1 or later. Parameters ",[13,506,463],{"className":507},[76]," and ",[13,510,478],{"className":511},[76],[48,513,514,517,520,522,531,533,538,540,545],{},[51,515,516],{"id":205},"/pin",[10,518,519],{},"Opens the specified file as a pinned screenshot.",[10,521,60],{},[62,523,524],{},[65,525,526,530],{},[13,527,529],{"className":528},[76],"filepath"," (optional) - path to the file (PNG/JPEG) you want to pin. If you don’t pass this parameter, CleanShot will ask to select the file manually.",[10,532,100],{},[10,534,535],{},[32,536,537],{},"cleanshot://pin",[10,539,108],{},[10,541,542],{},[32,543,544],{},"cleanshot://pin?filepath=/Users/john/Desktop/my%20screenshot.png",[115,546,547],{"v-slot:note":117},[10,548,549],{},"Requires CleanShot 3.5.1 or later.",[19,551,553],{"id":552},"screen-recording","🎥  Screen Recording",[48,555,556,560,563,565,591,593,598,600,605],{},[51,557,559],{"id":558},"record-screen","/record-screen",[10,561,562],{},"Opens \"Record Screen\" mode. You can also provide the optional parameters to open the tool at specific location. Point (0,0) is located in the lower left corner of the screen.",[10,564,60],{},[62,566,567,571,576,581,586],{},[65,568,569,70],{},[13,570,69],{},[65,572,573,78],{},[13,574,77],{"className":575},[76],[65,577,578,78],{},[13,579,84],{"className":580},[76],[65,582,583,78],{},[13,584,90],{"className":585},[76],[65,587,588,97],{},[13,589,96],{"className":590},[76],[10,592,100],{},[10,594,595],{},[32,596,597],{},"cleanshot://record-screen",[10,599,108],{},[10,601,602],{},[32,603,604],{},"cleanshot://record-screen?x=100&y=120&width=200&height=150&display=1",[115,606,607],{"v-slot:note":117},[10,608,504,609,123,611,123,614,123,617,123,620,136],{},[13,610,69],{},[13,612,77],{"className":613},[76],[13,615,84],{"className":616},[76],[13,618,90],{"className":619},[76],[13,621,96],{"className":622},[76],[19,624,626],{"id":625},"text-recognition","📖  Text Recognition",[48,628,629,633,636,638,686,688,693,695,700,702,707],{},[51,630,632],{"id":631},"capture-text","/capture-text",[10,634,635],{},"Opens Text Recognition (OCR) tool or extracts text from the specified file. You can also provide the optional parameters (x, y, width, height, display) and capture the text from a specified area on screen. Point (0,0) is located in the lower left corner of the screen.",[10,637,60],{},[62,639,640,646,650,655,660,665,671],{},[65,641,642,645],{},[13,643,529],{"className":644},[76]," (optional) - path to the image file (PNG/JPEG) that contains the text you want to extract.",[65,647,648,70],{},[13,649,69],{},[65,651,652,78],{},[13,653,77],{"className":654},[76],[65,656,657,78],{},[13,658,84],{"className":659},[76],[65,661,662,78],{},[13,663,90],{"className":664},[76],[65,666,667,670],{},[13,668,96],{"className":669},[76]," (optional) - Capture a specified display: 1 is the main display, 2 is the secondary, etc. If not specified, CleanShot will use the display which the cursor is on",[65,672,673,677,678,681,682,685],{},[13,674,676],{"className":675},[76],"linebreaks"," (optional) - Keep (",[13,679,468],{"className":680},[76],") or remove (",[13,683,472],{"className":684},[76],") line breaks from copied text",[10,687,100],{},[10,689,690],{},[32,691,692],{},"cleanshot://capture-text",[10,694,108],{},[10,696,697],{},[32,698,699],{},"cleanshot://capture-text?filepath=/Users/john/Desktop/my%20screenshot.png",[10,701,108],{},[10,703,704],{},[32,705,706],{},"cleanshot://capture-text?x=100&y=120&width=200&height=150&display=1",[115,708,709],{"v-slot:note":117},[10,710,711],{},"Requires CleanShot 3.8.1 and macOS 10.15 or later.",[19,713,715],{"id":714},"️annotate","✏️  Annotate",[48,717,718,722,725,727,735,737,742,744,749],{},[51,719,721],{"id":720},"open-annotate","/open-annotate",[10,723,724],{},"Opens specified file in Annotate.",[10,726,60],{},[62,728,729],{},[65,730,731,734],{},[13,732,529],{"className":733},[76]," (optional) - path to the image (PNG/JPEG) you want to open. If you don’t pass this parameter, CleanShot will ask to select the file manually.",[10,736,100],{},[10,738,739],{},[32,740,741],{},"cleanshot://open-annotate",[10,743,108],{},[10,745,746],{},[32,747,748],{},"cleanshot://open-annotate?filepath=/Users/john/Desktop/my%20screenshot.png",[115,750,751],{"v-slot:note":117},[10,752,753],{},"Requires CleanShot 3.8.1 or later.",[48,755,756,760,763,765,770],{},[51,757,759],{"id":758},"open-from-clipboard","/open-from-clipboard",[10,761,762],{},"Opens the image from clipboard in Annotate.",[10,764,100],{},[10,766,767],{},[32,768,769],{},"cleanshot://open-from-clipboard",[115,771,772],{"v-slot:note":117},[10,773,549],{},[19,775,777],{"id":776},"desktop-icons","🖥  Desktop icons",[48,779,780,784,787,789,794],{},[51,781,783],{"id":782},"toggle-desktop-icons","/toggle-desktop-icons",[10,785,786],{},"Toggles Desktop icons visibility.",[10,788,100],{},[10,790,791],{},[32,792,793],{},"cleanshot://toggle-desktop-icons",[115,795,796],{"v-slot:note":117},[10,797,549],{},[48,799,800,804,807,809,814],{},[51,801,803],{"id":802},"hide-desktop-icons","/hide-desktop-icons",[10,805,806],{},"Hides Desktop icons.",[10,808,100],{},[10,810,811],{},[32,812,813],{},"cleanshot://hide-desktop-icons",[115,815,816],{"v-slot:note":117},[10,817,753],{},[48,819,820,824,827,829,834],{},[51,821,823],{"id":822},"show-desktop-icons","/show-desktop-icons",[10,825,826],{},"Shows Desktop icons.",[10,828,100],{},[10,830,831],{},[32,832,833],{},"cleanshot://show-desktop-icons",[115,835,836],{"v-slot:note":117},[10,837,753],{},[19,839,841],{"id":840},"️quick-access-overlay","⚡️  Quick Access Overlay",[48,843,844,848,851,853,861,863,868],{},[51,845,847],{"id":846},"add-quick-access-overlay","/add-quick-access-overlay",[10,849,850],{},"Opens a new Quick Access Overlay with the specified image or video.",[10,852,60],{},[62,854,855],{},[65,856,857,860],{},[13,858,529],{"className":859},[76]," (required) - path to the image or video (PNG/JPEG/MP4) you want to open.",[10,862,100],{},[10,864,865],{},[32,866,867],{},"cleanshot://add-quick-access-overlay?filepath=/Users/john/Desktop/my%20screenshot.png",[115,869,870],{"v-slot:note":117},[10,871,753],{},[19,873,875],{"id":874},"history-management","⏳  History management",[48,877,878,882,885,887,892],{},[51,879,881],{"id":880},"open-history","/open-history",[10,883,884],{},"Opens capture history.",[10,886,100],{},[10,888,889],{},[32,890,891],{},"cleanshot://open-history",[115,893,894],{"v-slot:note":117},[10,895,896],{},"Requires CleanShot 4.4 or later.",[48,898,899,903,906,908,913],{},[51,900,902],{"id":901},"restore-recently-closed","/restore-recently-closed",[10,904,905],{},"Restores the most recently closed file from history.",[10,907,100],{},[10,909,910],{},[32,911,912],{},"cleanshot://restore-recently-closed",[115,914,915],{"v-slot:note":117},[10,916,549],{},[19,918,920],{"id":919},"️settings","⚙️  Settings",[48,922,923,927,930,932,979,981,986,988,993],{},[51,924,926],{"id":925},"open-settings","/open-settings",[10,928,929],{},"Opens CleanShot settings. You can also specify the tab to open.",[10,931,60],{},[62,933,934],{},[65,935,936,940,941,123,945,123,949,123,953,123,957,123,961,123,964,123,967,123,971,123,975],{},[13,937,939],{"className":938},[76],"tab"," (optional) - Specify the tab to open. Possible values: ",[13,942,944],{"className":943},[76],"general",[13,946,948],{"className":947},[76],"wallpaper",[13,950,952],{"className":951},[76],"shortcuts",[13,954,956],{"className":955},[76],"quickaccess",[13,958,960],{"className":959},[76],"recording",[13,962,139],{"className":963},[76],[13,965,197],{"className":966},[76],[13,968,970],{"className":969},[76],"cloud",[13,972,974],{"className":973},[76],"advanced",[13,976,978],{"className":977},[76],"about",[10,980,100],{},[10,982,983],{},[32,984,985],{},"cleanshot://open-settings",[10,987,108],{},[10,989,990],{},[32,991,992],{},"cleanshot://open-settings?tab=recording",[115,994,995],{"v-slot:note":117},[10,996,997],{},"Requires CleanShot 4.7 or later.",{"title":117,"searchDepth":999,"depth":999,"links":1000},2,[1001,1002,1006,1015,1018,1021,1025,1030,1033,1037],{"id":21,"depth":999,"text":22},{"id":45,"depth":999,"text":46,"children":1003},[1004],{"id":53,"depth":1005,"text":54},3,{"id":139,"depth":999,"text":140,"children":1007},[1008,1009,1010,1011,1012,1013,1014],{"id":145,"depth":1005,"text":146},{"id":241,"depth":1005,"text":242},{"id":288,"depth":1005,"text":289},{"id":333,"depth":1005,"text":334},{"id":379,"depth":1005,"text":380},{"id":425,"depth":1005,"text":426},{"id":205,"depth":1005,"text":516},{"id":552,"depth":999,"text":553,"children":1016},[1017],{"id":558,"depth":1005,"text":559},{"id":625,"depth":999,"text":626,"children":1019},[1020],{"id":631,"depth":1005,"text":632},{"id":714,"depth":999,"text":715,"children":1022},[1023,1024],{"id":720,"depth":1005,"text":721},{"id":758,"depth":1005,"text":759},{"id":776,"depth":999,"text":777,"children":1026},[1027,1028,1029],{"id":782,"depth":1005,"text":783},{"id":802,"depth":1005,"text":803},{"id":822,"depth":1005,"text":823},{"id":840,"depth":999,"text":841,"children":1031},[1032],{"id":846,"depth":1005,"text":847},{"id":874,"depth":999,"text":875,"children":1034},[1035,1036],{"id":880,"depth":1005,"text":881},{"id":901,"depth":1005,"text":902},{"id":919,"depth":999,"text":920,"children":1038},[1039],{"id":925,"depth":1005,"text":926},"md",{"head":1042},{"title":1043},"CleanShot X - URL scheme API",true,"/docs-api",{"title":5,"description":17},"docs-api","CM58cdbsJWg1BPb3xGa5FPGAzgPDlCgwCmUlwnH4IW0",1787924442715]