[{"data":1,"prerenderedAt":1186},["ShallowReactive",2],{"navigation":3,"page:\u002F":1072,"surround:\u002F":1185},[4,21,85,144,165,1063],[5,6,7,8],"Getting started","\u002Fgetting-started","i-lucide-rocket",[9,12,15,18],[10,6,11,11],"What Kaabist is",0,[13,14,11,11],"API keys and modes","keys-and-modes",[16,17,11,11],"Your first job","first-job",[19,20,11,11],"Understanding the envelope","envelope",[22,23,24,25],"Concepts","\u002Fconcepts","i-lucide-book-open",[26,28,31,34,37,40,43,46,49,52,55,58,61,64,67,70,73,76,79,82],[27,23,11,11],"Overview",[29,30,11,11],"Programs and versions","programs-and-versions",[32,33,11,11],"Tiers and escalation","tiers-and-escalation",[35,36,11,11],"The http tier","http-tier",[38,39,11,11],"The browser tier","browser-tier",[41,42,11,11],"Sessions","sessions",[44,45,11,11],"Human in the loop","human-in-the-loop",[47,48,11,11],"How healing works","self-healing",[50,51,11,11],"Obstacles and captchas","obstacles",[53,54,11,11],"Validation and warnings","validation-and-warnings",[56,57,11,11],"Credits and billing","credits-and-billing",[59,60,11,11],"Limits","limits",[62,63,11,11],"Locators","locators",[65,66,11,11],"Snapshots","snapshots",[68,69,11,11],"Egress and proxies","egress-and-proxies",[71,72,11,11],"Queueing and fairness","queueing",[74,75,11,11],"Accounts, organisations and roles","accounts-and-roles",[77,78,11,11],"Data retention","data-retention",[80,81,11,11],"Documents and PDFs","documents-and-pdfs",[83,84,11,11],"How research finds and verifies data","research",[86,87,88,89],"Guides","\u002Fguides","i-lucide-map",[90,91,94,97,100,103,106,109,112,115,118,121,124,127,130,133,136,138,141],[27,87,11,11],[92,93,11,11],"Authenticated flows","authenticated-flows",[95,96,11,11],"Hosted resolve pages","hosted-resolve",[98,99,11,11],"Lists and pagination","lists-and-pagination",[101,102,11,11],"JSON and network locators","json-and-network-locators",[104,105,11,11],"Schedules and change detection","schedules-and-change-detection",[107,108,11,11],"Webhooks","webhooks",[110,111,11,11],"Bring your own providers","byo-providers",[113,114,11,11],"Testing: replay, dry-run and test mode","testing",[116,117,11,11],"Side-effect safety","side-effect-safety",[119,120,11,11],"Security & data handling","security-and-data",[122,123,11,11],"Migrating from other tools","migrating",[125,126,11,11],"Drift detection and canaries","drift-and-canaries",[128,129,11,11],"SDKs","sdks",[131,132,11,11],"The kaab CLI","cli",[134,135,11,11],"Coding agents (MCP)","mcp",[137,84,11,11],"Research",[139,140,11,11],"Search","search",[142,143,11,11],"Deep research reports","deep-research",[145,146,147,148],"Panel","\u002Fpanel","i-lucide-layout-dashboard",[149,150,153,156,159,162],[27,146,11,11],[151,152,11,11],"The program builder","builder",[154,155,11,11],"Picking and recording","picking-and-recording",[157,158,11,11],"Taking over a job","takeover",[160,161,11,11],"Getting help","support",[163,164,11,11],"Referrals","referrals",[166,167,168,169],"Reference","\u002Freference","i-lucide-library",[170,171,552,866,869,872,1059,1060],[27,167,11,11],[172,173,11,174],"API","api",[175,177,180,223,233,285,308,327,358,387,400,417,420,427,434,441,457,478,485],[27,176,11,11],"\u002Freference\u002Fapi",[178,179,11,11],"Interactive reference","explorer",[181,182,11,183],"Jobs","jobs",[184,187,190,193,196,199,202,205,208,211,214,217,220],[185,186,11,11],"Create job","create-job",[188,189,11,11],"List jobs","list-jobs",[191,192,11,11],"Create job batch","create-job-batch",[194,195,11,11],"Estimate job","estimate-job",[197,198,11,11],"Get job","get-job",[200,201,11,11],"List job steps","list-job-steps",[203,204,11,11],"Get job snapshot","get-job-snapshot",[206,207,11,11],"Get job screenshot","get-job-screenshot",[209,210,11,11],"Get job artifact","get-job-artifact",[212,213,11,11],"Submit job input","submit-job-input",[215,216,11,11],"Resume job","resume-job",[218,219,11,11],"Takeover job","takeover-job",[221,222,11,11],"Cancel job","cancel-job",[224,225,11,226],"Batches","batches",[227,230],[228,229,11,11],"Get batch","get-batch",[231,232,11,11],"List batch jobs","list-batch-jobs",[234,235,11,236],"Programs","programs",[237,240,243,246,249,252,255,258,261,264,267,270,273,276,279,282],[238,239,11,11],"Create program","create-program",[241,242,11,11],"List programs","list-programs",[244,245,11,11],"Lint program","lint-program",[247,248,11,11],"Get program","get-program",[250,251,11,11],"Update program","update-program",[253,254,11,11],"Delete program","delete-program",[256,257,11,11],"List program versions","list-program-versions",[259,260,11,11],"Create program version","create-program-version",[262,263,11,11],"Update program version","update-program-version",[265,266,11,11],"Delete program version","delete-program-version",[268,269,11,11],"Get program version","get-program-version",[271,272,11,11],"Publish program version","publish-program-version",[274,275,11,11],"Diff program version","diff-program-version",[277,278,11,11],"Replay program version","replay-program-version",[280,281,11,11],"Set program alias","set-program-alias",[283,284,11,11],"Delete program alias","delete-program-alias",[41,42,11,286],[287,290,293,296,299,302,305],[288,289,11,11],"Create session","create-session",[291,292,11,11],"List sessions","list-sessions",[294,295,11,11],"Get session","get-session",[297,298,11,11],"Update session","update-session",[300,301,11,11],"Delete session","delete-session",[303,304,11,11],"Verify session","verify-session",[306,307,11,11],"Refresh session","refresh-session",[309,310,11,311],"Proposals","proposals",[312,315,318,321,324],[313,314,11,11],"List proposals","list-proposals",[316,317,11,11],"Get proposal","get-proposal",[319,320,11,11],"Approve proposal","approve-proposal",[322,323,11,11],"Reject proposal","reject-proposal",[325,326,11,11],"Edit proposal","edit-proposal",[328,329,11,330],"Schedules","schedules",[331,334,337,340,343,346,349,352,355],[332,333,11,11],"Create schedule","create-schedule",[335,336,11,11],"List schedules","list-schedules",[338,339,11,11],"Get schedule","get-schedule",[341,342,11,11],"Update schedule","update-schedule",[344,345,11,11],"Delete schedule","delete-schedule",[347,348,11,11],"Pause schedule","pause-schedule",[350,351,11,11],"Resume schedule","resume-schedule",[353,354,11,11],"List schedule runs","list-schedule-runs",[356,357,11,11],"Get schedule run diff","get-schedule-run-diff",[107,108,11,359],[360,363,366,369,372,375,378,381,384],[361,362,11,11],"Create webhook","create-webhook",[364,365,11,11],"List webhooks","list-webhooks",[367,368,11,11],"Get webhook","get-webhook",[370,371,11,11],"Update webhook","update-webhook",[373,374,11,11],"Delete webhook","delete-webhook",[376,377,11,11],"Rotate webhook secret","rotate-webhook-secret",[379,380,11,11],"List webhook deliveries","list-webhook-deliveries",[382,383,11,11],"Resend webhook delivery","resend-webhook-delivery",[385,386,11,11],"Test webhook","test-webhook",[388,389,11,390],"Organisation","org",[391,394,397],[392,393,11,11],"Rotate org webhook secret","rotate-org-webhook-secret",[395,396,11,11],"Get org","get-org",[398,399,11,11],"Request data deletion","request-data-deletion",[137,84,11,401],[402,405,408,411,414],[403,404,11,11],"Create research","create-research",[406,407,11,11],"List research","list-research",[409,410,11,11],"Estimate research","estimate-research",[412,413,11,11],"Get research","get-research",[415,416,11,11],"Cancel research","cancel-research",[139,140,11,418],[419],[139,140,11,11],[421,422,11,423],"Credits","credits",[424],[425,426,11,11],"Get credits","get-credits",[428,429,11,430],"Ledger","ledger",[431],[432,433,11,11],"List ledger entries","list-ledger-entries",[435,436,11,437],"Usage","usage",[438],[439,440,11,11],"Get usage","get-usage",[442,443,11,444],"API keys","api-keys",[445,448,451,454],[446,447,11,11],"List API keys","list-api-keys",[449,450,11,11],"Create API key","create-api-key",[452,453,11,11],"Rotate API key","rotate-api-key",[455,456,11,11],"Revoke API key","revoke-api-key",[458,111,11,459],"BYO providers",[460,463,466,469,472,475],[461,462,11,11],"List BYO providers","list-byo-providers",[464,465,11,11],"Create BYO provider","create-byo-provider",[467,468,11,11],"Get BYO provider","get-byo-provider",[470,471,11,11],"Update BYO provider","update-byo-provider",[473,474,11,11],"Delete BYO provider","delete-byo-provider",[476,477,11,11],"Test BYO provider","test-byo-provider",[479,480,11,481],"Sites","sites",[482],[483,484,11,11],"Get site profile","get-site-profile",[486,487,11,488],"Objects","schemas",[489,491,494,497,500,501,504,507,510,513,516,518,521,524,527,530,531,534,537,540,543,546,549],[27,490,11,11],"\u002Freference\u002Fapi\u002Fschemas",[492,493,11,11],"ApiKey","api-key",[495,496,11,11],"Batch","batch",[498,499,11,11],"ByoProvider","byo-provider",[421,422,11,11],[502,503,11,11],"ErrorResponse","error-response",[505,506,11,11],"ExtractSchema","extract-schema",[508,509,11,11],"Job","job",[511,512,11,11],"LedgerEntry","ledger-entry",[514,515,11,11],"LintResult","lint-result",[517,389,11,11],"Org",[519,520,11,11],"Program","program",[522,523,11,11],"ProgramDefinition","program-definition",[525,526,11,11],"ProgramVersion","program-version",[528,529,11,11],"Proposal","proposal",[137,84,11,11],[532,533,11,11],"Schedule","schedule",[535,536,11,11],"Session","session",[538,539,11,11],"SiteProfile","site-profile",[541,542,11,11],"StepRecord","step-record",[544,545,11,11],"Webhook","webhook",[547,548,11,11],"WebhookDelivery","webhook-delivery",[550,551,11,11],"WebhookEvent","webhook-event",[553,554,11,555],"DSL","dsl",[556,558,561,564,567,570,635,669,672,783,786,788],[27,557,11,11],"\u002Freference\u002Fdsl",[559,560,11,11],"Inputs","inputs",[562,563,11,11],"Options","options",[565,566,11,11],"Policies","policies",[568,569,11,11],"Steps","steps",[571,572,11,573],"Actions","actions",[574,576,578,580,582,584,586,588,590,592,594,597,600,602,605,607,609,611,614,617,619,621,623,626,628,630,632],[27,575,11,11],"\u002Freference\u002Fdsl\u002Factions",[577,577,11,11],"fill",[579,579,11,11],"click",[581,581,11,11],"press",[583,583,11,11],"hover",[585,585,11,11],"select",[587,587,11,11],"check",[589,589,11,11],"uncheck",[591,591,11,11],"upload",[593,593,11,11],"scroll",[595,596,11,11],"wait_for","wait-for",[598,599,11,11],"set_session","set-session",[601,601,11,11],"extract",[603,604,11,11],"capture_response","capture-response",[606,606,11,11],"evaluate",[608,608,11,11],"paginate",[610,610,11,11],"download",[612,613,11,11],"read_pdf","read-pdf",[615,616,11,11],"set_vars","set-vars",[618,618,11,11],"sleep",[620,620,11,11],"reload",[622,622,11,11],"goto",[624,625,11,11],"await_input","await-input",[627,627,11,11],"checkpoint",[629,629,11,11],"screenshot",[631,631,11,11],"when",[633,634,11,11],"loop_until","loop-until",[636,637,11,638],"Conditions","conditions",[639,641,643,645,647,649,651,653,655,657,659,661,663,665,667],[27,640,11,11],"\u002Freference\u002Fdsl\u002Fconditions",[642,642,11,11],"url",[644,644,11,11],"title",[646,646,11,11],"visible",[648,648,11,11],"hidden",[650,650,11,11],"exists",[652,652,11,11],"absent",[654,654,11,11],"text",[656,656,11,11],"count",[658,658,11,11],"network",[660,660,11,11],"var",[662,662,11,11],"landmark",[664,664,11,11],"all",[666,666,11,11],"any",[668,668,11,11],"not",[670,671,11,11],"Targets","targets",[673,674,11,675],"Fields","fields",[676,678,681,683,686,688,691,693,695,698,700,703,704,706,709,711,713,715,717,719,722,725,727,730,733,735,736,739,741,744,746,748,750,752,754,756,758,760,763,765,766,768,770,772,775,777,779,781],[27,677,11,11],"\u002Freference\u002Fdsl\u002Ffields",[679,680,11,11],"allow_suffix","allow-suffix",[682,682,11,11],"attr",[684,685,11,11],"base_url","base-url",[687,687,11,11],"candidates",[689,690,11,11],"case_insensitive","case-insensitive",[692,692,11,11],"country",[694,694,11,11],"currency",[696,697,11,11],"date_format","date-format",[699,699,11,11],"decimal",[701,702,11,11],"false_values","false-values",[674,674,11,11],[705,705,11,11],"flags",[707,708,11,11],"follow_redirects","follow-redirects",[710,710,11,11],"frame",[712,712,11,11],"json",[714,714,11,11],"locale",[716,716,11,11],"many",[718,718,11,11],"max",[720,721,11,11],"max_items","max-items",[723,724,11,11],"max_length","max-length",[726,726,11,11],"min",[728,729,11,11],"min_items","min-items",[731,732,11,11],"min_length","min-length",[734,734,11,11],"name",[658,658,11,11],[737,738,11,11],"null_markers","null-markers",[740,740,11,11],"nullable",[742,743,11,11],"on_invalid","on-invalid",[745,745,11,11],"pattern",[747,747,11,11],"presence",[749,749,11,11],"regex",[751,751,11,11],"required",[753,753,11,11],"role",[755,755,11,11],"sample",[757,757,11,11],"selector",[759,759,11,11],"source",[761,762,11,11],"strip_fragment","strip-fragment",[764,764,11,11],"testid",[654,654,11,11],[767,767,11,11],"thousands",[769,769,11,11],"timezone",[771,771,11,11],"transforms",[773,774,11,11],"true_values","true-values",[776,776,11,11],"type",[778,778,11,11],"unique",[780,780,11,11],"values",[782,782,11,11],"xpath",[784,785,11,11],"Assertions","assertions",[787,771,11,11],"Transforms",[789,790,11,791],"Lint codes","lint",[792,794,797,800,803,806,809,812,815,818,821,824,827,830,833,836,839,842,845,848,851,854,857,860,863],[27,793,11,11],"\u002Freference\u002Fdsl\u002Flint",[795,796,11,11],"E001","e001",[798,799,11,11],"E002","e002",[801,802,11,11],"E003","e003",[804,805,11,11],"E004","e004",[807,808,11,11],"E005","e005",[810,811,11,11],"E006","e006",[813,814,11,11],"E007","e007",[816,817,11,11],"E008","e008",[819,820,11,11],"E009","e009",[822,823,11,11],"E010","e010",[825,826,11,11],"E011","e011",[828,829,11,11],"E012","e012",[831,832,11,11],"E013","e013",[834,835,11,11],"E014","e014",[837,838,11,11],"W001","w001",[840,841,11,11],"W002","w002",[843,844,11,11],"W003","w003",[846,847,11,11],"W004","w004",[849,850,11,11],"W005","w005",[852,853,11,11],"W006","w006",[855,856,11,11],"W007","w007",[858,859,11,11],"W008","w008",[861,862,11,11],"W009","w009",[864,865,11,11],"W010","w010",[867,868,11,11],"Codes","codes",[870,871,11,11],"Events","events",[873,132,11,874],"CLI",[875,877,879,882,885,888,891,894,897,900,903,906,909,912,915,918,921,924,927,930,933,936,939,942,945,948,951,954,957,960,963,966,969,972,975,978,981,984,987,990,993,996,999,1002,1005,1008,1011,1014,1017,1020,1023,1026,1029,1032,1035,1038,1041,1044,1047,1050,1053,1056],[27,876,11,11],"\u002Freference\u002Fcli",[878,878,11,11],"kaab",[880,881,11,11],"kaab auth","kaab-auth",[883,884,11,11],"kaab auth login","kaab-auth-login",[886,887,11,11],"kaab auth logout","kaab-auth-logout",[889,890,11,11],"kaab auth status","kaab-auth-status",[892,893,11,11],"kaab completion","kaab-completion",[895,896,11,11],"kaab completion bash","kaab-completion-bash",[898,899,11,11],"kaab completion fish","kaab-completion-fish",[901,902,11,11],"kaab completion powershell","kaab-completion-powershell",[904,905,11,11],"kaab completion zsh","kaab-completion-zsh",[907,908,11,11],"kaab credits","kaab-credits",[910,911,11,11],"kaab jobs","kaab-jobs",[913,914,11,11],"kaab jobs cancel","kaab-jobs-cancel",[916,917,11,11],"kaab jobs get","kaab-jobs-get",[919,920,11,11],"kaab jobs input","kaab-jobs-input",[922,923,11,11],"kaab jobs list","kaab-jobs-list",[925,926,11,11],"kaab jobs resume","kaab-jobs-resume",[928,929,11,11],"kaab jobs run","kaab-jobs-run",[931,932,11,11],"kaab jobs snapshot","kaab-jobs-snapshot",[934,935,11,11],"kaab jobs steps","kaab-jobs-steps",[937,938,11,11],"kaab jobs takeover","kaab-jobs-takeover",[940,941,11,11],"kaab open","kaab-open",[943,944,11,11],"kaab open job","kaab-open-job",[946,947,11,11],"kaab programs","kaab-programs",[949,950,11,11],"kaab programs alias","kaab-programs-alias",[952,953,11,11],"kaab programs alias set","kaab-programs-alias-set",[955,956,11,11],"kaab programs diff","kaab-programs-diff",[958,959,11,11],"kaab programs lint","kaab-programs-lint",[961,962,11,11],"kaab programs list","kaab-programs-list",[964,965,11,11],"kaab programs pull","kaab-programs-pull",[967,968,11,11],"kaab programs push","kaab-programs-push",[970,971,11,11],"kaab proposals","kaab-proposals",[973,974,11,11],"kaab proposals approve","kaab-proposals-approve",[976,977,11,11],"kaab proposals list","kaab-proposals-list",[979,980,11,11],"kaab proposals reject","kaab-proposals-reject",[982,983,11,11],"kaab proposals show","kaab-proposals-show",[985,986,11,11],"kaab research","kaab-research",[988,989,11,11],"kaab research cancel","kaab-research-cancel",[991,992,11,11],"kaab research estimate","kaab-research-estimate",[994,995,11,11],"kaab research get","kaab-research-get",[997,998,11,11],"kaab research list","kaab-research-list",[1000,1001,11,11],"kaab research run","kaab-research-run",[1003,1004,11,11],"kaab schedules","kaab-schedules",[1006,1007,11,11],"kaab schedules create","kaab-schedules-create",[1009,1010,11,11],"kaab schedules list","kaab-schedules-list",[1012,1013,11,11],"kaab schedules pause","kaab-schedules-pause",[1015,1016,11,11],"kaab schedules resume","kaab-schedules-resume",[1018,1019,11,11],"kaab schedules runs","kaab-schedules-runs",[1021,1022,11,11],"kaab search","kaab-search",[1024,1025,11,11],"kaab sessions","kaab-sessions",[1027,1028,11,11],"kaab sessions create","kaab-sessions-create",[1030,1031,11,11],"kaab sessions delete","kaab-sessions-delete",[1033,1034,11,11],"kaab sessions list","kaab-sessions-list",[1036,1037,11,11],"kaab sessions verify","kaab-sessions-verify",[1039,1040,11,11],"kaab usage","kaab-usage",[1042,1043,11,11],"kaab version","kaab-version",[1045,1046,11,11],"kaab webhooks","kaab-webhooks",[1048,1049,11,11],"kaab webhooks create","kaab-webhooks-create",[1051,1052,11,11],"kaab webhooks deliveries","kaab-webhooks-deliveries",[1054,1055,11,11],"kaab webhooks list","kaab-webhooks-list",[1057,1058,11,11],"kaab webhooks test","kaab-webhooks-test",[128,129,11,11],[1061,1062,11,11],"Plans and pricing","plans",[1064,1065,1066,1067],"Changelog","\u002Fchangelog","i-lucide-history",[1068,1069],[27,1065,11,11],[1070,1071,11,11],"Deprecations","deprecations",{"id":1073,"title":1074,"body":1075,"date":1176,"description":1177,"extension":1178,"generated":1179,"meta":1180,"navigation":1179,"path":1181,"seo":1182,"stem":1183,"version":1176,"__hash__":1184},"docs\u002Findex.md","Kaabist documentation",{"type":1076,"value":1077,"toc":1166},"minimark",[1078,1082,1087,1103,1107,1120,1124,1137,1141,1155,1159],[1079,1080,1081],"p",{},"Kaabist is a web automation API: you describe what to do on a website as a versioned program, and every run of it is a job that returns typed data in one envelope. When a site moves an element, asks for a one-time code or puts a dialog in the way, the job heals, parks for a person or dismisses the obstacle instead of returning a wrong answer.",[1083,1084,1086],"h2",{"id":1085},"start-here","Start here",[1088,1089,1090,1097],"ul",{},[1091,1092,1093,1096],"li",{},[1094,1095,5],"a",{"href":6},": what Kaabist is, your API keys, your first job in curl, TypeScript, Python, Go or the CLI, and how to read the result.",[1091,1098,1099,1102],{},[1094,1100,16],{"href":1101},"\u002Fgetting-started\u002Ffirst-job",": one request against a product page, and the envelope that comes back.",[1083,1104,1106],{"id":1105},"learn-the-model","Learn the model",[1088,1108,1109,1114],{},[1091,1110,1111,1113],{},[1094,1112,22],{"href":23},": programs and versions, tiers, sessions, parking and resuming, healing, obstacles, validation, credits, limits and what Kaabist stores.",[1091,1115,1116,1119],{},[1094,1117,44],{"href":1118},"\u002Fconcepts\u002Fhuman-in-the-loop",": what happens when a job needs a person, and the five ways to resume it.",[1083,1121,1123],{"id":1122},"do-a-task","Do a task",[1088,1125,1126,1131],{},[1091,1127,1128,1130],{},[1094,1129,86],{"href":87},": authenticated flows, hosted resolve pages, lists and pagination, schedules, webhooks, testing, side-effect safety, the SDKs, the CLI and coding agents.",[1091,1132,1133,1136],{},[1094,1134,1135],{"href":146},"The panel",": the builder, picking and recording, and taking over a parked job.",[1083,1138,1140],{"id":1139},"look-something-up","Look something up",[1088,1142,1143,1148],{},[1091,1144,1145,1147],{},[1094,1146,166],{"href":167},": every API operation, every DSL action and condition, the closed sets of codes, webhook events, CLI commands and plans.",[1091,1149,1150,1154],{},[1094,1151,1153],{"href":1152},"\u002Freference\u002Fapi\u002Fexplorer","API explorer",": try an operation against your own key.",[1083,1156,1158],{"id":1157},"keep-up","Keep up",[1088,1160,1161],{},[1091,1162,1163,1165],{},[1094,1164,1064],{"href":1065},": what changed in the API, the SDKs and the CLI.",{"title":1167,"searchDepth":1168,"depth":1168,"links":1169},"",3,[1170,1172,1173,1174,1175],{"id":1085,"depth":1171,"text":1086},2,{"id":1105,"depth":1171,"text":1106},{"id":1122,"depth":1171,"text":1123},{"id":1139,"depth":1171,"text":1140},{"id":1157,"depth":1171,"text":1158},null,"Kaabist runs versioned web automation programs as an API, with typed results, human-in-the-loop parking, self-healing locators and side-effect safety.","md",false,{},"\u002F",{"title":1074,"description":1177},"index","vmZ6h0R8PvgclLuky3u3A8SMMX2WLoRjphe_b3b6HJg",[1176,1176],1793584398695]