[{"data":1,"prerenderedAt":1712},["ShallowReactive",2],{"navigation":3,"page:\u002Freference\u002Fapi\u002Fbyo-providers\u002Fcreate-byo-provider":1019,"surround:\u002Freference\u002Fapi\u002Fbyo-providers\u002Fcreate-byo-provider":1703},[4,21,82,133,154,1010],[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],[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,85,86],"Guides","\u002Fguides","i-lucide-map",[87,88,91,94,97,100,103,106,109,112,115,118,121,124,127,130],[27,84,11,11],[89,90,11,11],"Authenticated flows","authenticated-flows",[92,93,11,11],"Hosted resolve pages","hosted-resolve",[95,96,11,11],"Lists and pagination","lists-and-pagination",[98,99,11,11],"JSON and network locators","json-and-network-locators",[101,102,11,11],"Schedules and change detection","schedules-and-change-detection",[104,105,11,11],"Webhooks","webhooks",[107,108,11,11],"Bring your own providers","byo-providers",[110,111,11,11],"Testing: replay, dry-run and test mode","testing",[113,114,11,11],"Side-effect safety","side-effect-safety",[116,117,11,11],"Security & data handling","security-and-data",[119,120,11,11],"Migrating from other tools","migrating",[122,123,11,11],"Drift detection and canaries","drift-and-canaries",[125,126,11,11],"SDKs","sdks",[128,129,11,11],"The kaab CLI","cli",[131,132,11,11],"Coding agents (MCP)","mcp",[134,135,136,137],"Panel","\u002Fpanel","i-lucide-layout-dashboard",[138,139,142,145,148,151],[27,135,11,11],[140,141,11,11],"The program builder","builder",[143,144,11,11],"Picking and recording","picking-and-recording",[146,147,11,11],"Taking over a job","takeover",[149,150,11,11],"Getting help","support",[152,153,11,11],"Referrals","referrals",[155,156,157,158],"Reference","\u002Freference","i-lucide-library",[159,160,520,834,837,840,1006,1007],[27,156,11,11],[161,162,11,163],"API","api",[164,166,169,212,222,274,297,316,347,376,389,396,403,410,426,447,454],[27,165,11,11],"\u002Freference\u002Fapi",[167,168,11,11],"Interactive reference","explorer",[170,171,11,172],"Jobs","jobs",[173,176,179,182,185,188,191,194,197,200,203,206,209],[174,175,11,11],"Create job","create-job",[177,178,11,11],"List jobs","list-jobs",[180,181,11,11],"Create job batch","create-job-batch",[183,184,11,11],"Estimate job","estimate-job",[186,187,11,11],"Get job","get-job",[189,190,11,11],"List job steps","list-job-steps",[192,193,11,11],"Get job snapshot","get-job-snapshot",[195,196,11,11],"Get job screenshot","get-job-screenshot",[198,199,11,11],"Get job artifact","get-job-artifact",[201,202,11,11],"Submit job input","submit-job-input",[204,205,11,11],"Resume job","resume-job",[207,208,11,11],"Takeover job","takeover-job",[210,211,11,11],"Cancel job","cancel-job",[213,214,11,215],"Batches","batches",[216,219],[217,218,11,11],"Get batch","get-batch",[220,221,11,11],"List batch jobs","list-batch-jobs",[223,224,11,225],"Programs","programs",[226,229,232,235,238,241,244,247,250,253,256,259,262,265,268,271],[227,228,11,11],"Create program","create-program",[230,231,11,11],"List programs","list-programs",[233,234,11,11],"Lint program","lint-program",[236,237,11,11],"Get program","get-program",[239,240,11,11],"Update program","update-program",[242,243,11,11],"Delete program","delete-program",[245,246,11,11],"List program versions","list-program-versions",[248,249,11,11],"Create program version","create-program-version",[251,252,11,11],"Update program version","update-program-version",[254,255,11,11],"Delete program version","delete-program-version",[257,258,11,11],"Get program version","get-program-version",[260,261,11,11],"Publish program version","publish-program-version",[263,264,11,11],"Diff program version","diff-program-version",[266,267,11,11],"Replay program version","replay-program-version",[269,270,11,11],"Set program alias","set-program-alias",[272,273,11,11],"Delete program alias","delete-program-alias",[41,42,11,275],[276,279,282,285,288,291,294],[277,278,11,11],"Create session","create-session",[280,281,11,11],"List sessions","list-sessions",[283,284,11,11],"Get session","get-session",[286,287,11,11],"Update session","update-session",[289,290,11,11],"Delete session","delete-session",[292,293,11,11],"Verify session","verify-session",[295,296,11,11],"Refresh session","refresh-session",[298,299,11,300],"Proposals","proposals",[301,304,307,310,313],[302,303,11,11],"List proposals","list-proposals",[305,306,11,11],"Get proposal","get-proposal",[308,309,11,11],"Approve proposal","approve-proposal",[311,312,11,11],"Reject proposal","reject-proposal",[314,315,11,11],"Edit proposal","edit-proposal",[317,318,11,319],"Schedules","schedules",[320,323,326,329,332,335,338,341,344],[321,322,11,11],"Create schedule","create-schedule",[324,325,11,11],"List schedules","list-schedules",[327,328,11,11],"Get schedule","get-schedule",[330,331,11,11],"Update schedule","update-schedule",[333,334,11,11],"Delete schedule","delete-schedule",[336,337,11,11],"Pause schedule","pause-schedule",[339,340,11,11],"Resume schedule","resume-schedule",[342,343,11,11],"List schedule runs","list-schedule-runs",[345,346,11,11],"Get schedule run diff","get-schedule-run-diff",[104,105,11,348],[349,352,355,358,361,364,367,370,373],[350,351,11,11],"Create webhook","create-webhook",[353,354,11,11],"List webhooks","list-webhooks",[356,357,11,11],"Get webhook","get-webhook",[359,360,11,11],"Update webhook","update-webhook",[362,363,11,11],"Delete webhook","delete-webhook",[365,366,11,11],"Rotate webhook secret","rotate-webhook-secret",[368,369,11,11],"List webhook deliveries","list-webhook-deliveries",[371,372,11,11],"Resend webhook delivery","resend-webhook-delivery",[374,375,11,11],"Test webhook","test-webhook",[377,378,11,379],"Organisation","org",[380,383,386],[381,382,11,11],"Rotate org webhook secret","rotate-org-webhook-secret",[384,385,11,11],"Get org","get-org",[387,388,11,11],"Request data deletion","request-data-deletion",[390,391,11,392],"Credits","credits",[393],[394,395,11,11],"Get credits","get-credits",[397,398,11,399],"Ledger","ledger",[400],[401,402,11,11],"List ledger entries","list-ledger-entries",[404,405,11,406],"Usage","usage",[407],[408,409,11,11],"Get usage","get-usage",[411,412,11,413],"API keys","api-keys",[414,417,420,423],[415,416,11,11],"List API keys","list-api-keys",[418,419,11,11],"Create API key","create-api-key",[421,422,11,11],"Rotate API key","rotate-api-key",[424,425,11,11],"Revoke API key","revoke-api-key",[427,108,11,428],"BYO providers",[429,432,435,438,441,444],[430,431,11,11],"List BYO providers","list-byo-providers",[433,434,11,11],"Create BYO provider","create-byo-provider",[436,437,11,11],"Get BYO provider","get-byo-provider",[439,440,11,11],"Update BYO provider","update-byo-provider",[442,443,11,11],"Delete BYO provider","delete-byo-provider",[445,446,11,11],"Test BYO provider","test-byo-provider",[448,449,11,450],"Sites","sites",[451],[452,453,11,11],"Get site profile","get-site-profile",[455,456,11,457],"Objects","schemas",[458,460,463,466,469,470,473,476,479,482,485,487,490,493,496,499,502,505,508,511,514,517],[27,459,11,11],"\u002Freference\u002Fapi\u002Fschemas",[461,462,11,11],"ApiKey","api-key",[464,465,11,11],"Batch","batch",[467,468,11,11],"ByoProvider","byo-provider",[390,391,11,11],[471,472,11,11],"ErrorResponse","error-response",[474,475,11,11],"ExtractSchema","extract-schema",[477,478,11,11],"Job","job",[480,481,11,11],"LedgerEntry","ledger-entry",[483,484,11,11],"LintResult","lint-result",[486,378,11,11],"Org",[488,489,11,11],"Program","program",[491,492,11,11],"ProgramDefinition","program-definition",[494,495,11,11],"ProgramVersion","program-version",[497,498,11,11],"Proposal","proposal",[500,501,11,11],"Schedule","schedule",[503,504,11,11],"Session","session",[506,507,11,11],"SiteProfile","site-profile",[509,510,11,11],"StepRecord","step-record",[512,513,11,11],"Webhook","webhook",[515,516,11,11],"WebhookDelivery","webhook-delivery",[518,519,11,11],"WebhookEvent","webhook-event",[521,522,11,523],"DSL","dsl",[524,526,529,532,535,538,603,637,640,751,754,756],[27,525,11,11],"\u002Freference\u002Fdsl",[527,528,11,11],"Inputs","inputs",[530,531,11,11],"Options","options",[533,534,11,11],"Policies","policies",[536,537,11,11],"Steps","steps",[539,540,11,541],"Actions","actions",[542,544,546,548,550,552,554,556,558,560,562,565,568,570,573,575,577,579,582,585,587,589,591,594,596,598,600],[27,543,11,11],"\u002Freference\u002Fdsl\u002Factions",[545,545,11,11],"fill",[547,547,11,11],"click",[549,549,11,11],"press",[551,551,11,11],"hover",[553,553,11,11],"select",[555,555,11,11],"check",[557,557,11,11],"uncheck",[559,559,11,11],"upload",[561,561,11,11],"scroll",[563,564,11,11],"wait_for","wait-for",[566,567,11,11],"set_session","set-session",[569,569,11,11],"extract",[571,572,11,11],"capture_response","capture-response",[574,574,11,11],"evaluate",[576,576,11,11],"paginate",[578,578,11,11],"download",[580,581,11,11],"read_pdf","read-pdf",[583,584,11,11],"set_vars","set-vars",[586,586,11,11],"sleep",[588,588,11,11],"reload",[590,590,11,11],"goto",[592,593,11,11],"await_input","await-input",[595,595,11,11],"checkpoint",[597,597,11,11],"screenshot",[599,599,11,11],"when",[601,602,11,11],"loop_until","loop-until",[604,605,11,606],"Conditions","conditions",[607,609,611,613,615,617,619,621,623,625,627,629,631,633,635],[27,608,11,11],"\u002Freference\u002Fdsl\u002Fconditions",[610,610,11,11],"url",[612,612,11,11],"title",[614,614,11,11],"visible",[616,616,11,11],"hidden",[618,618,11,11],"exists",[620,620,11,11],"absent",[622,622,11,11],"text",[624,624,11,11],"count",[626,626,11,11],"network",[628,628,11,11],"var",[630,630,11,11],"landmark",[632,632,11,11],"all",[634,634,11,11],"any",[636,636,11,11],"not",[638,639,11,11],"Targets","targets",[641,642,11,643],"Fields","fields",[644,646,649,651,654,656,659,661,663,666,668,671,672,674,677,679,681,683,685,687,690,693,695,698,701,703,704,707,709,712,714,716,718,720,722,724,726,728,731,733,734,736,738,740,743,745,747,749],[27,645,11,11],"\u002Freference\u002Fdsl\u002Ffields",[647,648,11,11],"allow_suffix","allow-suffix",[650,650,11,11],"attr",[652,653,11,11],"base_url","base-url",[655,655,11,11],"candidates",[657,658,11,11],"case_insensitive","case-insensitive",[660,660,11,11],"country",[662,662,11,11],"currency",[664,665,11,11],"date_format","date-format",[667,667,11,11],"decimal",[669,670,11,11],"false_values","false-values",[642,642,11,11],[673,673,11,11],"flags",[675,676,11,11],"follow_redirects","follow-redirects",[678,678,11,11],"frame",[680,680,11,11],"json",[682,682,11,11],"locale",[684,684,11,11],"many",[686,686,11,11],"max",[688,689,11,11],"max_items","max-items",[691,692,11,11],"max_length","max-length",[694,694,11,11],"min",[696,697,11,11],"min_items","min-items",[699,700,11,11],"min_length","min-length",[702,702,11,11],"name",[626,626,11,11],[705,706,11,11],"null_markers","null-markers",[708,708,11,11],"nullable",[710,711,11,11],"on_invalid","on-invalid",[713,713,11,11],"pattern",[715,715,11,11],"presence",[717,717,11,11],"regex",[719,719,11,11],"required",[721,721,11,11],"role",[723,723,11,11],"sample",[725,725,11,11],"selector",[727,727,11,11],"source",[729,730,11,11],"strip_fragment","strip-fragment",[732,732,11,11],"testid",[622,622,11,11],[735,735,11,11],"thousands",[737,737,11,11],"timezone",[739,739,11,11],"transforms",[741,742,11,11],"true_values","true-values",[744,744,11,11],"type",[746,746,11,11],"unique",[748,748,11,11],"values",[750,750,11,11],"xpath",[752,753,11,11],"Assertions","assertions",[755,739,11,11],"Transforms",[757,758,11,759],"Lint codes","lint",[760,762,765,768,771,774,777,780,783,786,789,792,795,798,801,804,807,810,813,816,819,822,825,828,831],[27,761,11,11],"\u002Freference\u002Fdsl\u002Flint",[763,764,11,11],"E001","e001",[766,767,11,11],"E002","e002",[769,770,11,11],"E003","e003",[772,773,11,11],"E004","e004",[775,776,11,11],"E005","e005",[778,779,11,11],"E006","e006",[781,782,11,11],"E007","e007",[784,785,11,11],"E008","e008",[787,788,11,11],"E009","e009",[790,791,11,11],"E010","e010",[793,794,11,11],"E011","e011",[796,797,11,11],"E012","e012",[799,800,11,11],"E013","e013",[802,803,11,11],"E014","e014",[805,806,11,11],"W001","w001",[808,809,11,11],"W002","w002",[811,812,11,11],"W003","w003",[814,815,11,11],"W004","w004",[817,818,11,11],"W005","w005",[820,821,11,11],"W006","w006",[823,824,11,11],"W007","w007",[826,827,11,11],"W008","w008",[829,830,11,11],"W009","w009",[832,833,11,11],"W010","w010",[835,836,11,11],"Codes","codes",[838,839,11,11],"Events","events",[841,129,11,842],"CLI",[843,845,847,850,853,856,859,862,865,868,871,874,877,880,883,886,889,892,895,898,901,904,907,910,913,916,919,922,925,928,931,934,937,940,943,946,949,952,955,958,961,964,967,970,973,976,979,982,985,988,991,994,997,1000,1003],[27,844,11,11],"\u002Freference\u002Fcli",[846,846,11,11],"kaab",[848,849,11,11],"kaab auth","kaab-auth",[851,852,11,11],"kaab auth login","kaab-auth-login",[854,855,11,11],"kaab auth logout","kaab-auth-logout",[857,858,11,11],"kaab auth status","kaab-auth-status",[860,861,11,11],"kaab completion","kaab-completion",[863,864,11,11],"kaab completion bash","kaab-completion-bash",[866,867,11,11],"kaab completion fish","kaab-completion-fish",[869,870,11,11],"kaab completion powershell","kaab-completion-powershell",[872,873,11,11],"kaab completion zsh","kaab-completion-zsh",[875,876,11,11],"kaab credits","kaab-credits",[878,879,11,11],"kaab jobs","kaab-jobs",[881,882,11,11],"kaab jobs cancel","kaab-jobs-cancel",[884,885,11,11],"kaab jobs get","kaab-jobs-get",[887,888,11,11],"kaab jobs input","kaab-jobs-input",[890,891,11,11],"kaab jobs list","kaab-jobs-list",[893,894,11,11],"kaab jobs resume","kaab-jobs-resume",[896,897,11,11],"kaab jobs run","kaab-jobs-run",[899,900,11,11],"kaab jobs snapshot","kaab-jobs-snapshot",[902,903,11,11],"kaab jobs steps","kaab-jobs-steps",[905,906,11,11],"kaab jobs takeover","kaab-jobs-takeover",[908,909,11,11],"kaab open","kaab-open",[911,912,11,11],"kaab open job","kaab-open-job",[914,915,11,11],"kaab programs","kaab-programs",[917,918,11,11],"kaab programs alias","kaab-programs-alias",[920,921,11,11],"kaab programs alias set","kaab-programs-alias-set",[923,924,11,11],"kaab programs diff","kaab-programs-diff",[926,927,11,11],"kaab programs lint","kaab-programs-lint",[929,930,11,11],"kaab programs list","kaab-programs-list",[932,933,11,11],"kaab programs pull","kaab-programs-pull",[935,936,11,11],"kaab programs push","kaab-programs-push",[938,939,11,11],"kaab proposals","kaab-proposals",[941,942,11,11],"kaab proposals approve","kaab-proposals-approve",[944,945,11,11],"kaab proposals list","kaab-proposals-list",[947,948,11,11],"kaab proposals reject","kaab-proposals-reject",[950,951,11,11],"kaab proposals show","kaab-proposals-show",[953,954,11,11],"kaab schedules","kaab-schedules",[956,957,11,11],"kaab schedules create","kaab-schedules-create",[959,960,11,11],"kaab schedules list","kaab-schedules-list",[962,963,11,11],"kaab schedules pause","kaab-schedules-pause",[965,966,11,11],"kaab schedules resume","kaab-schedules-resume",[968,969,11,11],"kaab schedules runs","kaab-schedules-runs",[971,972,11,11],"kaab sessions","kaab-sessions",[974,975,11,11],"kaab sessions create","kaab-sessions-create",[977,978,11,11],"kaab sessions delete","kaab-sessions-delete",[980,981,11,11],"kaab sessions list","kaab-sessions-list",[983,984,11,11],"kaab sessions verify","kaab-sessions-verify",[986,987,11,11],"kaab usage","kaab-usage",[989,990,11,11],"kaab version","kaab-version",[992,993,11,11],"kaab webhooks","kaab-webhooks",[995,996,11,11],"kaab webhooks create","kaab-webhooks-create",[998,999,11,11],"kaab webhooks deliveries","kaab-webhooks-deliveries",[1001,1002,11,11],"kaab webhooks list","kaab-webhooks-list",[1004,1005,11,11],"kaab webhooks test","kaab-webhooks-test",[125,126,11,11],[1008,1009,11,11],"Plans and pricing","plans",[1011,1012,1013,1014],"Changelog","\u002Fchangelog","i-lucide-history",[1015,1016],[27,1012,11,11],[1017,1018,11,11],"Deprecations","deprecations",{"id":1020,"title":1021,"body":1022,"breaking":1692,"date":1693,"description":1694,"extension":1695,"generated":1696,"meta":1697,"navigation":1698,"path":1699,"seo":1700,"stem":1701,"version":1693,"__hash__":1702},"docs\u002F5.reference\u002F01.api\u002F14.byo-providers\u002F02.create-byo-provider.md","Register a bring-your-own provider",{"type":1023,"value":1024,"toc":1684},"minimark",[1025,1048,1098,1103,1336,1340,1397,1401,1406,1410,1415,1564,1568,1584,1680],[1026,1027,1032],"pre",{"className":1028,"code":1029,"language":1030,"meta":1031,"style":1031},"language-http shiki shiki-themes kaab-code kaab-code kaab-code","POST \u002Fv1\u002Fbyo-providers\n","http","",[1033,1034,1035],"code",{"__ignoreMap":1031},[1036,1037,1040,1044],"span",{"class":1038,"line":1039},"line",1,[1036,1041,1043],{"class":1042},"sqn18","POST",[1036,1045,1047],{"class":1046},"sTzsn"," \u002Fv1\u002Fbyo-providers\n",[1049,1050,1051,1062],"table",{},[1052,1053,1054],"thead",{},[1055,1056,1057,1060],"tr",{},[1058,1059],"th",{},[1058,1061],{},[1063,1064,1065,1076,1087],"tbody",{},[1055,1066,1067,1071],{},[1068,1069,1070],"td",{},"Operation id",[1068,1072,1073],{},[1033,1074,1075],{},"createByoProvider",[1055,1077,1078,1081],{},[1068,1079,1080],{},"Key scope",[1068,1082,1083,1086],{},[1033,1084,1085],{},"admin",": admin keys only",[1055,1088,1089,1092],{},[1068,1090,1091],{},"Section",[1068,1093,1094],{},[1095,1096,427],"a",{"href":1097},"\u002Freference\u002Fapi#byo-providers",[1099,1100,1102],"h2",{"id":1101},"request-body","Request body",[1049,1104,1105,1121],{},[1052,1106,1107],{},[1055,1108,1109,1112,1115,1118],{},[1058,1110,1111],{},"Field",[1058,1113,1114],{},"Type",[1058,1116,1117],{},"Required",[1058,1119,1120],{},"Description",[1063,1122,1123,1140,1154,1168,1191,1219,1236,1252,1266,1291,1308,1322],{},[1055,1124,1125,1130,1135,1138],{},[1068,1126,1127],{},[1033,1128,1129],{},"kind",[1068,1131,1132],{},[1033,1133,1134],{},"\"proxy\"",[1068,1136,1137],{},"yes",[1068,1139],{},[1055,1141,1142,1146,1149,1151],{},[1068,1143,1144],{},[1033,1145,702],{},[1068,1147,1148],{},"string",[1068,1150,1137],{},[1068,1152,1153],{},"min length 1 · max length 64",[1055,1155,1156,1161,1164,1166],{},[1068,1157,1158],{},[1033,1159,1160],{},"config",[1068,1162,1163],{},"object",[1068,1165,1137],{},[1068,1167],{},[1055,1169,1170,1175,1187,1189],{},[1068,1171,1172],{},[1033,1173,1174],{},"config.type",[1068,1176,1177,1180,1181,1180,1184],{},[1033,1178,1179],{},"\"static\"",", ",[1033,1182,1183],{},"\"list\"",[1033,1185,1186],{},"\"gateway\"",[1068,1188,1137],{},[1068,1190],{},[1055,1192,1193,1198,1215,1217],{},[1068,1194,1195],{},[1033,1196,1197],{},"config.vendor",[1068,1199,1200,1180,1203,1180,1206,1180,1209,1180,1212],{},[1033,1201,1202],{},"\"brightdata\"",[1033,1204,1205],{},"\"oxylabs\"",[1033,1207,1208],{},"\"decodo\"",[1033,1210,1211],{},"\"iproyal\"",[1033,1213,1214],{},"\"webshare\"",[1068,1216],{},[1068,1218],{},[1055,1220,1221,1226,1228,1230],{},[1068,1222,1223],{},[1033,1224,1225],{},"config.url",[1068,1227,1148],{},[1068,1229],{},[1068,1231,1232,1233],{},"min length 1 · max length 2048 · pattern ",[1033,1234,1235],{},"^(https?|socks5h?):\\\u002F\\\u002F[^\\s]+$",[1055,1237,1238,1243,1247,1249],{},[1068,1239,1240],{},[1033,1241,1242],{},"config.urls",[1068,1244,1148,1245],{},[1036,1246],{},[1068,1248],{},[1068,1250,1251],{},"min items 1 · max items 1000",[1055,1253,1254,1259,1261,1263],{},[1068,1255,1256],{},[1033,1257,1258],{},"config.api_key",[1068,1260,1148],{},[1068,1262],{},[1068,1264,1265],{},"min length 1 · max length 512",[1055,1267,1268,1273,1284,1286],{},[1068,1269,1270],{},[1033,1271,1272],{},"config.pool",[1068,1274,1275,1180,1278,1180,1281],{},[1033,1276,1277],{},"\"datacenter\"",[1033,1279,1280],{},"\"residential\"",[1033,1282,1283],{},"\"mobile\"",[1068,1285],{},[1068,1287,1288,1289],{},"default ",[1033,1290,1277],{},[1055,1292,1293,1298,1300,1302],{},[1068,1294,1295],{},[1033,1296,1297],{},"config.country",[1068,1299,1148],{},[1068,1301],{},[1068,1303,1304,1305],{},"pattern ",[1033,1306,1307],{},"^[A-Z]{2}$",[1055,1309,1310,1315,1318,1320],{},[1068,1311,1312],{},[1033,1313,1314],{},"config.base_url",[1068,1316,1317],{},"string (uri)",[1068,1319],{},[1068,1321],{},[1055,1323,1324,1329,1331,1333],{},[1068,1325,1326],{},[1033,1327,1328],{},"config.model",[1068,1330,1148],{},[1068,1332,1137],{},[1068,1334,1335],{},"min length 1 · max length 128",[1099,1337,1339],{"id":1338},"example-request","Example request",[1026,1341,1345],{"className":1342,"code":1343,"language":1344,"meta":1031,"style":1031},"language-bash shiki shiki-themes kaab-code kaab-code kaab-code","curl -X POST \"https:\u002F\u002Fapi.kaab.ist\u002Fv1\u002Fbyo-providers\" \\\n  -H \"Authorization: Bearer $KAAB_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"kind\":\"proxy\",\"name\":\"my-bright-data\",\"config\":{\"type\":\"gateway\",\"url\":\"http:\u002F\u002Fuser:pass@gw.brightdata.test:22225\",\"pool\":\"residential\",\"country\":\"DE\"}}'\n","bash",[1033,1346,1347,1367,1378,1388],{"__ignoreMap":1031},[1036,1348,1349,1353,1357,1360,1364],{"class":1038,"line":1039},[1036,1350,1352],{"class":1351},"sJugJ","curl",[1036,1354,1356],{"class":1355},"sx8Bj"," -X",[1036,1358,1359],{"class":1355}," POST",[1036,1361,1363],{"class":1362},"suOy4"," \"https:\u002F\u002Fapi.kaab.ist\u002Fv1\u002Fbyo-providers\"",[1036,1365,1366],{"class":1046}," \\\n",[1036,1368,1370,1373,1376],{"class":1038,"line":1369},2,[1036,1371,1372],{"class":1355},"  -H",[1036,1374,1375],{"class":1362}," \"Authorization: Bearer $KAAB_API_KEY\"",[1036,1377,1366],{"class":1046},[1036,1379,1381,1383,1386],{"class":1038,"line":1380},3,[1036,1382,1372],{"class":1355},[1036,1384,1385],{"class":1362}," \"Content-Type: application\u002Fjson\"",[1036,1387,1366],{"class":1046},[1036,1389,1391,1394],{"class":1038,"line":1390},4,[1036,1392,1393],{"class":1355},"  -d",[1036,1395,1396],{"class":1362}," '{\"kind\":\"proxy\",\"name\":\"my-bright-data\",\"config\":{\"type\":\"gateway\",\"url\":\"http:\u002F\u002Fuser:pass@gw.brightdata.test:22225\",\"pool\":\"residential\",\"country\":\"DE\"}}'\n",[1099,1398,1400],{"id":1399},"responses","Responses",[1402,1403,1405],"h3",{"id":1404},"_201","201",[1407,1408,1409],"p",{},"Provider",[1407,1411,1412],{},[1095,1413,467],{"href":1414},"\u002Freference\u002Fapi\u002Fschemas\u002Fbyo-provider",[1026,1416,1419],{"className":1417,"code":1418,"language":680,"meta":1031,"style":1031},"language-json shiki shiki-themes kaab-code kaab-code kaab-code","{\n  \"id\": \"byo_01j9zqk3q7m4n5p6r7s8t9v0wx\",\n  \"object\": \"byo_provider\",\n  \"kind\": \"proxy\",\n  \"name\": \"my-bright-data\",\n  \"status\": \"healthy\",\n  \"last_health_at\": \"2026-09-18T10:00:00Z\",\n  \"config_public\": {\n    \"vendor\": \"brightdata\",\n    \"pool\": \"residential\"\n  },\n  \"created_at\": \"2026-09-18T10:00:00Z\"\n}\n",[1033,1420,1421,1426,1441,1453,1465,1478,1491,1504,1515,1528,1539,1547,1558],{"__ignoreMap":1031},[1036,1422,1423],{"class":1038,"line":1039},[1036,1424,1425],{"class":1046},"{\n",[1036,1427,1428,1431,1435,1438],{"class":1038,"line":1369},[1036,1429,1430],{"class":1042},"  \"id\"",[1036,1432,1434],{"class":1433},"sQm2-",":",[1036,1436,1437],{"class":1362}," \"byo_01j9zqk3q7m4n5p6r7s8t9v0wx\"",[1036,1439,1440],{"class":1433},",\n",[1036,1442,1443,1446,1448,1451],{"class":1038,"line":1380},[1036,1444,1445],{"class":1042},"  \"object\"",[1036,1447,1434],{"class":1433},[1036,1449,1450],{"class":1362}," \"byo_provider\"",[1036,1452,1440],{"class":1433},[1036,1454,1455,1458,1460,1463],{"class":1038,"line":1390},[1036,1456,1457],{"class":1042},"  \"kind\"",[1036,1459,1434],{"class":1433},[1036,1461,1462],{"class":1362}," \"proxy\"",[1036,1464,1440],{"class":1433},[1036,1466,1468,1471,1473,1476],{"class":1038,"line":1467},5,[1036,1469,1470],{"class":1042},"  \"name\"",[1036,1472,1434],{"class":1433},[1036,1474,1475],{"class":1362}," \"my-bright-data\"",[1036,1477,1440],{"class":1433},[1036,1479,1481,1484,1486,1489],{"class":1038,"line":1480},6,[1036,1482,1483],{"class":1042},"  \"status\"",[1036,1485,1434],{"class":1433},[1036,1487,1488],{"class":1362}," \"healthy\"",[1036,1490,1440],{"class":1433},[1036,1492,1494,1497,1499,1502],{"class":1038,"line":1493},7,[1036,1495,1496],{"class":1042},"  \"last_health_at\"",[1036,1498,1434],{"class":1433},[1036,1500,1501],{"class":1362}," \"2026-09-18T10:00:00Z\"",[1036,1503,1440],{"class":1433},[1036,1505,1507,1510,1512],{"class":1038,"line":1506},8,[1036,1508,1509],{"class":1042},"  \"config_public\"",[1036,1511,1434],{"class":1433},[1036,1513,1514],{"class":1046}," {\n",[1036,1516,1518,1521,1523,1526],{"class":1038,"line":1517},9,[1036,1519,1520],{"class":1042},"    \"vendor\"",[1036,1522,1434],{"class":1433},[1036,1524,1525],{"class":1362}," \"brightdata\"",[1036,1527,1440],{"class":1433},[1036,1529,1531,1534,1536],{"class":1038,"line":1530},10,[1036,1532,1533],{"class":1042},"    \"pool\"",[1036,1535,1434],{"class":1433},[1036,1537,1538],{"class":1362}," \"residential\"\n",[1036,1540,1542,1545],{"class":1038,"line":1541},11,[1036,1543,1544],{"class":1046},"  }",[1036,1546,1440],{"class":1433},[1036,1548,1550,1553,1555],{"class":1038,"line":1549},12,[1036,1551,1552],{"class":1042},"  \"created_at\"",[1036,1554,1434],{"class":1433},[1036,1556,1557],{"class":1362}," \"2026-09-18T10:00:00Z\"\n",[1036,1559,1561],{"class":1038,"line":1560},13,[1036,1562,1563],{"class":1046},"}\n",[1099,1565,1567],{"id":1566},"errors","Errors",[1407,1569,1570,1571,1575,1576,1578,1579,1583],{},"Every error answers with the ",[1095,1572,1574],{"href":1573},"\u002Freference\u002Fapi\u002Fschemas\u002Ferror-response","error envelope","; its ",[1033,1577,1033],{}," is one of the ",[1095,1580,1582],{"href":1581},"\u002Freference\u002Fcodes#errors","error codes",".",[1049,1585,1586,1596],{},[1052,1587,1588],{},[1055,1589,1590,1593],{},[1058,1591,1592],{},"Status",[1058,1594,1595],{},"When",[1063,1597,1598,1609,1617,1628,1636,1648,1658,1669],{},[1055,1599,1600,1603],{},[1068,1601,1602],{},"400",[1068,1604,1605,1608],{},[1033,1606,1607],{},"request_invalid",": request validation failed",[1055,1610,1611,1614],{},[1068,1612,1613],{},"401",[1068,1615,1616],{},"Missing or invalid API key",[1055,1618,1619,1622],{},[1068,1620,1621],{},"402",[1068,1623,1624,1627],{},[1033,1625,1626],{},"insufficient_credits",": top up to continue",[1055,1629,1630,1633],{},[1068,1631,1632],{},"403",[1068,1634,1635],{},"The key's scope does not cover this operation",[1055,1637,1638,1641],{},[1068,1639,1640],{},"409",[1068,1642,1643,1644,1647],{},"Conflicting state (see ",[1033,1645,1646],{},"error.code",")",[1055,1649,1650,1653],{},[1068,1651,1652],{},"422",[1068,1654,1655,1656,1647],{},"Semantically invalid request (see ",[1033,1657,1646],{},[1055,1659,1660,1663],{},[1068,1661,1662],{},"429",[1068,1664,1665,1666],{},"Rate limited; see ",[1033,1667,1668],{},"Retry-After",[1055,1670,1671,1674],{},[1068,1672,1673],{},"500",[1068,1675,1676,1679],{},[1033,1677,1678],{},"internal",": unexpected server error",[1681,1682,1683],"style",{},"html pre.shiki code .sqn18, html code.shiki .sqn18{--shiki-light:var(--kaab-code-token-keyword);--shiki-default:var(--kaab-code-token-keyword);--shiki-dark:var(--kaab-code-token-keyword)}html pre.shiki code .sTzsn, html code.shiki .sTzsn{--shiki-light:var(--kaab-code-foreground);--shiki-default:var(--kaab-code-foreground);--shiki-dark:var(--kaab-code-foreground)}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 .sJugJ, html code.shiki .sJugJ{--shiki-light:var(--kaab-code-token-function);--shiki-default:var(--kaab-code-token-function);--shiki-dark:var(--kaab-code-token-function)}html pre.shiki code .sx8Bj, html code.shiki .sx8Bj{--shiki-light:var(--kaab-code-token-string);--shiki-default:var(--kaab-code-token-string);--shiki-dark:var(--kaab-code-token-string)}html pre.shiki code .suOy4, html code.shiki .suOy4{--shiki-light:var(--kaab-code-token-string-expression);--shiki-default:var(--kaab-code-token-string-expression);--shiki-dark:var(--kaab-code-token-string-expression)}html pre.shiki code .sQm2-, html code.shiki .sQm2-{--shiki-light:var(--kaab-code-token-punctuation);--shiki-default:var(--kaab-code-token-punctuation);--shiki-dark:var(--kaab-code-token-punctuation)}",{"title":1031,"searchDepth":1380,"depth":1380,"links":1685},[1686,1687,1688,1691],{"id":1101,"depth":1369,"text":1102},{"id":1338,"depth":1369,"text":1339},{"id":1399,"depth":1369,"text":1400,"children":1689},[1690],{"id":1404,"depth":1380,"text":1405},{"id":1566,"depth":1369,"text":1567},false,null,"POST \u002Fv1\u002Fbyo-providers: Register a bring-your-own provider","md",true,{},{"title":433},"\u002Freference\u002Fapi\u002Fbyo-providers\u002Fcreate-byo-provider",{"title":1021,"description":1694},"5.reference\u002F01.api\u002F14.byo-providers\u002F02.create-byo-provider","mV9okZrZyCglaEONYi0IM_ciowGqRrBWBqnAIOA7NUE",[1704,1708],{"title":430,"path":1705,"stem":1706,"description":1707,"children":-1},"\u002Freference\u002Fapi\u002Fbyo-providers\u002Flist-byo-providers","5.reference\u002F01.api\u002F14.byo-providers\u002F01.list-byo-providers","GET \u002Fv1\u002Fbyo-providers: List bring-your-own providers",{"title":436,"path":1709,"stem":1710,"description":1711,"children":-1},"\u002Freference\u002Fapi\u002Fbyo-providers\u002Fget-byo-provider","5.reference\u002F01.api\u002F14.byo-providers\u002F03.get-byo-provider","GET \u002Fv1\u002Fbyo-providers\u002F{id}: Read a bring-your-own provider",1793593462738]