[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-en-\u002Fen\u002Fdocs\u002Fapi\u002Fagent-api":3},{"id":4,"title":5,"body":6,"category":1768,"code_examples":1769,"demos":1769,"description":1770,"extension":1771,"meta":1772,"navigation":1769,"order":126,"path":1773,"seo":1774,"sitemap":1784,"stem":1786,"tags":1787,"toc":1793,"videos":1769,"__hash__":1794},"docsEn\u002Fen\u002Fdocs\u002Fapi\u002Fagent-api.md","Agent API v2 - API for AI Agents",{"type":7,"value":8,"toc":1744},"minimark",[9,14,18,23,26,29,40,43,47,56,59,65,68,74,77,80,173,181,503,517,532,541,551,556,624,627,631,634,638,645,656,768,772,775,780,783,787,790,795,799,802,841,845,848,891,895,1360,1364,1367,1392,1402,1415,1448,1452,1455,1500,1503,1523,1541,1545,1548,1672,1691,1695,1709,1713,1728,1732,1735,1740],[10,11,13],"h1",{"id":12},"agent-api-v2-api-for-ai-agents","Agent API v2 — API for AI Agents",[15,16,17],"p",{},"Agent API v2 is a dedicated API namespace designed for AI Agents, LLMs, and automation tools. With Agent API, your AI Agent can access and manage lead data, pull analytics, monitor conversion tracking, and get workspace information — all through secure, structured endpoints.",[19,20,22],"h2",{"id":21},"what-is-skillmd","What is SKILL.md?",[15,24,25],{},"SKILL.md is a machine-readable document that describes all capabilities of the Konektor Agent API. AI Agents read this file to understand what endpoints are available, what parameters are needed, and what response formats to expect.",[15,27,28],{},"Your SKILL.md URL:",[30,31,37],"pre",{"className":32,"code":34,"language":35,"meta":36},[33],"language-text","https:\u002F\u002Fkonektor.id\u002Fapi\u002Fv2\u002Fagent\u002FSKILL.md\n","text","",[38,39,34],"code",{"__ignoreMap":36},[15,41,42],{},"SKILL.md is public and requires no authentication. Any AI Agent can access it directly.",[19,44,46],{"id":45},"connect-through-mcp","Connect through MCP",[15,48,49,50,55],{},"For a read-only Claude integration with user consent, use the ",[51,52,54],"a",{"href":53},"\u002Fen\u002Fdocs\u002Fapi\u002Fclaude-connector","Konektor connector for Claude",". The guidance below covers the advanced API-key MCP endpoint.",[15,57,58],{},"Use this Streamable HTTP endpoint if your agent supports MCP:",[30,60,63],{"className":61,"code":62,"language":35,"meta":36},[33],"https:\u002F\u002Fmcp.konektor.id\u002Fmcp\n",[38,64,62],{"__ignoreMap":36},[15,66,67],{},"Send the workspace API key as a Bearer token:",[30,69,72],{"className":70,"code":71,"language":35,"meta":36},[33],"Authorization: Bearer \u003Cyour_api_key>\n",[38,73,71],{"__ignoreMap":36},[15,75,76],{},"MCP only lists tools permitted by the API key scopes. The key selects the workspace, so an agent cannot choose another workspace through a tool parameter.",[15,78,79],{},"Generic HTTP MCP client configuration:",[30,81,85],{"className":82,"code":83,"language":84,"meta":36,"style":36},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"url\": \"https:\u002F\u002Fmcp.konektor.id\u002Fmcp\",\n  \"headers\": {\n    \"Authorization\": \"Bearer ${KONEKTOR_API_KEY}\"\n  }\n}\n","json",[38,86,87,96,124,139,161,167],{"__ignoreMap":36},[88,89,92],"span",{"class":90,"line":91},"line",1,[88,93,95],{"class":94},"sMK4o","{\n",[88,97,99,102,106,109,112,115,119,121],{"class":90,"line":98},2,[88,100,101],{"class":94},"  \"",[88,103,105],{"class":104},"spNyl","url",[88,107,108],{"class":94},"\"",[88,110,111],{"class":94},":",[88,113,114],{"class":94}," \"",[88,116,118],{"class":117},"sfazB","https:\u002F\u002Fmcp.konektor.id\u002Fmcp",[88,120,108],{"class":94},[88,122,123],{"class":94},",\n",[88,125,127,129,132,134,136],{"class":90,"line":126},3,[88,128,101],{"class":94},[88,130,131],{"class":104},"headers",[88,133,108],{"class":94},[88,135,111],{"class":94},[88,137,138],{"class":94}," {\n",[88,140,142,145,149,151,153,155,158],{"class":90,"line":141},4,[88,143,144],{"class":94},"    \"",[88,146,148],{"class":147},"sBMFI","Authorization",[88,150,108],{"class":94},[88,152,111],{"class":94},[88,154,114],{"class":94},[88,156,157],{"class":117},"Bearer ${KONEKTOR_API_KEY}",[88,159,160],{"class":94},"\"\n",[88,162,164],{"class":90,"line":163},5,[88,165,166],{"class":94},"  }\n",[88,168,170],{"class":90,"line":169},6,[88,171,172],{"class":94},"}\n",[15,174,175,176,180],{},"After connecting, run ",[177,178,179],"strong",{},"List Tools",". The connection is ready when the client shows the tools allowed by the key scopes.",[182,183,184,200],"table",{},[185,186,187],"thead",{},[188,189,190,194,197],"tr",{},[191,192,193],"th",{},"MCP tool",[191,195,196],{},"Scope",[191,198,199],{},"Purpose",[201,202,203,219,233,248,267,288,303,318,338,356,371,389,404,421,442,457,475,489],"tbody",{},[188,204,205,211,216],{},[206,207,208],"td",{},[38,209,210],{},"workspace_get",[206,212,213],{},[38,214,215],{},"agent.workspace.read",[206,217,218],{},"Workspace, plan, and actual lead usage information",[188,220,221,226,230],{},[206,222,223],{},[38,224,225],{},"billing_plans",[206,227,228],{},[38,229,215],{},[206,231,232],{},"Active plan prices, retention, and every plan limit",[188,234,235,240,245],{},[206,236,237],{},[38,238,239],{},"tracking_status",[206,241,242],{},[38,243,244],{},"agent.analytics.read",[206,246,247],{},"Aggregate tracking health without contact PII",[188,249,250,259,264],{},[206,251,252,255,256],{},[38,253,254],{},"leads_list",", ",[38,257,258],{},"lead_get",[206,260,261],{},[38,262,263],{},"agent.leads.read",[206,265,266],{},"List and read leads",[188,268,269,280,285],{},[206,270,271,255,274,255,277],{},[38,272,273],{},"lead_create",[38,275,276],{},"lead_upsert",[38,278,279],{},"lead_update",[206,281,282],{},[38,283,284],{},"agent.leads.write",[206,286,287],{},"Create or update leads, including status",[188,289,290,295,300],{},[206,291,292],{},[38,293,294],{},"lead_delete",[206,296,297],{},[38,298,299],{},"leads.delete",[206,301,302],{},"Soft-delete after explicit confirmation",[188,304,305,310,315],{},[206,306,307],{},[38,308,309],{},"leads_bulk_upsert",[206,311,312],{},[38,313,314],{},"leads.bulk",[206,316,317],{},"Upsert 1-100 leads",[188,319,320,331,335],{},[206,321,322,255,325,255,328],{},[38,323,324],{},"analytics_summary",[38,326,327],{},"analytics_funnel",[38,329,330],{},"analytics_campaigns",[206,332,333],{},[38,334,244],{},[206,336,337],{},"Aggregate analytics",[188,339,340,348,353],{},[206,341,342,255,345],{},[38,343,344],{},"feedback_status",[38,346,347],{},"feedback_pending",[206,349,350],{},[38,351,352],{},"agent.conversions.read",[206,354,355],{},"Conversion feedback status and pending\u002Ffailed items",[188,357,358,363,368],{},[206,359,360],{},[38,361,362],{},"support_ticket_create",[206,364,365],{},[38,366,367],{},"agent.support.write",[206,369,370],{},"Create a support ticket",[188,372,373,381,386],{},[206,374,375,255,378],{},[38,376,377],{},"ads_overview",[38,379,380],{},"ads_spend",[206,382,383],{},[38,384,385],{},"agent.ads.read",[206,387,388],{},"Aggregate ad performance, ROAS, and daily spend",[188,390,391,396,401],{},[206,392,393],{},[38,394,395],{},"ads_sync_spend",[206,397,398],{},[38,399,400],{},"agent.ads.write",[206,402,403],{},"Queue an ad spend re-sync",[188,405,406,414,418],{},[206,407,408,255,411],{},[38,409,410],{},"ads_campaign_set_status",[38,412,413],{},"ads_campaign_set_budget",[206,415,416],{},[38,417,400],{},[206,419,420],{},"Pause, activate, or change a campaign budget after confirmation",[188,422,423,434,439],{},[206,424,425,255,428,255,431],{},[38,426,427],{},"inbox_audit",[38,429,430],{},"inbox_conversations",[38,432,433],{},"inbox_messages",[206,435,436],{},[38,437,438],{},"agent.inbox.read",[206,440,441],{},"Inbox audit, conversation list, and message text with masked numbers",[188,443,444,449,454],{},[206,445,446],{},[38,447,448],{},"rules_list",[206,450,451],{},[38,452,453],{},"agent.rules.read",[206,455,456],{},"WhatsApp rule list",[188,458,459,464,469],{},[206,460,461],{},[38,462,463],{},"rule_create",[206,465,466],{},[38,467,468],{},"agent.rules.write",[206,470,471,472],{},"Create a rule that changes leads; the rule stays off until ",[38,473,474],{},"activate=true",[188,476,477,482,486],{},[206,478,479],{},[38,480,481],{},"conversion_logs",[206,483,484],{},[38,485,352],{},[206,487,488],{},"Conversion delivery log per ad platform",[188,490,491,496,500],{},[206,492,493],{},[38,494,495],{},"tracking_events",[206,497,498],{},[38,499,244],{},[206,501,502],{},"Recent website tracking events without IP or browser identifiers",[15,504,505,506,508,509,512,513,516],{},"Every ",[177,507,179],{}," result includes ",[38,510,511],{},"inputSchema"," and ",[38,514,515],{},"outputSchema",". These schemas identify required fields, enum values, text lengths, numeric bounds, batch sizes, and response shapes so the agent does not need to infer a tool contract.",[15,518,519,521,522,525,526,528,529,531],{},[38,520,294],{}," requires ",[38,523,524],{},"confirm=true",", the separate ",[38,527,299],{}," scope, and a plan with Management API enabled. ",[38,530,309],{}," also requires Management API. Deletion is a soft-delete instead of a history purge. Do not grant write, delete, or bulk scopes when the agent only needs read access.",[15,533,534,535,537,538,540],{},"MCP billing access is read-only. An agent can read active plans, prices, retention, and limits through ",[38,536,225],{},", and read the workspace plan and daily lead usage through ",[38,539,210],{},". Checkout, invoices, upgrades, cancellations, refunds, payment credentials, and bank details remain in the member billing page.",[15,542,543,546,547,550],{},[38,544,545],{},"usage.leadsPerDay.current"," uses the workspace timezone and counts only actual, non-deleted leads. Visitor rows with the ",[38,548,549],{},"pageview"," status do not consume the daily lead quota.",[552,553,555],"h3",{"id":554},"troubleshoot-an-mcp-connection","Troubleshoot an MCP connection",[182,557,558,568],{},[185,559,560],{},[188,561,562,565],{},[191,563,564],{},"Symptom",[191,566,567],{},"What to check",[201,569,570,584,602,613],{},[188,571,572,577],{},[206,573,574],{},[38,575,576],{},"401 Unauthorized",[206,578,579,580,583],{},"Confirm the request uses ",[38,581,582],{},"Authorization: Bearer \u003Capi_key>",", then check the key's expiry and revocation state.",[188,585,586,591],{},[206,587,588],{},[38,589,590],{},"403 Forbidden",[206,592,593,594,597,598,601],{},"Confirm the Starter-or-higher subscription has ",[38,595,596],{},"active"," or ",[38,599,600],{},"trialing"," status, the key has the tool's scope, Management API is enabled for delete\u002Fbulk tools, and the agent IP matches the key allowlist when enabled.",[188,603,604,607],{},[206,605,606],{},"A tool is missing",[206,608,609,610,612],{},"MCP intentionally hides unauthorized tools. Add the scope shown in the tool table, then run ",[177,611,179],{}," again.",[188,614,615,621],{},[206,616,617,618],{},"The agent asks for ",[38,619,620],{},"workspaceId",[206,622,623],{},"Remove that parameter. The API key always selects the workspace.",[15,625,626],{},"Never send an API key in a prompt, URL, or log. Store it in the agent client's secret manager or protected configuration.",[19,628,630],{"id":629},"how-to-connect-your-ai-agent","How to Connect Your AI Agent",[15,632,633],{},"To connect an AI Agent (such as OpenClaw, ChatGPT, Claude, or other automation tools) to your Konektor workspace:",[552,635,637],{"id":636},"_1-create-an-api-key-with-agent-scopes","1. Create an API Key with Agent Scopes",[15,639,640,641,644],{},"Go to ",[177,642,643],{},"Settings → API Keys"," in your workspace dashboard and create a new API key with the required scopes:",[15,646,647,648,651,652,655],{},"Starter plans can create keys with ",[38,649,650],{},"agent.*"," scopes. Management API ",[38,653,654],{},"leads.*"," scopes are available only when your plan enables Management API.",[182,657,658,667],{},[185,659,660],{},[188,661,662,664],{},[191,663,196],{},[191,665,666],{},"Access",[201,668,669,678,687,696,705,714,723,732,741,750,759],{},[188,670,671,675],{},[206,672,673],{},[38,674,263],{},[206,676,677],{},"Read lead data (list, detail)",[188,679,680,684],{},[206,681,682],{},[38,683,284],{},[206,685,686],{},"Create, update, and upsert leads",[188,688,689,693],{},[206,690,691],{},[38,692,244],{},[206,694,695],{},"Read analytics (summary, funnel, campaigns)",[188,697,698,702],{},[206,699,700],{},[38,701,352],{},[206,703,704],{},"Read conversion sync status",[188,706,707,711],{},[206,708,709],{},[38,710,215],{},[206,712,713],{},"Read workspace info and subscription",[188,715,716,720],{},[206,717,718],{},[38,719,367],{},[206,721,722],{},"Create support tickets",[188,724,725,729],{},[206,726,727],{},[38,728,385],{},[206,730,731],{},"Read ad performance, spend, and ad connection health",[188,733,734,738],{},[206,735,736],{},[38,737,400],{},[206,739,740],{},"Pause campaigns, change budgets, and queue spend syncs",[188,742,743,747],{},[206,744,745],{},[38,746,438],{},[206,748,749],{},"Read Inbox conversations and messages, with customer numbers masked",[188,751,752,756],{},[206,753,754],{},[38,755,453],{},[206,757,758],{},"Read WhatsApp rules",[188,760,761,765],{},[206,762,763],{},[38,764,468],{},[206,766,767],{},"Create WhatsApp rules that change leads",[552,769,771],{"id":770},"_2-give-skillmd-to-your-ai-agent","2. Give SKILL.md to Your AI Agent",[15,773,774],{},"Provide the following URL to your AI Agent:",[30,776,778],{"className":777,"code":34,"language":35,"meta":36},[33],[38,779,34],{"__ignoreMap":36},[15,781,782],{},"Your AI Agent will read this document and understand how to interact with the Konektor API. Any AI Agent that supports the SKILL.md format can connect immediately.",[552,784,786],{"id":785},"_3-configure-the-api-key","3. Configure the API Key",[15,788,789],{},"Enter the API key you created into your AI Agent's configuration. The agent will use this key to authenticate every request:",[30,791,793],{"className":792,"code":71,"language":35,"meta":36},[33],[38,794,71],{"__ignoreMap":36},[19,796,798],{"id":797},"what-can-your-ai-agent-do","What Can Your AI Agent Do?",[15,800,801],{},"Once connected, your AI Agent can:",[803,804,805,812,818,824,830,836],"ul",{},[806,807,808,811],"li",{},[177,809,810],{},"Analyze lead data"," — Pull summaries, funnels, and campaign performance in real-time",[806,813,814,817],{},[177,815,816],{},"Manage leads"," — Create new leads, update status, perform scoring",[806,819,820,823],{},[177,821,822],{},"Monitor conversions"," — Track conversion sync status to Meta, Google, TikTok",[806,825,826,829],{},[177,827,828],{},"Check workspace"," — View subscription info, usage, and workspace configuration",[806,831,832,835],{},[177,833,834],{},"Check plans"," — Compare active plan prices, retention, and limits",[806,837,838,840],{},[177,839,722],{}," — Submit support tickets directly from the AI Agent",[552,842,844],{"id":843},"example-commands","Example Commands",[15,846,847],{},"Here are some example prompts you can give your AI Agent:",[803,849,850,856,861,866,871,876,881,886],{},[806,851,852],{},[853,854,855],"em",{},"\"How many new leads this week?\"",[806,857,858],{},[853,859,860],{},"\"Show me the conversion funnel for this month\"",[806,862,863],{},[853,864,865],{},"\"Which campaign generated the most leads?\"",[806,867,868],{},[853,869,870],{},"\"Update lead CRM-1024 status to qualified\"",[806,872,873],{},[853,874,875],{},"\"Create a new lead from this form submission\"",[806,877,878],{},[853,879,880],{},"\"How many conversions failed to sync?\"",[806,882,883],{},[853,884,885],{},"\"Create a support ticket about our tracking pixel not firing\"",[806,887,888],{},[853,889,890],{},"\"What is my daily lead limit and which plans are available?\"",[19,892,894],{"id":893},"available-endpoints","Available Endpoints",[182,896,897,912],{},[185,898,899],{},[188,900,901,904,907,909],{},[191,902,903],{},"Method",[191,905,906],{},"Path",[191,908,196],{},[191,910,911],{},"Description",[201,913,914,932,950,968,986,1004,1022,1040,1058,1076,1094,1112,1130,1147,1165,1183,1200,1218,1236,1254,1272,1290,1307,1324,1342],{},[188,915,916,921,926,929],{},[206,917,918],{},[38,919,920],{},"GET",[206,922,923],{},[38,924,925],{},"\u002Fapi\u002Fv2\u002Fagent\u002FSKILL.md",[206,927,928],{},"—",[206,930,931],{},"Machine-readable documentation (public)",[188,933,934,938,943,947],{},[206,935,936],{},[38,937,920],{},[206,939,940],{},[38,941,942],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fleads",[206,944,945],{},[38,946,263],{},[206,948,949],{},"List leads with filters and pagination",[188,951,952,956,961,965],{},[206,953,954],{},[38,955,920],{},[206,957,958],{},[38,959,960],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fleads\u002F:id",[206,962,963],{},[38,964,263],{},[206,966,967],{},"Get lead details",[188,969,970,975,979,983],{},[206,971,972],{},[38,973,974],{},"POST",[206,976,977],{},[38,978,942],{},[206,980,981],{},[38,982,284],{},[206,984,985],{},"Create a new lead",[188,987,988,992,997,1001],{},[206,989,990],{},[38,991,974],{},[206,993,994],{},[38,995,996],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fleads\u002Fupsert",[206,998,999],{},[38,1000,284],{},[206,1002,1003],{},"Upsert lead by id\u002FuniqueCode\u002Fphone\u002FexternalRef",[188,1005,1006,1011,1015,1019],{},[206,1007,1008],{},[38,1009,1010],{},"PATCH",[206,1012,1013],{},[38,1014,960],{},[206,1016,1017],{},[38,1018,284],{},[206,1020,1021],{},"Update a lead",[188,1023,1024,1028,1033,1037],{},[206,1025,1026],{},[38,1027,920],{},[206,1029,1030],{},[38,1031,1032],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fanalytics\u002Fsummary",[206,1034,1035],{},[38,1036,244],{},[206,1038,1039],{},"Analytics summary",[188,1041,1042,1046,1051,1055],{},[206,1043,1044],{},[38,1045,920],{},[206,1047,1048],{},[38,1049,1050],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fanalytics\u002Ffunnel",[206,1052,1053],{},[38,1054,244],{},[206,1056,1057],{},"Funnel by status",[188,1059,1060,1064,1069,1073],{},[206,1061,1062],{},[38,1063,920],{},[206,1065,1066],{},[38,1067,1068],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fanalytics\u002Fcampaigns",[206,1070,1071],{},[38,1072,244],{},[206,1074,1075],{},"Campaign performance",[188,1077,1078,1082,1087,1091],{},[206,1079,1080],{},[38,1081,920],{},[206,1083,1084],{},[38,1085,1086],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fconversions\u002Fstatus",[206,1088,1089],{},[38,1090,352],{},[206,1092,1093],{},"Conversion sync status",[188,1095,1096,1100,1105,1109],{},[206,1097,1098],{},[38,1099,920],{},[206,1101,1102],{},[38,1103,1104],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fconversions\u002Fpending",[206,1106,1107],{},[38,1108,352],{},[206,1110,1111],{},"Pending\u002Ffailed conversions",[188,1113,1114,1118,1123,1127],{},[206,1115,1116],{},[38,1117,920],{},[206,1119,1120],{},[38,1121,1122],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fworkspace",[206,1124,1125],{},[38,1126,215],{},[206,1128,1129],{},"Workspace info",[188,1131,1132,1136,1141,1145],{},[206,1133,1134],{},[38,1135,974],{},[206,1137,1138],{},[38,1139,1140],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fsupport\u002Ftickets",[206,1142,1143],{},[38,1144,367],{},[206,1146,370],{},[188,1148,1149,1153,1158,1162],{},[206,1150,1151],{},[38,1152,920],{},[206,1154,1155],{},[38,1156,1157],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fads\u002Foverview",[206,1159,1160],{},[38,1161,385],{},[206,1163,1164],{},"Ad performance summary and connection health",[188,1166,1167,1171,1176,1180],{},[206,1168,1169],{},[38,1170,920],{},[206,1172,1173],{},[38,1174,1175],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fads\u002Fspend",[206,1177,1178],{},[38,1179,385],{},[206,1181,1182],{},"Daily ad spend per platform",[188,1184,1185,1189,1194,1198],{},[206,1186,1187],{},[38,1188,974],{},[206,1190,1191],{},[38,1192,1193],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fads\u002Fsync",[206,1195,1196],{},[38,1197,400],{},[206,1199,403],{},[188,1201,1202,1206,1211,1215],{},[206,1203,1204],{},[38,1205,974],{},[206,1207,1208],{},[38,1209,1210],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fads\u002Fcampaign-status",[206,1212,1213],{},[38,1214,400],{},[206,1216,1217],{},"Pause or activate a campaign",[188,1219,1220,1224,1229,1233],{},[206,1221,1222],{},[38,1223,974],{},[206,1225,1226],{},[38,1227,1228],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fads\u002Fcampaign-budget",[206,1230,1231],{},[38,1232,400],{},[206,1234,1235],{},"Change a campaign daily budget",[188,1237,1238,1242,1247,1251],{},[206,1239,1240],{},[38,1241,920],{},[206,1243,1244],{},[38,1245,1246],{},"\u002Fapi\u002Fv2\u002Fagent\u002Finbox\u002Faudit",[206,1248,1249],{},[38,1250,438],{},[206,1252,1253],{},"Inbox health and unreplied conversations",[188,1255,1256,1260,1265,1269],{},[206,1257,1258],{},[38,1259,920],{},[206,1261,1262],{},[38,1263,1264],{},"\u002Fapi\u002Fv2\u002Fagent\u002Finbox\u002Fconversations",[206,1266,1267],{},[38,1268,438],{},[206,1270,1271],{},"Inbox conversation list",[188,1273,1274,1278,1283,1287],{},[206,1275,1276],{},[38,1277,920],{},[206,1279,1280],{},[38,1281,1282],{},"\u002Fapi\u002Fv2\u002Fagent\u002Finbox\u002Fconversations\u002F:id\u002Fmessages",[206,1284,1285],{},[38,1286,438],{},[206,1288,1289],{},"Messages of one conversation",[188,1291,1292,1296,1301,1305],{},[206,1293,1294],{},[38,1295,920],{},[206,1297,1298],{},[38,1299,1300],{},"\u002Fapi\u002Fv2\u002Fagent\u002Frules",[206,1302,1303],{},[38,1304,453],{},[206,1306,456],{},[188,1308,1309,1313,1317,1321],{},[206,1310,1311],{},[38,1312,974],{},[206,1314,1315],{},[38,1316,1300],{},[206,1318,1319],{},[38,1320,468],{},[206,1322,1323],{},"Create a WhatsApp rule",[188,1325,1326,1330,1335,1339],{},[206,1327,1328],{},[38,1329,920],{},[206,1331,1332],{},[38,1333,1334],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fconversions\u002Flogs",[206,1336,1337],{},[38,1338,352],{},[206,1340,1341],{},"Conversion delivery log",[188,1343,1344,1348,1353,1357],{},[206,1345,1346],{},[38,1347,920],{},[206,1349,1350],{},[38,1351,1352],{},"\u002Fapi\u002Fv2\u002Fagent\u002Ftracking\u002Fevents",[206,1354,1355],{},[38,1356,244],{},[206,1358,1359],{},"Recent website tracking events",[552,1361,1363],{"id":1362},"notes-on-the-ads-tools","Notes on the ads tools",[15,1365,1366],{},"The ads tools read the ad data Konektor already synced, not Meta Ads Manager directly.",[803,1368,1369,1379,1382,1385],{},[806,1370,1371,512,1373,1375,1376,1378],{},[38,1372,410],{},[38,1374,413],{}," require ",[38,1377,524],{},".",[806,1380,1381],{},"One budget change may not raise the value above 3x the current daily budget.",[806,1383,1384],{},"Ad write actions are limited to 10 per workspace per hour.",[806,1386,1387,1388,1391],{},"The Meta connection must hold ads management permission. Without it the response says ",[38,1389,1390],{},"meta_scope_missing"," and you must reconnect Meta.",[552,1393,1395,512,1398,1401],{"id":1394},"from-and-to-query-notes",[38,1396,1397],{},"from",[38,1399,1400],{},"to"," Query Notes",[15,1403,1404,1405,255,1408,255,1411,1414],{},"For analytics endpoints (",[38,1406,1407],{},"summary",[38,1409,1410],{},"funnel",[38,1412,1413],{},"campaigns",") and conversion status:",[803,1416,1417,1428,1434,1439],{},[806,1418,1419,1420,597,1422,1424,1425],{},"If ",[38,1421,1397],{},[38,1423,1400],{}," is provided, custom range filtering overrides ",[38,1426,1427],{},"timeframe",[806,1429,1430,1431,1433],{},"If only ",[38,1432,1397],{}," is provided, range is open-ended up to current time",[806,1435,1430,1436,1438],{},[38,1437,1400],{}," is provided, range is open-ended from earliest data",[806,1440,1419,1441,1444,1445],{},[38,1442,1443],{},"from > to",", API returns ",[38,1446,1447],{},"VALIDATION_ERROR",[19,1449,1451],{"id":1450},"rate-limits","Rate Limits",[15,1453,1454],{},"Rate limits are plan-based and apply per workspace (shared across all API keys):",[182,1456,1457,1467],{},[185,1458,1459],{},[188,1460,1461,1464],{},[191,1462,1463],{},"Plan",[191,1465,1466],{},"Limit",[201,1468,1469,1477,1485,1493],{},[188,1470,1471,1474],{},[206,1472,1473],{},"Starter",[206,1475,1476],{},"60 req\u002Fmin",[188,1478,1479,1482],{},[206,1480,1481],{},"Pro",[206,1483,1484],{},"200 req\u002Fmin",[188,1486,1487,1490],{},[206,1488,1489],{},"Enterprise",[206,1491,1492],{},"600 req\u002Fmin",[188,1494,1495,1498],{},[206,1496,1497],{},"Custom",[206,1499,1484],{},[15,1501,1502],{},"Every authenticated response includes rate limit headers (including auth-throttle responses):",[803,1504,1505,1511,1517],{},[806,1506,1507,1510],{},[38,1508,1509],{},"X-RateLimit-Limit"," — Maximum requests per minute",[806,1512,1513,1516],{},[38,1514,1515],{},"X-RateLimit-Remaining"," — Remaining requests in current window",[806,1518,1519,1522],{},[38,1520,1521],{},"X-RateLimit-Reset"," — Window reset timestamp (Unix seconds)",[15,1524,1525,1526,1529,1530,255,1533,1536,1537,1540],{},"MCP tool calls use the same workspace quota. When the quota is exhausted, MCP returns a ",[38,1527,1528],{},"RATE_LIMITED"," tool error with ",[38,1531,1532],{},"limit",[38,1534,1535],{},"resetAt",", and ",[38,1538,1539],{},"retryAfter"," details.",[19,1542,1544],{"id":1543},"error-format","Error Format",[15,1546,1547],{},"All errors use a consistent JSON format:",[30,1549,1551],{"className":82,"code":1550,"language":84,"meta":36,"style":36},"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"VALIDATION_ERROR\",\n    \"message\": \"Invalid lead data\",\n    \"details\": {\n      \"firstName\": \"Required\"\n    }\n  }\n}\n",[38,1552,1553,1557,1571,1584,1602,1622,1635,1656,1662,1667],{"__ignoreMap":36},[88,1554,1555],{"class":90,"line":91},[88,1556,95],{"class":94},[88,1558,1559,1561,1564,1566,1568],{"class":90,"line":98},[88,1560,101],{"class":94},[88,1562,1563],{"class":104},"success",[88,1565,108],{"class":94},[88,1567,111],{"class":94},[88,1569,1570],{"class":94}," false,\n",[88,1572,1573,1575,1578,1580,1582],{"class":90,"line":126},[88,1574,101],{"class":94},[88,1576,1577],{"class":104},"error",[88,1579,108],{"class":94},[88,1581,111],{"class":94},[88,1583,138],{"class":94},[88,1585,1586,1588,1590,1592,1594,1596,1598,1600],{"class":90,"line":141},[88,1587,144],{"class":94},[88,1589,38],{"class":147},[88,1591,108],{"class":94},[88,1593,111],{"class":94},[88,1595,114],{"class":94},[88,1597,1447],{"class":117},[88,1599,108],{"class":94},[88,1601,123],{"class":94},[88,1603,1604,1606,1609,1611,1613,1615,1618,1620],{"class":90,"line":163},[88,1605,144],{"class":94},[88,1607,1608],{"class":147},"message",[88,1610,108],{"class":94},[88,1612,111],{"class":94},[88,1614,114],{"class":94},[88,1616,1617],{"class":117},"Invalid lead data",[88,1619,108],{"class":94},[88,1621,123],{"class":94},[88,1623,1624,1626,1629,1631,1633],{"class":90,"line":169},[88,1625,144],{"class":94},[88,1627,1628],{"class":147},"details",[88,1630,108],{"class":94},[88,1632,111],{"class":94},[88,1634,138],{"class":94},[88,1636,1638,1641,1645,1647,1649,1651,1654],{"class":90,"line":1637},7,[88,1639,1640],{"class":94},"      \"",[88,1642,1644],{"class":1643},"sbssI","firstName",[88,1646,108],{"class":94},[88,1648,111],{"class":94},[88,1650,114],{"class":94},[88,1652,1653],{"class":117},"Required",[88,1655,160],{"class":94},[88,1657,1659],{"class":90,"line":1658},8,[88,1660,1661],{"class":94},"    }\n",[88,1663,1665],{"class":90,"line":1664},9,[88,1666,166],{"class":94},[88,1668,1670],{"class":90,"line":1669},10,[88,1671,172],{"class":94},[15,1673,1674,1675,255,1678,255,1681,255,1683,255,1686,255,1688,1378],{},"Possible error codes: ",[38,1676,1677],{},"UNAUTHORIZED",[38,1679,1680],{},"FORBIDDEN",[38,1682,1447],{},[38,1684,1685],{},"NOT_FOUND",[38,1687,1528],{},[38,1689,1690],{},"INTERNAL_ERROR",[19,1692,1694],{"id":1693},"security","Security",[803,1696,1697,1700,1703,1706],{},[806,1698,1699],{},"All PII data (name, email, phone) is encrypted at rest",[806,1701,1702],{},"API keys support IP allowlists to restrict access",[806,1704,1705],{},"Scope-based access control ensures AI Agents can only access permitted data",[806,1707,1708],{},"Analytics endpoints return aggregate data only, no PII",[19,1710,1712],{"id":1711},"plan-requirements","Plan Requirements",[15,1714,1715,1716,1718,1719,597,1721,1723,1724,1727],{},"Agent API and MCP are available for ",[177,1717,1473],{}," subscriptions and above with ",[38,1720,596],{},[38,1722,600],{}," status. Trial, Free, expired, cancelled, and ",[38,1725,1726],{},"past_due"," subscriptions cannot access Agent API.",[19,1729,1731],{"id":1730},"full-reference","Full Reference",[15,1733,1734],{},"For complete technical documentation (parameters, request\u002Fresponse examples, and enum values), read SKILL.md directly:",[30,1736,1738],{"className":1737,"code":34,"language":35,"meta":36},[33],[38,1739,34],{"__ignoreMap":36},[1741,1742,1743],"style",{},"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 .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}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 .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":36,"searchDepth":98,"depth":98,"links":1745},[1746,1747,1750,1755,1758,1763,1764,1765,1766,1767],{"id":21,"depth":98,"text":22},{"id":45,"depth":98,"text":46,"children":1748},[1749],{"id":554,"depth":126,"text":555},{"id":629,"depth":98,"text":630,"children":1751},[1752,1753,1754],{"id":636,"depth":126,"text":637},{"id":770,"depth":126,"text":771},{"id":785,"depth":126,"text":786},{"id":797,"depth":98,"text":798,"children":1756},[1757],{"id":843,"depth":126,"text":844},{"id":893,"depth":98,"text":894,"children":1759},[1760,1761],{"id":1362,"depth":126,"text":1363},{"id":1394,"depth":126,"text":1762},"from and to Query Notes",{"id":1450,"depth":98,"text":1451},{"id":1543,"depth":98,"text":1544},{"id":1693,"depth":98,"text":1694},{"id":1711,"depth":98,"text":1712},{"id":1730,"depth":98,"text":1731},"api",null,"Agent API v2 documentation for connecting AI Agents like OpenClaw, ChatGPT, Claude, and other automation tools to your Konektor workspace.","md",{},"\u002Fen\u002Fdocs\u002Fapi\u002Fagent-api",{"title":1775,"description":1776,"keywords":1777,"canonical":1773},"Konektor Agent API v2 - Connect AI Agents to Your Workspace","Give your AI Agent access to Konektor lead data, analytics, and conversion tracking through Agent API v2 with SKILL.md.",[1778,1779,1780,1781,1782,1783],"konektor agent api","ai agent api","skill.md","openclaw","llm integration","lead management ai",{"loc":1773,"lastmod":1785},"2026-09-06","en\u002Fdocs\u002Fapi\u002Fagent-api",[1768,1788,1789,1790,1791,1792],"agent-api","ai-agent","llm","automation","skill-md",true,"4fIR1_lbSDTIhtefJHBmKbHJ_uhseSLt8gkd48nnXF4"]