[{"data":1,"prerenderedAt":352},["ShallowReactive",2],{"docs-navigation":3,"page-\u002Fintegrations\u002Frest-api":167,"surround-\u002Fintegrations\u002Frest-api":347},[4,27,54,81,100,127,151,163],{"title":5,"icon":6,"path":7,"stem":8,"children":9},"Getting started","i-lucide-rocket","\u002Fgetting-started","1.getting-started",[10,12,17,22],{"title":5,"path":7,"stem":11},"1.getting-started\u002Findex",{"title":13,"path":14,"stem":15,"icon":16},"Sign in","\u002Fgetting-started\u002Fsign-in","1.getting-started\u002F1.sign-in","i-lucide-key-round",{"title":18,"path":19,"stem":20,"icon":21},"Your organisation","\u002Fgetting-started\u002Fyour-organisation","1.getting-started\u002F2.your-organisation","i-lucide-users",{"title":23,"path":24,"stem":25,"icon":26},"Account settings","\u002Fgetting-started\u002Faccount-settings","1.getting-started\u002F3.account-settings","i-lucide-shield-check",{"title":28,"icon":29,"path":30,"stem":31,"children":32},"Using SynkVault","i-lucide-message-square","\u002Fusing-synkvault","2.using-synkvault",[33,35,39,44,49],{"title":28,"path":30,"stem":34},"2.using-synkvault\u002Findex",{"title":36,"path":37,"stem":38,"icon":29},"Chat","\u002Fusing-synkvault\u002Fchat","2.using-synkvault\u002F1.chat",{"title":40,"path":41,"stem":42,"icon":43},"Explorer","\u002Fusing-synkvault\u002Fexplorer","2.using-synkvault\u002F2.explorer","i-lucide-network",{"title":45,"path":46,"stem":47,"icon":48},"Focus mode","\u002Fusing-synkvault\u002Ffocus-mode","2.using-synkvault\u002F3.focus-mode","i-lucide-info",{"title":50,"path":51,"stem":52,"icon":53},"My Inbox","\u002Fusing-synkvault\u002Fmy-documents","2.using-synkvault\u002F4.my-documents","i-lucide-file-text",{"title":55,"icon":43,"path":56,"stem":57,"children":58},"Ontology","\u002Fontology","3.ontology",[59,61,65,69,73,77],{"title":55,"path":56,"stem":60},"3.ontology\u002Findex",{"title":62,"path":63,"stem":64},"Set up your ontology","\u002Fontology\u002Fset-up-your-ontology","3.ontology\u002F1.set-up-your-ontology",{"title":66,"path":67,"stem":68},"Nodes and properties","\u002Fontology\u002Fnodes-and-properties","3.ontology\u002F2.nodes-and-properties",{"title":70,"path":71,"stem":72},"References","\u002Fontology\u002Freferences","3.ontology\u002F3.references",{"title":74,"path":75,"stem":76},"Improve with drafts","\u002Fontology\u002Fimprove-with-drafts","3.ontology\u002F4.improve-with-drafts",{"title":78,"path":79,"stem":80},"History and management","\u002Fontology\u002Fhistory-and-management","3.ontology\u002F5.history-and-management",{"title":82,"icon":53,"path":83,"stem":84,"children":85},"Documents and feeds","\u002Fdocuments-and-feeds","4.documents-and-feeds",[86,88,92,96],{"title":82,"path":83,"stem":87},"4.documents-and-feeds\u002Findex",{"title":89,"path":90,"stem":91},"Documents inbox","\u002Fdocuments-and-feeds\u002Fdocuments-inbox","4.documents-and-feeds\u002F1.documents-inbox",{"title":93,"path":94,"stem":95},"Create a feed","\u002Fdocuments-and-feeds\u002Fcreate-a-feed","4.documents-and-feeds\u002F2.create-a-feed",{"title":97,"path":98,"stem":99},"Triggers and history","\u002Fdocuments-and-feeds\u002Ftriggers-and-history","4.documents-and-feeds\u002F3.triggers-and-history",{"title":101,"icon":26,"path":102,"stem":103,"children":104},"Administration","\u002Fadministration","5.administration",[105,107,111,115,119,123],{"title":101,"path":102,"stem":106},"5.administration\u002Findex",{"title":108,"path":109,"stem":110},"Dashboard","\u002Fadministration\u002Fdashboard","5.administration\u002F1.dashboard",{"title":112,"path":113,"stem":114},"Users and invitations","\u002Fadministration\u002Fusers-and-invitations","5.administration\u002F2.users-and-invitations",{"title":116,"path":117,"stem":118},"Organisation settings","\u002Fadministration\u002Forganisation-settings","5.administration\u002F3.organisation-settings",{"title":120,"path":121,"stem":122},"Billing","\u002Fadministration\u002Fbilling","5.administration\u002F4.billing",{"title":124,"path":125,"stem":126},"Data ingestion and query","\u002Fadministration\u002Fdata-ingestion-and-query","5.administration\u002F5.data-ingestion-and-query",{"title":128,"icon":129,"path":130,"stem":131,"children":132},"Integrations","i-lucide-plug","\u002Fintegrations","6.integrations",[133,135,139,143,147],{"title":128,"path":130,"stem":134},"6.integrations\u002Findex",{"title":136,"path":137,"stem":138},"AI providers","\u002Fintegrations\u002Fai-providers","6.integrations\u002F1.ai-providers",{"title":140,"path":141,"stem":142},"API keys","\u002Fintegrations\u002Fapi-keys","6.integrations\u002F2.api-keys",{"title":144,"path":145,"stem":146},"REST API","\u002Fintegrations\u002Frest-api","6.integrations\u002F3.rest-api",{"title":148,"path":149,"stem":150},"Apps","\u002Fintegrations\u002Fapps","6.integrations\u002F4.apps",{"title":152,"icon":153,"path":154,"stem":155,"children":156},"Troubleshooting","i-lucide-life-buoy","\u002Ftroubleshooting","7.troubleshooting",[157,159],{"title":152,"path":154,"stem":158},"7.troubleshooting\u002Findex",{"title":160,"path":161,"stem":162},"Frequently asked questions","\u002Ftroubleshooting\u002Ffaq","7.troubleshooting\u002F1.faq",{"title":164,"path":165,"stem":166},"SynkVault documentation","\u002F","index",{"id":168,"title":144,"body":169,"description":341,"extension":342,"meta":343,"navigation":344,"path":145,"seo":345,"stem":146,"__hash__":346},"docs_en\u002F6.integrations\u002F3.rest-api.md",{"type":170,"value":171,"toc":336},"minimark",[172,176,181,215,219,266,269,273,326,332],[173,174,175],"p",{},"The REST API lets your software read your knowledge base without using the web app.",[177,178,180],"h2",{"id":179},"base-path-and-sign-in","Base path and sign-in",[182,183,184,193,205],"ul",{},[185,186,187,188,192],"li",{},"All routes start with ",[189,190,191],"code",{},"\u002Fapi\u002Fv1"," on your SynkVault address.",[185,194,195,196,200,201,204],{},"Send your ",[197,198,199],"a",{"href":141},"API key"," in the ",[189,202,203],{},"X-Api-Key"," header.",[185,206,207,208,211,212,214],{},"Every route except the health check needs your organisation ID as the ",[189,209,210],{},"org_id"," query parameter. You can copy it from ",[197,213,116],{"href":117},". Your key only works for organisations it has access to.",[177,216,218],{"id":217},"example-request","Example request",[220,221,226],"pre",{"className":222,"code":223,"language":224,"meta":225,"style":225},"language-bash shiki shiki-themes material-theme-lighter material-theme-lighter material-theme-palenight","curl \"https:\u002F\u002F\u003Cyour-synkvault-address>\u002Fapi\u002Fv1\u002Fontology?org_id=\u003Cyour-organisation-id>\" \\\n  -H \"X-Api-Key: \u003Cyour-api-key>\"\n","bash","",[189,227,228,252],{"__ignoreMap":225},[229,230,233,237,241,245,248],"span",{"class":231,"line":232},"line",1,[229,234,236],{"class":235},"s52Pk","curl",[229,238,240],{"class":239},"sDfIl"," \"",[229,242,244],{"class":243},"sGFVr","https:\u002F\u002F\u003Cyour-synkvault-address>\u002Fapi\u002Fv1\u002Fontology?org_id=\u003Cyour-organisation-id>",[229,246,247],{"class":239},"\"",[229,249,251],{"class":250},"sZSNi"," \\\n",[229,253,255,258,260,263],{"class":231,"line":254},2,[229,256,257],{"class":243},"  -H",[229,259,240],{"class":239},[229,261,262],{"class":243},"X-Api-Key: \u003Cyour-api-key>",[229,264,265],{"class":239},"\"\n",[173,267,268],{},"This returns the ontology nodes of your organisation.",[177,270,272],{"id":271},"common-responses","Common responses",[274,275,276,289],"table",{},[277,278,279],"thead",{},[280,281,282,286],"tr",{},[283,284,285],"th",{},"Status",[283,287,288],{},"Meaning",[290,291,292,303,316],"tbody",{},[280,293,294,300],{},[295,296,297],"td",{},[189,298,299],{},"401",[295,301,302],{},"The key is missing or invalid.",[280,304,305,310],{},[295,306,307],{},[189,308,309],{},"400",[295,311,312,313,315],{},"The ",[189,314,210],{}," query parameter is missing.",[280,317,318,323],{},[295,319,320],{},[189,321,322],{},"403",[295,324,325],{},"The key has no access to that organisation.",[327,328,329],"note",{},[173,330,331],{},"Ask your administrator for the address of your SynkVault deployment. Keep your key secret. If it may have been shared, create a new one and delete the old one.",[333,334,335],"style",{},"html pre.shiki code .s52Pk, html code.shiki .s52Pk{--shiki-light:#E2931D;--shiki-default:#E2931D;--shiki-dark:#FFCB6B}html pre.shiki code .sDfIl, html code.shiki .sDfIl{--shiki-light:#39ADB5;--shiki-default:#39ADB5;--shiki-dark:#89DDFF}html pre.shiki code .sGFVr, html code.shiki .sGFVr{--shiki-light:#91B859;--shiki-default:#91B859;--shiki-dark:#C3E88D}html pre.shiki code .sZSNi, html code.shiki .sZSNi{--shiki-light:#90A4AE;--shiki-default:#90A4AE;--shiki-dark:#BABED8}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":225,"searchDepth":254,"depth":254,"links":337},[338,339,340],{"id":179,"depth":254,"text":180},{"id":217,"depth":254,"text":218},{"id":271,"depth":254,"text":272},"An overview of calling SynkVault from your own software.","md",{},null,{"title":144,"description":341},"7zk0WbV1Ircpi6c2o2jaJ0vJMLuvYOBsy_eDIlzBYH8",[348,350],{"title":140,"path":141,"stem":142,"description":349,"children":-1},"Create a service account and an API key for programs that call SynkVault.",{"title":148,"path":149,"stem":150,"description":351,"children":-1},"Enable or disable apps for your organisation and review what they may do.",1794301178816]