[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-en-\u002Fen\u002Fdocs\u002Fapi\u002Fagent-api":3},{"id":4,"title":5,"body":6,"category":888,"code_examples":889,"demos":889,"description":890,"extension":891,"meta":892,"navigation":889,"order":691,"path":893,"seo":894,"sitemap":904,"stem":906,"tags":907,"toc":913,"videos":889,"__hash__":914},"docsEn\u002Fen\u002Fdocs\u002Fapi\u002Fagent-api.md","Agent API v2 - API for AI Agents",{"type":7,"value":8,"toc":868},"minimark",[9,14,18,23,26,29,40,43,47,50,55,63,143,147,150,155,158,162,165,171,175,178,211,215,218,256,260,513,524,538,572,576,579,624,627,647,651,654,803,824,828,842,846,852,856,859,864],[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},"how-to-connect-your-ai-agent","How to Connect Your AI Agent",[15,48,49],{},"To connect an AI Agent (such as OpenClaw, ChatGPT, Claude, or other automation tools) to your Konektor workspace:",[51,52,54],"h3",{"id":53},"_1-create-an-api-key-with-agent-scopes","1. Create an API Key with Agent Scopes",[15,56,57,58,62],{},"Go to ",[59,60,61],"strong",{},"Settings → API Keys"," in your workspace dashboard and create a new API key with the required scopes:",[64,65,66,79],"table",{},[67,68,69],"thead",{},[70,71,72,76],"tr",{},[73,74,75],"th",{},"Scope",[73,77,78],{},"Access",[80,81,82,93,103,113,123,133],"tbody",{},[70,83,84,90],{},[85,86,87],"td",{},[38,88,89],{},"agent.leads.read",[85,91,92],{},"Read lead data (list, detail)",[70,94,95,100],{},[85,96,97],{},[38,98,99],{},"agent.leads.write",[85,101,102],{},"Create, update, and upsert leads",[70,104,105,110],{},[85,106,107],{},[38,108,109],{},"agent.analytics.read",[85,111,112],{},"Read analytics (summary, funnel, campaigns)",[70,114,115,120],{},[85,116,117],{},[38,118,119],{},"agent.conversions.read",[85,121,122],{},"Read conversion sync status",[70,124,125,130],{},[85,126,127],{},[38,128,129],{},"agent.workspace.read",[85,131,132],{},"Read workspace info and subscription",[70,134,135,140],{},[85,136,137],{},[38,138,139],{},"agent.support.write",[85,141,142],{},"Create support tickets",[51,144,146],{"id":145},"_2-give-skillmd-to-your-ai-agent","2. Give SKILL.md to Your AI Agent",[15,148,149],{},"Provide the following URL to your AI Agent:",[30,151,153],{"className":152,"code":34,"language":35,"meta":36},[33],[38,154,34],{"__ignoreMap":36},[15,156,157],{},"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.",[51,159,161],{"id":160},"_3-configure-the-api-key","3. Configure the API Key",[15,163,164],{},"Enter the API key you created into your AI Agent's configuration. The agent will use this key to authenticate every request:",[30,166,169],{"className":167,"code":168,"language":35,"meta":36},[33],"Authorization: Bearer \u003Cyour_api_key>\n",[38,170,168],{"__ignoreMap":36},[19,172,174],{"id":173},"what-can-your-ai-agent-do","What Can Your AI Agent Do?",[15,176,177],{},"Once connected, your AI Agent can:",[179,180,181,188,194,200,206],"ul",{},[182,183,184,187],"li",{},[59,185,186],{},"Analyze lead data"," — Pull summaries, funnels, and campaign performance in real-time",[182,189,190,193],{},[59,191,192],{},"Manage leads"," — Create new leads, update status, perform scoring",[182,195,196,199],{},[59,197,198],{},"Monitor conversions"," — Track conversion sync status to Meta, Google, TikTok",[182,201,202,205],{},[59,203,204],{},"Check workspace"," — View subscription info, usage, and workspace configuration",[182,207,208,210],{},[59,209,142],{}," — Submit support tickets directly from the AI Agent",[51,212,214],{"id":213},"example-commands","Example Commands",[15,216,217],{},"Here are some example prompts you can give your AI Agent:",[179,219,220,226,231,236,241,246,251],{},[182,221,222],{},[223,224,225],"em",{},"\"How many new leads this week?\"",[182,227,228],{},[223,229,230],{},"\"Show me the conversion funnel for this month\"",[182,232,233],{},[223,234,235],{},"\"Which campaign generated the most leads?\"",[182,237,238],{},[223,239,240],{},"\"Update lead CRM-1024 status to qualified\"",[182,242,243],{},[223,244,245],{},"\"Create a new lead from this form submission\"",[182,247,248],{},[223,249,250],{},"\"How many conversions failed to sync?\"",[182,252,253],{},[223,254,255],{},"\"Create a support ticket about our tracking pixel not firing\"",[19,257,259],{"id":258},"available-endpoints","Available Endpoints",[64,261,262,277],{},[67,263,264],{},[70,265,266,269,272,274],{},[73,267,268],{},"Method",[73,270,271],{},"Path",[73,273,75],{},[73,275,276],{},"Description",[80,278,279,297,315,333,351,369,387,405,423,441,459,477,495],{},[70,280,281,286,291,294],{},[85,282,283],{},[38,284,285],{},"GET",[85,287,288],{},[38,289,290],{},"\u002Fapi\u002Fv2\u002Fagent\u002FSKILL.md",[85,292,293],{},"—",[85,295,296],{},"Machine-readable documentation (public)",[70,298,299,303,308,312],{},[85,300,301],{},[38,302,285],{},[85,304,305],{},[38,306,307],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fleads",[85,309,310],{},[38,311,89],{},[85,313,314],{},"List leads with filters and pagination",[70,316,317,321,326,330],{},[85,318,319],{},[38,320,285],{},[85,322,323],{},[38,324,325],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fleads\u002F:id",[85,327,328],{},[38,329,89],{},[85,331,332],{},"Get lead details",[70,334,335,340,344,348],{},[85,336,337],{},[38,338,339],{},"POST",[85,341,342],{},[38,343,307],{},[85,345,346],{},[38,347,99],{},[85,349,350],{},"Create a new lead",[70,352,353,357,362,366],{},[85,354,355],{},[38,356,339],{},[85,358,359],{},[38,360,361],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fleads\u002Fupsert",[85,363,364],{},[38,365,99],{},[85,367,368],{},"Upsert lead by id\u002FuniqueCode\u002Fphone\u002FexternalRef",[70,370,371,376,380,384],{},[85,372,373],{},[38,374,375],{},"PATCH",[85,377,378],{},[38,379,325],{},[85,381,382],{},[38,383,99],{},[85,385,386],{},"Update a lead",[70,388,389,393,398,402],{},[85,390,391],{},[38,392,285],{},[85,394,395],{},[38,396,397],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fanalytics\u002Fsummary",[85,399,400],{},[38,401,109],{},[85,403,404],{},"Analytics summary",[70,406,407,411,416,420],{},[85,408,409],{},[38,410,285],{},[85,412,413],{},[38,414,415],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fanalytics\u002Ffunnel",[85,417,418],{},[38,419,109],{},[85,421,422],{},"Funnel by status",[70,424,425,429,434,438],{},[85,426,427],{},[38,428,285],{},[85,430,431],{},[38,432,433],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fanalytics\u002Fcampaigns",[85,435,436],{},[38,437,109],{},[85,439,440],{},"Campaign performance",[70,442,443,447,452,456],{},[85,444,445],{},[38,446,285],{},[85,448,449],{},[38,450,451],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fconversions\u002Fstatus",[85,453,454],{},[38,455,119],{},[85,457,458],{},"Conversion sync status",[70,460,461,465,470,474],{},[85,462,463],{},[38,464,285],{},[85,466,467],{},[38,468,469],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fconversions\u002Fpending",[85,471,472],{},[38,473,119],{},[85,475,476],{},"Pending\u002Ffailed conversions",[70,478,479,483,488,492],{},[85,480,481],{},[38,482,285],{},[85,484,485],{},[38,486,487],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fworkspace",[85,489,490],{},[38,491,129],{},[85,493,494],{},"Workspace info",[70,496,497,501,506,510],{},[85,498,499],{},[38,500,339],{},[85,502,503],{},[38,504,505],{},"\u002Fapi\u002Fv2\u002Fagent\u002Fsupport\u002Ftickets",[85,507,508],{},[38,509,139],{},[85,511,512],{},"Create a support ticket",[51,514,516,519,520,523],{"id":515},"from-and-to-query-notes",[38,517,518],{},"from"," and ",[38,521,522],{},"to"," Query Notes",[15,525,526,527,530,531,530,534,537],{},"For analytics endpoints (",[38,528,529],{},"summary",", ",[38,532,533],{},"funnel",[38,535,536],{},"campaigns",") and conversion status:",[179,539,540,552,558,563],{},[182,541,542,543,545,546,548,549],{},"If ",[38,544,518],{}," or ",[38,547,522],{}," is provided, custom range filtering overrides ",[38,550,551],{},"timeframe",[182,553,554,555,557],{},"If only ",[38,556,518],{}," is provided, range is open-ended up to current time",[182,559,554,560,562],{},[38,561,522],{}," is provided, range is open-ended from earliest data",[182,564,542,565,568,569],{},[38,566,567],{},"from > to",", API returns ",[38,570,571],{},"VALIDATION_ERROR",[19,573,575],{"id":574},"rate-limits","Rate Limits",[15,577,578],{},"Rate limits are plan-based and apply per workspace (shared across all API keys):",[64,580,581,591],{},[67,582,583],{},[70,584,585,588],{},[73,586,587],{},"Plan",[73,589,590],{},"Limit",[80,592,593,601,609,617],{},[70,594,595,598],{},[85,596,597],{},"Starter",[85,599,600],{},"60 req\u002Fmin",[70,602,603,606],{},[85,604,605],{},"Pro",[85,607,608],{},"200 req\u002Fmin",[70,610,611,614],{},[85,612,613],{},"Enterprise",[85,615,616],{},"600 req\u002Fmin",[70,618,619,622],{},[85,620,621],{},"Custom",[85,623,608],{},[15,625,626],{},"Every authenticated response includes rate limit headers (including auth-throttle responses):",[179,628,629,635,641],{},[182,630,631,634],{},[38,632,633],{},"X-RateLimit-Limit"," — Maximum requests per minute",[182,636,637,640],{},[38,638,639],{},"X-RateLimit-Remaining"," — Remaining requests in current window",[182,642,643,646],{},[38,644,645],{},"X-RateLimit-Reset"," — Window reset timestamp (Unix seconds)",[19,648,650],{"id":649},"error-format","Error Format",[15,652,653],{},"All errors use a consistent JSON format:",[30,655,659],{"className":656,"code":657,"language":658,"meta":36,"style":36},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"VALIDATION_ERROR\",\n    \"message\": \"Invalid lead data\",\n    \"details\": {\n      \"firstName\": \"Required\"\n    }\n  }\n}\n","json",[38,660,661,670,689,704,728,749,763,785,791,797],{"__ignoreMap":36},[662,663,666],"span",{"class":664,"line":665},"line",1,[662,667,669],{"class":668},"sMK4o","{\n",[662,671,673,676,680,683,686],{"class":664,"line":672},2,[662,674,675],{"class":668},"  \"",[662,677,679],{"class":678},"spNyl","success",[662,681,682],{"class":668},"\"",[662,684,685],{"class":668},":",[662,687,688],{"class":668}," false,\n",[662,690,692,694,697,699,701],{"class":664,"line":691},3,[662,693,675],{"class":668},[662,695,696],{"class":678},"error",[662,698,682],{"class":668},[662,700,685],{"class":668},[662,702,703],{"class":668}," {\n",[662,705,707,710,713,715,717,720,723,725],{"class":664,"line":706},4,[662,708,709],{"class":668},"    \"",[662,711,38],{"class":712},"sBMFI",[662,714,682],{"class":668},[662,716,685],{"class":668},[662,718,719],{"class":668}," \"",[662,721,571],{"class":722},"sfazB",[662,724,682],{"class":668},[662,726,727],{"class":668},",\n",[662,729,731,733,736,738,740,742,745,747],{"class":664,"line":730},5,[662,732,709],{"class":668},[662,734,735],{"class":712},"message",[662,737,682],{"class":668},[662,739,685],{"class":668},[662,741,719],{"class":668},[662,743,744],{"class":722},"Invalid lead data",[662,746,682],{"class":668},[662,748,727],{"class":668},[662,750,752,754,757,759,761],{"class":664,"line":751},6,[662,753,709],{"class":668},[662,755,756],{"class":712},"details",[662,758,682],{"class":668},[662,760,685],{"class":668},[662,762,703],{"class":668},[662,764,766,769,773,775,777,779,782],{"class":664,"line":765},7,[662,767,768],{"class":668},"      \"",[662,770,772],{"class":771},"sbssI","firstName",[662,774,682],{"class":668},[662,776,685],{"class":668},[662,778,719],{"class":668},[662,780,781],{"class":722},"Required",[662,783,784],{"class":668},"\"\n",[662,786,788],{"class":664,"line":787},8,[662,789,790],{"class":668},"    }\n",[662,792,794],{"class":664,"line":793},9,[662,795,796],{"class":668},"  }\n",[662,798,800],{"class":664,"line":799},10,[662,801,802],{"class":668},"}\n",[15,804,805,806,530,809,530,812,530,814,530,817,530,820,823],{},"Possible error codes: ",[38,807,808],{},"UNAUTHORIZED",[38,810,811],{},"FORBIDDEN",[38,813,571],{},[38,815,816],{},"NOT_FOUND",[38,818,819],{},"RATE_LIMITED",[38,821,822],{},"INTERNAL_ERROR",".",[19,825,827],{"id":826},"security","Security",[179,829,830,833,836,839],{},[182,831,832],{},"All PII data (name, email, phone) is encrypted at rest",[182,834,835],{},"API keys support IP allowlists to restrict access",[182,837,838],{},"Scope-based access control ensures AI Agents can only access permitted data",[182,840,841],{},"Analytics endpoints return aggregate data only, no PII",[19,843,845],{"id":844},"plan-requirements","Plan Requirements",[15,847,848,849,851],{},"Agent API is available for ",[59,850,597],{}," plans and above. Trial and Free plans cannot access the Agent API.",[19,853,855],{"id":854},"full-reference","Full Reference",[15,857,858],{},"For complete technical documentation (parameters, request\u002Fresponse examples, and enum values), read SKILL.md directly:",[30,860,862],{"className":861,"code":34,"language":35,"meta":36},[33],[38,863,34],{"__ignoreMap":36},[865,866,867],"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 .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}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);}",{"title":36,"searchDepth":672,"depth":672,"links":869},[870,871,876,879,883,884,885,886,887],{"id":21,"depth":672,"text":22},{"id":45,"depth":672,"text":46,"children":872},[873,874,875],{"id":53,"depth":691,"text":54},{"id":145,"depth":691,"text":146},{"id":160,"depth":691,"text":161},{"id":173,"depth":672,"text":174,"children":877},[878],{"id":213,"depth":691,"text":214},{"id":258,"depth":672,"text":259,"children":880},[881],{"id":515,"depth":691,"text":882},"from and to Query Notes",{"id":574,"depth":672,"text":575},{"id":649,"depth":672,"text":650},{"id":826,"depth":672,"text":827},{"id":844,"depth":672,"text":845},{"id":854,"depth":672,"text":855},"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":895,"description":896,"keywords":897,"canonical":893},"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.",[898,899,900,901,902,903],"konektor agent api","ai agent api","skill.md","openclaw","llm integration","lead management ai",{"loc":893,"lastmod":905},"2026-03-28","en\u002Fdocs\u002Fapi\u002Fagent-api",[888,908,909,910,911,912],"agent-api","ai-agent","llm","automation","skill-md",true,"rxU6NpGRVWcZMxDl9LSjsj43laqr7Hh3OUtOXJoWNQA"]