[{"data":1,"prerenderedAt":1718},["ShallowReactive",2],{"navigation_docs_en":3,"-en-api-api-channel":333,"-en-api-api-channel-surround":1713},[4,8,26,52,94,124,174,188,198,224,234,244,289,319],{"title":5,"path":6,"stem":7},"Introduction","\u002Fen\u002Fintroduction","en\u002F01.introduction",{"title":9,"path":10,"stem":11,"children":12},"Getting started","\u002Fen\u002Fgetting-started","en\u002F02.getting-started\u002Findex",[13,14,18,22],{"title":9,"path":10,"stem":11},{"title":15,"path":16,"stem":17},"Initial setup","\u002Fen\u002Fgetting-started\u002Finitial-setup","en\u002F02.getting-started\u002F01.initial-setup",{"title":19,"path":20,"stem":21},"Create your first agent","\u002Fen\u002Fgetting-started\u002Ffirst-agent","en\u002F02.getting-started\u002F02.first-agent",{"title":23,"path":24,"stem":25},"Make a test call","\u002Fen\u002Fgetting-started\u002Ftest-call","en\u002F02.getting-started\u002F03.test-call",{"title":27,"path":28,"stem":29,"children":30},"Concepts","\u002Fen\u002Fconcepts","en\u002F03.concepts\u002Findex",[31,32,36,40,44,48],{"title":27,"path":28,"stem":29},{"title":33,"path":34,"stem":35},"Voice agent","\u002Fen\u002Fconcepts\u002Fagent","en\u002F03.concepts\u002F01.agent",{"title":37,"path":38,"stem":39},"Flow","\u002Fen\u002Fconcepts\u002Fflow","en\u002F03.concepts\u002F02.flow",{"title":41,"path":42,"stem":43},"Runtime","\u002Fen\u002Fconcepts\u002Fruntime","en\u002F03.concepts\u002F03.runtime",{"title":45,"path":46,"stem":47},"Organization and tenants","\u002Fen\u002Fconcepts\u002Forganization","en\u002F03.concepts\u002F04.organization",{"title":49,"path":50,"stem":51},"Prompt Builder","\u002Fen\u002Fconcepts\u002Fprompt-builder","en\u002F03.concepts\u002F05.prompt-builder",{"title":53,"path":54,"stem":55,"children":56},"Guides","\u002Fen\u002Fguides","en\u002F04.guides\u002Findex",[57,58,62,66,70,74,78,82,86,90],{"title":53,"path":54,"stem":55},{"title":59,"path":60,"stem":61},"Create your first agent step-by-step","\u002Fen\u002Fguides\u002Fcreate-first-agent","en\u002F04.guides\u002F01.create-first-agent",{"title":63,"path":64,"stem":65},"Use the Flow Builder","\u002Fen\u002Fguides\u002Fuse-flow-builder","en\u002F04.guides\u002F02.use-flow-builder",{"title":67,"path":68,"stem":69},"Publish and receive calls","\u002Fen\u002Fguides\u002Fpublish-agent","en\u002F04.guides\u002F03.publish-agent",{"title":71,"path":72,"stem":73},"Test an agent","\u002Fen\u002Fguides\u002Ftest-agent","en\u002F04.guides\u002F04.test-agent",{"title":75,"path":76,"stem":77},"Transfer to a human","\u002Fen\u002Fguides\u002Ftransfer-to-human","en\u002F04.guides\u002F05.transfer-to-human",{"title":79,"path":80,"stem":81},"Schedule meetings with Cal.com","\u002Fen\u002Fguides\u002Fbook-meetings","en\u002F04.guides\u002F06.book-meetings",{"title":83,"path":84,"stem":85},"Send SMS during a call","\u002Fen\u002Fguides\u002Fsend-sms","en\u002F04.guides\u002F07.send-sms",{"title":87,"path":88,"stem":89},"Configure a Phone Book","\u002Fen\u002Fguides\u002Fconfigure-phone-book","en\u002F04.guides\u002F08.configure-phone-book",{"title":91,"path":92,"stem":93},"Embed the voice widget","\u002Fen\u002Fguides\u002Fembed-widget","en\u002F04.guides\u002F09.embed-widget",{"title":95,"path":96,"stem":97,"children":98},"Flow Builder","\u002Fen\u002Fflow-builder","en\u002F05.flow-builder\u002Findex",[99,100,104,108,112,116,120],{"title":95,"path":96,"stem":97},{"title":101,"path":102,"stem":103},"Builder interface","\u002Fen\u002Fflow-builder\u002Finterface","en\u002F05.flow-builder\u002F01.interface",{"title":105,"path":106,"stem":107},"Flow structure","\u002Fen\u002Fflow-builder\u002Fstructure","en\u002F05.flow-builder\u002F02.structure",{"title":109,"path":110,"stem":111},"Flow variables","\u002Fen\u002Fflow-builder\u002Fvariables","en\u002F05.flow-builder\u002F03.variables",{"title":113,"path":114,"stem":115},"Branches and conditions","\u002Fen\u002Fflow-builder\u002Fbranches","en\u002F05.flow-builder\u002F04.branches",{"title":117,"path":118,"stem":119},"Test a flow","\u002Fen\u002Fflow-builder\u002Ftesting","en\u002F05.flow-builder\u002F05.testing",{"title":121,"path":122,"stem":123},"Validation and publishing","\u002Fen\u002Fflow-builder\u002Fvalidation-publishing","en\u002F05.flow-builder\u002F06.validation-publishing",{"title":125,"path":126,"stem":127,"children":128},"Nodes","\u002Fen\u002Fnodes","en\u002F06.nodes\u002Findex",[129,130,134,138,142,146,150,154,158,162,166,170],{"title":125,"path":126,"stem":127},{"title":131,"path":132,"stem":133},"Conversation","\u002Fen\u002Fnodes\u002Fconversation","en\u002F06.nodes\u002F01.conversation",{"title":135,"path":136,"stem":137},"Message","\u002Fen\u002Fnodes\u002Fmessage","en\u002F06.nodes\u002F02.message",{"title":139,"path":140,"stem":141},"Split path","\u002Fen\u002Fnodes\u002Fsplit-path","en\u002F06.nodes\u002F03.split-path",{"title":143,"path":144,"stem":145},"Jump to","\u002Fen\u002Fnodes\u002Fjump-to","en\u002F06.nodes\u002F04.jump-to",{"title":147,"path":148,"stem":149},"Trigger subflow","\u002Fen\u002Fnodes\u002Ftrigger-subflow","en\u002F06.nodes\u002F05.trigger-subflow",{"title":151,"path":152,"stem":153},"Custom action","\u002Fen\u002Fnodes\u002Fcustom-action","en\u002F06.nodes\u002F06.custom-action",{"title":155,"path":156,"stem":157},"Send SMS during the call","\u002Fen\u002Fnodes\u002Fsend-sms-during-call","en\u002F06.nodes\u002F07.send-sms-during-call",{"title":159,"path":160,"stem":161},"Transfer","\u002Fen\u002Fnodes\u002Ftransfer","en\u002F06.nodes\u002F08.transfer",{"title":163,"path":164,"stem":165},"Booking","\u002Fen\u002Fnodes\u002Fbooking","en\u002F06.nodes\u002F09.booking",{"title":167,"path":168,"stem":169},"End call","\u002Fen\u002Fnodes\u002Fend-call","en\u002F06.nodes\u002F10.end-call",{"title":171,"path":172,"stem":173},"Nodes coming soon","\u002Fen\u002Fnodes\u002Fcoming-soon","en\u002F06.nodes\u002F11.coming-soon",{"title":175,"path":176,"stem":177,"children":178},"Knowledge Base","\u002Fen\u002Fknowledge-base","en\u002F07.knowledge-base\u002Findex",[179,180,184],{"title":175,"path":176,"stem":177},{"title":181,"path":182,"stem":183},"Sources","\u002Fen\u002Fknowledge-base\u002Fsources","en\u002F07.knowledge-base\u002F01.sources",{"title":185,"path":186,"stem":187},"Citations","\u002Fen\u002Fknowledge-base\u002Fcitations","en\u002F07.knowledge-base\u002F02.citations",{"title":189,"path":190,"stem":191,"children":192},"Test Center","\u002Fen\u002Ftest-center","en\u002F08.test-center\u002Findex",[193,194],{"title":189,"path":190,"stem":191},{"title":195,"path":196,"stem":197},"Evaluations","\u002Fen\u002Ftest-center\u002Fevaluations","en\u002F08.test-center\u002F01.evaluations",{"title":199,"path":200,"stem":201,"children":202},"API","\u002Fen\u002Fapi","en\u002F09.api\u002Findex",[203,204,208,212,216,220],{"title":199,"path":200,"stem":201},{"title":205,"path":206,"stem":207},"API Channel","\u002Fen\u002Fapi\u002Fapi-channel","en\u002F09.api\u002F01.api-channel",{"title":209,"path":210,"stem":211},"Authentication","\u002Fen\u002Fapi\u002Fauthentication","en\u002F09.api\u002F02.authentication",{"title":213,"path":214,"stem":215},"Webhooks","\u002Fen\u002Fapi\u002Fwebhooks","en\u002F09.api\u002F03.webhooks",{"title":217,"path":218,"stem":219},"Endpoints","\u002Fen\u002Fapi\u002Fendpoints","en\u002F09.api\u002F04.endpoints",{"title":221,"path":222,"stem":223},"Realtime","\u002Fen\u002Fapi\u002Frealtime","en\u002F09.api\u002F05.realtime",{"title":225,"path":226,"stem":227,"children":228},"Integrations","\u002Fen\u002Fintegrations","en\u002F10.integrations\u002Findex",[229,230],{"title":225,"path":226,"stem":227},{"title":231,"path":232,"stem":233},"Cal.com","\u002Fen\u002Fintegrations\u002Fcalcom","en\u002F10.integrations\u002F01.calcom",{"title":235,"path":236,"stem":237,"children":238},"Telephony","\u002Fen\u002Ftelephony","en\u002F11.telephony\u002Findex",[239,240],{"title":235,"path":236,"stem":237},{"title":241,"path":242,"stem":243},"Phone numbers","\u002Fen\u002Ftelephony\u002Fnumbers","en\u002F11.telephony\u002F01.numbers",{"title":245,"path":246,"stem":247,"children":248},"Settings","\u002Fen\u002Fsettings","en\u002F12.settings\u002Findex",[249,250,254,258,262,266,270,274,278,282,285],{"title":245,"path":246,"stem":247},{"title":251,"path":252,"stem":253},"Personal profile","\u002Fen\u002Fsettings\u002Fpersonal-profile","en\u002F12.settings\u002F01.personal-profile",{"title":255,"path":256,"stem":257},"Credentials","\u002Fen\u002Fsettings\u002Fcredentials","en\u002F12.settings\u002F02.credentials",{"title":259,"path":260,"stem":261},"Password","\u002Fen\u002Fsettings\u002Fpassword","en\u002F12.settings\u002F03.password",{"title":263,"path":264,"stem":265},"Two-factor authentication","\u002Fen\u002Fsettings\u002Ftwo-factor","en\u002F12.settings\u002F04.two-factor",{"title":267,"path":268,"stem":269},"Active sessions","\u002Fen\u002Fsettings\u002Fsessions","en\u002F12.settings\u002F05.sessions",{"title":271,"path":272,"stem":273},"Company","\u002Fen\u002Fsettings\u002Fcompany","en\u002F12.settings\u002F06.company",{"title":275,"path":276,"stem":277},"Organization","\u002Fen\u002Fsettings\u002Forganization","en\u002F12.settings\u002F07.organization",{"title":279,"path":280,"stem":281},"Members","\u002Fen\u002Fsettings\u002Fmembers","en\u002F12.settings\u002F08.members",{"title":225,"path":283,"stem":284},"\u002Fen\u002Fsettings\u002Fintegrations","en\u002F12.settings\u002F09.integrations",{"title":286,"path":287,"stem":288},"API Keys","\u002Fen\u002Fsettings\u002Fapi-keys","en\u002F12.settings\u002F10.api-keys",{"title":290,"path":291,"stem":292,"children":293},"Troubleshooting","\u002Fen\u002Ftroubleshooting","en\u002F13.troubleshooting\u002Findex",[294,295,299,303,307,311,315],{"title":290,"path":291,"stem":292},{"title":296,"path":297,"stem":298},"Agent not answering","\u002Fen\u002Ftroubleshooting\u002Fagent-not-answering","en\u002F13.troubleshooting\u002F01.agent-not-answering",{"title":300,"path":301,"stem":302},"Calls dropping","\u002Fen\u002Ftroubleshooting\u002Fcalls-drop","en\u002F13.troubleshooting\u002F02.calls-drop",{"title":304,"path":305,"stem":306},"Flow won't publish","\u002Fen\u002Ftroubleshooting\u002Fflow-not-publishing","en\u002F13.troubleshooting\u002F03.flow-not-publishing",{"title":308,"path":309,"stem":310},"Knowledge Base not responding","\u002Fen\u002Ftroubleshooting\u002Fkb-not-answering","en\u002F13.troubleshooting\u002F04.kb-not-answering",{"title":312,"path":313,"stem":314},"Integration won't connect","\u002Fen\u002Ftroubleshooting\u002Fintegration-not-connecting","en\u002F13.troubleshooting\u002F05.integration-not-connecting",{"title":316,"path":317,"stem":318},"Tests failing","\u002Fen\u002Ftroubleshooting\u002Ftests-failing","en\u002F13.troubleshooting\u002F06.tests-failing",{"title":320,"path":321,"stem":322,"children":323,"page":332},"Legal","\u002Fen\u002Flegal","en\u002F14.legal",[324,328],{"title":325,"path":326,"stem":327},"Privacy Policy","\u002Fen\u002Flegal\u002Fprivacy","en\u002F14.legal\u002F01.privacy",{"title":329,"path":330,"stem":331},"Terms and Conditions","\u002Fen\u002Flegal\u002Fterms","en\u002F14.legal\u002F02.terms",false,{"id":334,"title":205,"body":335,"description":1706,"extension":1707,"links":1708,"meta":1709,"navigation":1710,"path":206,"seo":1711,"stem":207,"__hash__":1712},"docs_en\u002Fen\u002F09.api\u002F01.api-channel.md",{"type":336,"value":337,"toc":1686},"minimark",[338,347,357,362,373,384,387,399,420,427,431,436,446,574,578,592,596,599,635,849,856,859,865,869,899,903,983,1023,1047,1080,1084,1132,1173,1179,1209,1231,1235,1267,1294,1297,1329,1333,1450,1453,1555,1560,1564,1586,1590,1666,1672,1675,1682],[339,340,341,342,346],"p",{},"The API Channel is Diska's public REST surface: a set of versioned endpoints, authenticated with organization API keys, built for server-to-server integrations — sync calls and transcripts into your CRM, create and publish agents, feed knowledge bases and receive ",[343,344,345],"a",{"href":214},"event webhooks"," instead of polling.",[348,349,351,352,356],"callout",{"type":350},"info","Starting calls via API is not available yet — it arrives with outbound telephony. See ",[343,353,355],{"href":354},"#future","future",".",[358,359,361],"h2",{"id":360},"base-url","Base URL",[363,364,370],"pre",{"className":365,"code":367,"language":368,"meta":369},[366],"language-text","https:\u002F\u002Fapi.diska.ai\u002Fv1\n","text","",[371,372,367],"code",{"__ignoreMap":369},[339,374,375,376,379,380,383],{},"Note: the API Channel base is ",[371,377,378],{},"\u002Fv1",", separate from the backoffice's internal API (",[371,381,382],{},"\u002Fapi\u002Fv1","). Only the endpoints documented on this page accept API keys.",[358,385,209],{"id":386},"authentication",[339,388,389,390,394,395,398],{},"Create a key under ",[391,392,393],"strong",{},"Settings → API Keys"," in the backoffice (the full ",[371,396,397],{},"dsk_…"," key is shown only once). Send it with every request:",[363,400,404],{"className":401,"code":402,"language":403,"meta":369,"style":369},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GET \u002Fv1\u002Fagents\nAuthorization: Bearer dsk_a1b2c3…\n","http",[371,405,406,414],{"__ignoreMap":369},[407,408,411],"span",{"class":409,"line":410},"line",1,[407,412,413],{},"GET \u002Fv1\u002Fagents\n",[407,415,417],{"class":409,"line":416},2,[407,418,419],{},"Authorization: Bearer dsk_a1b2c3…\n",[339,421,422,423,426],{},"Alternatively, the ",[371,424,425],{},"X-API-Key: dsk_…"," header is also accepted.",[348,428,430],{"type":429},"warning","Keep the key in server-side environment variables; never expose it in frontend code or repositories. If it is compromised, revoke it under Settings → API Keys — it stops working immediately.",[432,433,435],"h3",{"id":434},"scopes","Scopes",[339,437,438,439,442,443,356],{},"When creating a key you can restrict it to specific scopes. ",[391,440,441],{},"A key without scopes has full access"," (the original contract); with scopes, only those endpoints respond — the rest return ",[371,444,445],{},"403",[447,448,449,462],"table",{},[450,451,452],"thead",{},[453,454,455,459],"tr",{},[456,457,458],"th",{},"Scope",[456,460,461],{},"Grants access to",[463,464,465,482,497,512,524,536,548,561],"tbody",{},[453,466,467,473],{},[468,469,470],"td",{},[371,471,472],{},"agents:read",[468,474,475,478,479],{},[371,476,477],{},"GET \u002Fv1\u002Fagents",", ",[371,480,481],{},"GET \u002Fv1\u002Fagents\u002F{id}",[453,483,484,489],{},[468,485,486],{},[371,487,488],{},"agents:write",[468,490,491,478,494],{},[371,492,493],{},"POST \u002Fv1\u002Fagents",[371,495,496],{},"POST \u002Fv1\u002Fagents\u002F{id}\u002Fpublish",[453,498,499,504],{},[468,500,501],{},[371,502,503],{},"calls:read",[468,505,506,478,509],{},[371,507,508],{},"GET \u002Fv1\u002Fcalls",[371,510,511],{},"GET \u002Fv1\u002Fcalls\u002F{id}",[453,513,514,519],{},[468,515,516],{},[371,517,518],{},"analytics:read",[468,520,521],{},[371,522,523],{},"GET \u002Fv1\u002Fanalytics\u002Foverview",[453,525,526,531],{},[468,527,528],{},[371,529,530],{},"phone-numbers:read",[468,532,533],{},[371,534,535],{},"GET \u002Fv1\u002Fphone-numbers",[453,537,538,543],{},[468,539,540],{},[371,541,542],{},"knowledge:read",[468,544,545],{},[371,546,547],{},"GET \u002Fv1\u002Fknowledge-bases",[453,549,550,555],{},[468,551,552],{},[371,553,554],{},"knowledge:write",[468,556,557,560],{},[371,558,559],{},"POST \u002Fv1\u002Fknowledge-bases"," and document ingestion",[453,562,563,568],{},[468,564,565],{},[371,566,567],{},"webhooks:manage",[468,569,570,571],{},"Managing ",[371,572,573],{},"\u002Fv1\u002Fwebhook-endpoints",[432,575,577],{"id":576},"expiry","Expiry",[339,579,580,581,584,585,588,589,591],{},"A key may carry ",[371,582,583],{},"expires_at"," (set at creation). Past that date it responds ",[371,586,587],{},"401"," with \"Chave de API expirada\". Without ",[371,590,583],{},", the key is valid until revoked.",[358,593,595],{"id":594},"first-request","First request",[339,597,598],{},"Confirm which organization and key the token belongs to:",[363,600,604],{"className":601,"code":602,"language":603,"meta":369,"style":369},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl https:\u002F\u002Fapi.diska.ai\u002Fv1\u002Fme \\\n  -H \"Authorization: Bearer dsk_a1b2c3…\"\n","bash",[371,605,606,620],{"__ignoreMap":369},[407,607,608,612,616],{"class":409,"line":410},[407,609,611],{"class":610},"sBMFI","curl",[407,613,615],{"class":614},"sfazB"," https:\u002F\u002Fapi.diska.ai\u002Fv1\u002Fme",[407,617,619],{"class":618},"sTEyZ"," \\\n",[407,621,622,625,629,632],{"class":409,"line":416},[407,623,624],{"class":614},"  -H",[407,626,628],{"class":627},"sMK4o"," \"",[407,630,631],{"class":614},"Authorization: Bearer dsk_a1b2c3…",[407,633,634],{"class":627},"\"\n",[363,636,640],{"className":637,"code":638,"language":639,"meta":369,"style":369},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"organization\": { \"id\": \"…\", \"name\": \"My Company\", \"slug\": \"my-company\" },\n  \"key\": { \"id\": \"…\", \"name\": \"CRM integration\", \"key_preview\": \"dsk_a1b2…F5A4\", \"scopes\": [], \"expires_at\": null, \"created_at\": \"…\", \"last_used_at\": \"…\" }\n}\n","json",[371,641,642,647,721,843],{"__ignoreMap":369},[407,643,644],{"class":409,"line":410},[407,645,646],{"class":627},"{\n",[407,648,649,652,656,659,662,665,667,670,672,674,676,679,681,684,686,689,691,693,695,698,700,702,704,707,709,711,713,716,718],{"class":409,"line":416},[407,650,651],{"class":627},"  \"",[407,653,655],{"class":654},"spNyl","organization",[407,657,658],{"class":627},"\"",[407,660,661],{"class":627},":",[407,663,664],{"class":627}," {",[407,666,628],{"class":627},[407,668,669],{"class":610},"id",[407,671,658],{"class":627},[407,673,661],{"class":627},[407,675,628],{"class":627},[407,677,678],{"class":614},"…",[407,680,658],{"class":627},[407,682,683],{"class":627},",",[407,685,628],{"class":627},[407,687,688],{"class":610},"name",[407,690,658],{"class":627},[407,692,661],{"class":627},[407,694,628],{"class":627},[407,696,697],{"class":614},"My Company",[407,699,658],{"class":627},[407,701,683],{"class":627},[407,703,628],{"class":627},[407,705,706],{"class":610},"slug",[407,708,658],{"class":627},[407,710,661],{"class":627},[407,712,628],{"class":627},[407,714,715],{"class":614},"my-company",[407,717,658],{"class":627},[407,719,720],{"class":627}," },\n",[407,722,724,726,729,731,733,735,737,739,741,743,745,747,749,751,753,755,757,759,761,764,766,768,770,773,775,777,779,782,784,786,788,790,792,794,797,799,801,803,805,808,810,813,815,817,819,821,823,825,827,830,832,834,836,838,840],{"class":409,"line":723},3,[407,725,651],{"class":627},[407,727,728],{"class":654},"key",[407,730,658],{"class":627},[407,732,661],{"class":627},[407,734,664],{"class":627},[407,736,628],{"class":627},[407,738,669],{"class":610},[407,740,658],{"class":627},[407,742,661],{"class":627},[407,744,628],{"class":627},[407,746,678],{"class":614},[407,748,658],{"class":627},[407,750,683],{"class":627},[407,752,628],{"class":627},[407,754,688],{"class":610},[407,756,658],{"class":627},[407,758,661],{"class":627},[407,760,628],{"class":627},[407,762,763],{"class":614},"CRM integration",[407,765,658],{"class":627},[407,767,683],{"class":627},[407,769,628],{"class":627},[407,771,772],{"class":610},"key_preview",[407,774,658],{"class":627},[407,776,661],{"class":627},[407,778,628],{"class":627},[407,780,781],{"class":614},"dsk_a1b2…F5A4",[407,783,658],{"class":627},[407,785,683],{"class":627},[407,787,628],{"class":627},[407,789,434],{"class":610},[407,791,658],{"class":627},[407,793,661],{"class":627},[407,795,796],{"class":627}," [],",[407,798,628],{"class":627},[407,800,583],{"class":610},[407,802,658],{"class":627},[407,804,661],{"class":627},[407,806,807],{"class":627}," null,",[407,809,628],{"class":627},[407,811,812],{"class":610},"created_at",[407,814,658],{"class":627},[407,816,661],{"class":627},[407,818,628],{"class":627},[407,820,678],{"class":614},[407,822,658],{"class":627},[407,824,683],{"class":627},[407,826,628],{"class":627},[407,828,829],{"class":610},"last_used_at",[407,831,658],{"class":627},[407,833,661],{"class":627},[407,835,628],{"class":627},[407,837,678],{"class":614},[407,839,658],{"class":627},[407,841,842],{"class":627}," }\n",[407,844,846],{"class":409,"line":845},4,[407,847,848],{"class":627},"}\n",[339,850,851,852,855],{},"The channel's full OpenAPI specification is available at ",[371,853,854],{},"GET \u002Fv1\u002Fopenapi.json"," (no authentication) — import it into Postman or generate a typed client.",[358,857,217],{"id":858},"endpoints",[339,860,861,862,356],{},"All endpoints return JSON. Resources always belong to the key's organization — identifiers from another organization respond ",[371,863,864],{},"404",[432,866,868],{"id":867},"identity","Identity",[447,870,871,884],{},[450,872,873],{},[453,874,875,878,881],{},[456,876,877],{},"Method",[456,879,880],{},"Path",[456,882,883],{},"Description",[463,885,886],{},[453,887,888,891,896],{},[468,889,890],{},"GET",[468,892,893],{},[371,894,895],{},"\u002Fv1\u002Fme",[468,897,898],{},"Organization and key behind the token.",[432,900,902],{"id":901},"agents","Agents",[447,904,905,917],{},[450,906,907],{},[453,908,909,911,913,915],{},[456,910,877],{},[456,912,880],{},[456,914,458],{},[456,916,883],{},[463,918,919,935,951,967],{},[453,920,921,923,928,932],{},[468,922,890],{},[468,924,925],{},[371,926,927],{},"\u002Fv1\u002Fagents",[468,929,930],{},[371,931,472],{},[468,933,934],{},"List the organization's agents.",[453,936,937,939,944,948],{},[468,938,890],{},[468,940,941],{},[371,942,943],{},"\u002Fv1\u002Fagents\u002F{agent_id}",[468,945,946],{},[371,947,472],{},[468,949,950],{},"Agent detail.",[453,952,953,956,960,964],{},[468,954,955],{},"POST",[468,957,958],{},[371,959,927],{},[468,961,962],{},[371,963,488],{},[468,965,966],{},"Create an agent (draft).",[453,968,969,971,976,980],{},[468,970,955],{},[468,972,973],{},[371,974,975],{},"\u002Fv1\u002Fagents\u002F{agent_id}\u002Fpublish",[468,977,978],{},[371,979,488],{},[468,981,982],{},"Publish the draft as the live version.",[339,984,985,987,988,991,992,478,995,478,998,478,1001,1004,1005,991,1008,478,1011,478,1014,478,1017,1004,1020,356],{},[371,986,477],{}," parameters: ",[371,989,990],{},"agent_type"," (",[371,993,994],{},"inbound",[371,996,997],{},"outbound",[371,999,1000],{},"voice_widget",[371,1002,1003],{},"chat","), ",[371,1006,1007],{},"status",[371,1009,1010],{},"draft",[371,1012,1013],{},"active",[371,1015,1016],{},"inactive",[371,1018,1019],{},"archived",[371,1021,1022],{},"search",[339,1024,1025,1027,1028,478,1030,478,1032,991,1035,1038,1039,1042,1043,1046],{},[371,1026,493],{}," body: ",[371,1029,688],{},[371,1031,990],{},[371,1033,1034],{},"editing_mode",[371,1036,1037],{},"prompt"," | ",[371,1040,1041],{},"flow",") and optionally ",[371,1044,1045],{},"template_id"," to install from a template. The agent is born as a draft — publish it to make it usable.",[339,1048,1049,1050,478,1052,478,1054,478,1056,478,1059,478,1061,478,1063,478,1065,478,1068,478,1071,478,1074,478,1076,1079],{},"Each agent returns the operational fields (",[371,1051,669],{},[371,1053,688],{},[371,1055,706],{},[371,1057,1058],{},"description",[371,1060,1007],{},[371,1062,990],{},[371,1064,1034],{},[371,1066,1067],{},"version",[371,1069,1070],{},"phone_number",[371,1072,1073],{},"public_channel_enabled",[371,1075,812],{},[371,1077,1078],{},"updated_at",") — internal builder configuration is not exposed.",[432,1081,1083],{"id":1082},"calls","Calls",[447,1085,1086,1098],{},[450,1087,1088],{},[453,1089,1090,1092,1094,1096],{},[456,1091,877],{},[456,1093,880],{},[456,1095,458],{},[456,1097,883],{},[463,1099,1100,1116],{},[453,1101,1102,1104,1109,1113],{},[468,1103,890],{},[468,1105,1106],{},[371,1107,1108],{},"\u002Fv1\u002Fcalls",[468,1110,1111],{},[371,1112,503],{},[468,1114,1115],{},"List calls (offset or cursor pagination).",[453,1117,1118,1120,1125,1129],{},[468,1119,890],{},[468,1121,1122],{},[371,1123,1124],{},"\u002Fv1\u002Fcalls\u002F{call_id}",[468,1126,1127],{},[371,1128,503],{},[468,1130,1131],{},"Detail: full transcript, executed actions and post-call outcome.",[339,1133,1134,987,1136,478,1138,478,1141,991,1143,478,1146,478,1148,478,1151,478,1154,478,1157,1004,1160,478,1163,1166,1167,478,1170,356],{},[371,1135,1108],{},[371,1137,1022],{},[371,1139,1140],{},"agent_id",[371,1142,1007],{},[371,1144,1145],{},"created",[371,1147,1013],{},[371,1149,1150],{},"completed",[371,1152,1153],{},"failed",[371,1155,1156],{},"cancelled",[371,1158,1159],{},"abandoned",[371,1161,1162],{},"channel",[371,1164,1165],{},"limit"," (1–200, default 50), ",[371,1168,1169],{},"offset",[371,1171,1172],{},"cursor",[339,1174,1175,1178],{},[391,1176,1177],{},"Cursor pagination"," (recommended for exporting large histories — constant cost at any depth):",[1180,1181,1182,1189,1199],"ol",{},[1183,1184,1185,1186,356],"li",{},"First request: ",[371,1187,1188],{},"GET \u002Fv1\u002Fcalls?cursor=start&limit=100",[1183,1190,1191,1192,1195,1196,356],{},"The response carries ",[371,1193,1194],{},"next_cursor","; repeat with ",[371,1197,1198],{},"cursor=\u003Cnext_cursor>",[1183,1200,1201,1202,1204,1205,1208],{},"When ",[371,1203,1194],{}," is ",[371,1206,1207],{},"null",", you reached the end.",[339,1210,1211,1212,1215,1216,1218,1219,1221,1222,1224,1225,1227,1228,1230],{},"In cursor mode, ",[371,1213,1214],{},"total"," comes back ",[371,1217,1207],{}," (counting would require the very scan cursors avoid) and ",[371,1220,1022],{}," is not supported. The classic offset mode (",[371,1223,1165],{},"\u002F",[371,1226,1169],{}," with exact ",[371,1229,1214],{},") remains available.",[432,1232,1234],{"id":1233},"analytics","Analytics",[447,1236,1237,1249],{},[450,1238,1239],{},[453,1240,1241,1243,1245,1247],{},[456,1242,877],{},[456,1244,880],{},[456,1246,458],{},[456,1248,883],{},[463,1250,1251],{},[453,1252,1253,1255,1260,1264],{},[468,1254,890],{},[468,1256,1257],{},[371,1258,1259],{},"\u002Fv1\u002Fanalytics\u002Foverview",[468,1261,1262],{},[371,1263,518],{},[468,1265,1266],{},"Volume, outcomes, per-agent performance and executed actions.",[339,1268,1269,1270,991,1273,478,1276,478,1279,1004,1282,478,1284,991,1286,478,1289,478,1291,1293],{},"Parameters: ",[371,1271,1272],{},"period",[371,1274,1275],{},"daily",[371,1277,1278],{},"weekly",[371,1280,1281],{},"monthly",[371,1283,1140],{},[371,1285,990],{},[371,1287,1288],{},"all",[371,1290,994],{},[371,1292,997],{},").",[432,1295,241],{"id":1296},"phone-numbers",[447,1298,1299,1311],{},[450,1300,1301],{},[453,1302,1303,1305,1307,1309],{},[456,1304,877],{},[456,1306,880],{},[456,1308,458],{},[456,1310,883],{},[463,1312,1313],{},[453,1314,1315,1317,1322,1326],{},[468,1316,890],{},[468,1318,1319],{},[371,1320,1321],{},"\u002Fv1\u002Fphone-numbers",[468,1323,1324],{},[371,1325,530],{},[468,1327,1328],{},"The organization's number inventory.",[432,1330,1332],{"id":1331},"knowledge","Knowledge",[447,1334,1335,1347],{},[450,1336,1337],{},[453,1338,1339,1341,1343,1345],{},[456,1340,877],{},[456,1342,880],{},[456,1344,458],{},[456,1346,883],{},[463,1348,1349,1365,1387,1409,1430],{},[453,1350,1351,1353,1358,1362],{},[468,1352,890],{},[468,1354,1355],{},[371,1356,1357],{},"\u002Fv1\u002Fknowledge-bases",[468,1359,1360],{},[371,1361,542],{},[468,1363,1364],{},"Knowledge bases (name, instruction, counts).",[453,1366,1367,1369,1373,1377],{},[468,1368,955],{},[468,1370,1371],{},[371,1372,1357],{},[468,1374,1375],{},[371,1376,554],{},[468,1378,1379,1380,478,1382,478,1385,1293],{},"Create a base (",[371,1381,688],{},[371,1383,1384],{},"instruction",[371,1386,1058],{},[453,1388,1389,1391,1396,1400],{},[468,1390,955],{},[468,1392,1393],{},[371,1394,1395],{},"\u002Fv1\u002Fknowledge-bases\u002F{id}\u002Fdocuments",[468,1397,1398],{},[371,1399,554],{},[468,1401,1402,1403,478,1405,1408],{},"Manual document (",[371,1404,688],{},[371,1406,1407],{},"content","); indexing starts automatically.",[453,1410,1411,1413,1418,1422],{},[468,1412,955],{},[468,1414,1415],{},[371,1416,1417],{},"\u002Fv1\u002Fknowledge-bases\u002F{id}\u002Fdocuments\u002Furl",[468,1419,1420],{},[371,1421,554],{},[468,1423,1424,1425,478,1427,1293],{},"Import a public web page (",[371,1426,688],{},[371,1428,1429],{},"url",[453,1431,1432,1434,1439,1443],{},[468,1433,955],{},[468,1435,1436],{},[371,1437,1438],{},"\u002Fv1\u002Fknowledge-bases\u002F{id}\u002Fdocuments\u002Fpdf",[468,1440,1441],{},[371,1442,554],{},[468,1444,1445,1446,1449],{},"PDF upload (multipart, ",[371,1447,1448],{},"file"," field).",[432,1451,213],{"id":1452},"webhooks",[447,1454,1455,1467],{},[450,1456,1457],{},[453,1458,1459,1461,1463,1465],{},[456,1460,877],{},[456,1462,880],{},[456,1464,458],{},[456,1466,883],{},[463,1468,1469,1484,1499,1519,1535],{},[453,1470,1471,1473,1477,1481],{},[468,1472,890],{},[468,1474,1475],{},[371,1476,573],{},[468,1478,1479],{},[371,1480,567],{},[468,1482,1483],{},"List registered endpoints (with delivery state).",[453,1485,1486,1488,1492,1496],{},[468,1487,955],{},[468,1489,1490],{},[371,1491,573],{},[468,1493,1494],{},[371,1495,567],{},[468,1497,1498],{},"Register an https endpoint; returns the secret exactly once.",[453,1500,1501,1504,1509,1513],{},[468,1502,1503],{},"PATCH",[468,1505,1506],{},[371,1507,1508],{},"\u002Fv1\u002Fwebhook-endpoints\u002F{id}",[468,1510,1511],{},[371,1512,567],{},[468,1514,1515,1516,1293],{},"Update url\u002Fevents\u002Fdescription or re-enable (",[371,1517,1518],{},"active: true",[453,1520,1521,1524,1528,1532],{},[468,1522,1523],{},"DELETE",[468,1525,1526],{},[371,1527,1508],{},[468,1529,1530],{},[371,1531,567],{},[468,1533,1534],{},"Remove the endpoint.",[453,1536,1537,1539,1544,1548],{},[468,1538,955],{},[468,1540,1541],{},[371,1542,1543],{},"\u002Fv1\u002Fwebhook-endpoints\u002F{id}\u002Ftest",[468,1545,1546],{},[371,1547,567],{},[468,1549,1550,1551,1554],{},"Send a signed ",[371,1552,1553],{},"ping"," to validate your receiver.",[339,1556,1557,1558,356],{},"Events, HMAC signature and retry policy: see ",[343,1559,213],{"href":214},[358,1561,1563],{"id":1562},"rate-limits","Rate limits",[339,1565,1566,1567,1570,1571,1574,1575,478,1578,1581,1582,1585],{},"Requests are limited per key (default 120 requests\u002Fminute; keys may carry their own limit set at creation via ",[371,1568,1569],{},"rate_limit_per_minute","). Over the limit, the API responds ",[371,1572,1573],{},"429"," with the ",[371,1576,1577],{},"Retry-After",[371,1579,1580],{},"X-RateLimit-Limit"," and ",[371,1583,1584],{},"X-RateLimit-Remaining"," headers.",[358,1587,1589],{"id":1588},"errors","Errors",[447,1591,1592,1602],{},[450,1593,1594],{},[453,1595,1596,1599],{},[456,1597,1598],{},"Code",[456,1600,1601],{},"Meaning",[463,1603,1604,1612,1619,1626,1633,1641,1649,1658],{},[453,1605,1606,1609],{},[468,1607,1608],{},"400",[468,1610,1611],{},"Invalid request (malformed cursor, rejected webhook URL, unknown scope…).",[453,1613,1614,1616],{},[468,1615,587],{},[468,1617,1618],{},"Key missing, invalid, revoked or expired.",[453,1620,1621,1623],{},[468,1622,445],{},[468,1624,1625],{},"Organization suspended, or the key lacks the required scope.",[453,1627,1628,1630],{},[468,1629,864],{},[468,1631,1632],{},"Resource does not exist or belongs to another organization.",[453,1634,1635,1638],{},[468,1636,1637],{},"409",[468,1639,1640],{},"Conflict (e.g. publishing an archived agent).",[453,1642,1643,1646],{},[468,1644,1645],{},"422",[468,1647,1648],{},"Validation failed (e.g. publishing an agent with an invalid flow).",[453,1650,1651,1653],{},[468,1652,1573],{},[468,1654,1655,1656,356],{},"Rate limit exceeded — honor ",[371,1657,1577],{},[453,1659,1660,1663],{},[468,1661,1662],{},"502\u002F503",[468,1664,1665],{},"Temporary upstream failure — retry with backoff.",[339,1667,1668,1669,356],{},"Error bodies follow the FastAPI format: ",[371,1670,1671],{},"{ \"detail\": \"…\" }",[358,1673,1674],{"id":355},"Future",[339,1676,1677,1678,1681],{},"Coming in later iterations of the channel: starting calls via API (once outbound telephony is connected), additional webhook events (",[371,1679,1680],{},"call.failed",", realtime call states), programmatic key management and bulk exports.",[1683,1684,1685],"style",{},"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 .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 .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}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}",{"title":369,"searchDepth":416,"depth":416,"links":1687},[1688,1689,1693,1694,1703,1704,1705],{"id":360,"depth":416,"text":361},{"id":386,"depth":416,"text":209,"children":1690},[1691,1692],{"id":434,"depth":723,"text":435},{"id":576,"depth":723,"text":577},{"id":594,"depth":416,"text":595},{"id":858,"depth":416,"text":217,"children":1695},[1696,1697,1698,1699,1700,1701,1702],{"id":867,"depth":723,"text":868},{"id":901,"depth":723,"text":902},{"id":1082,"depth":723,"text":1083},{"id":1233,"depth":723,"text":1234},{"id":1296,"depth":723,"text":241},{"id":1331,"depth":723,"text":1332},{"id":1452,"depth":723,"text":213},{"id":1562,"depth":416,"text":1563},{"id":1588,"depth":416,"text":1589},{"id":355,"depth":416,"text":1674},"Access your organization's data over REST with API keys.","md",null,{},true,{"title":205,"description":1706},"7hznOORpyWWHrePE2nHMtj7JBkReuPwddbz16Egtl_g",[1714,1716],{"title":199,"path":200,"stem":201,"description":1715,"children":-1},"Integrate with Diska over REST using API keys — agents, calls, analytics and webhooks.",{"title":209,"path":210,"stem":211,"description":1717,"children":-1},"API keys for integrations and Better Auth sessions for the backoffice.",1786954568445]