[{"data":1,"prerenderedAt":1525},["ShallowReactive",2],{"doc-sdks\u002Fnodejs":3,"content-query-agFomL784h":4},null,{"_path":5,"_dir":6,"_draft":7,"_partial":7,"_locale":8,"title":9,"description":8,"sidebar_position":10,"body":11,"_type":1519,"_id":1520,"_source":1521,"_file":1522,"_stem":1523,"_extension":1524},"\u002Fdocs\u002Fsdks\u002Fnodejs","sdks",false,"","Node.js SDK",1,{"type":12,"children":13,"toc":1510},"root",[14,22,39,70,77,82,114,147,152,175,188,194,207,445,454,483,489,494,637,661,666,672,677,802,814,820,1080,1086,1449,1458,1464,1469,1499,1504],{"type":15,"tag":16,"props":17,"children":19},"element","h1",{"id":18},"nodejs-sdk",[20],{"type":21,"value":9},"text",{"type":15,"tag":23,"props":24,"children":29},"div",{"className":25,"ariaHidden":28},[26,27],"docs-page-hero","docs-page-hero--sage","true",[30,32],{"type":21,"value":31},"\n  ",{"type":15,"tag":33,"props":34,"children":38},"img",{"src":35,"alt":8,"width":36,"height":37},"\u002Fimages\u002Fdocs-illustrations\u002Fsdks.svg",128,72,[],{"type":15,"tag":40,"props":41,"children":42},"p",{},[43,45,52,54,60,62,68],{"type":21,"value":44},"The local Node.js SDK package is named ",{"type":15,"tag":46,"props":47,"children":49},"code",{"className":48},[],[50],{"type":21,"value":51},"credvault-edge",{"type":21,"value":53}," and is version ",{"type":15,"tag":46,"props":55,"children":57},{"className":56},[],[58],{"type":21,"value":59},"1.0.0",{"type":21,"value":61},". The SDK code includes TypeScript definitions and exposes a ",{"type":15,"tag":46,"props":63,"children":65},{"className":64},[],[66],{"type":21,"value":67},"CredVault",{"type":21,"value":69}," client with resources for data, CIE, webhooks, functions, triggers, backups, schema, API keys, metrics, logs, notifications, settings, robots, orchestration, lineage, metadata, notebooks, pipelines, dashboards, alerts, realtime streams, and agent sessions.",{"type":15,"tag":71,"props":72,"children":74},"h2",{"id":73},"installation",[75],{"type":21,"value":76},"Installation",{"type":15,"tag":40,"props":78,"children":79},{},[80],{"type":21,"value":81},"Install from the local package artifact provided by CredVault:",{"type":15,"tag":83,"props":84,"children":88},"pre",{"className":85,"code":86,"language":87,"meta":8,"style":8},"language-bash shiki shiki-themes github-dark","npm install .\u002Fcredvault-edge-1.0.0.tgz\n","bash",[89],{"type":15,"tag":46,"props":90,"children":91},{"__ignoreMap":8},[92],{"type":15,"tag":93,"props":94,"children":96},"span",{"class":95,"line":10},"line",[97,103,109],{"type":15,"tag":93,"props":98,"children":100},{"style":99},"--shiki-default:#B392F0",[101],{"type":21,"value":102},"npm",{"type":15,"tag":93,"props":104,"children":106},{"style":105},"--shiki-default:#9ECBFF",[107],{"type":21,"value":108}," install",{"type":15,"tag":93,"props":110,"children":111},{"style":105},[112],{"type":21,"value":113}," .\u002Fcredvault-edge-1.0.0.tgz\n",{"type":15,"tag":40,"props":115,"children":116},{},[117,123,125,131,133,138,140,145],{"type":15,"tag":118,"props":119,"children":120},"strong",{},[121],{"type":21,"value":122},"What you should see:",{"type":21,"value":124}," npm should add the package to your project. Your ",{"type":15,"tag":46,"props":126,"children":128},{"className":127},[],[129],{"type":21,"value":130},"package.json",{"type":21,"value":132}," should include ",{"type":15,"tag":46,"props":134,"children":136},{"className":135},[],[137],{"type":21,"value":51},{"type":21,"value":139},", and your code editor should recognize the ",{"type":15,"tag":46,"props":141,"children":143},{"className":142},[],[144],{"type":21,"value":67},{"type":21,"value":146}," import.",{"type":15,"tag":40,"props":148,"children":149},{},[150],{"type":21,"value":151},"The following name is not the current Node.js SDK package:",{"type":15,"tag":83,"props":153,"children":155},{"className":85,"code":154,"language":87,"meta":8,"style":8},"npm install credvault-sdk\n",[156],{"type":15,"tag":46,"props":157,"children":158},{"__ignoreMap":8},[159],{"type":15,"tag":93,"props":160,"children":161},{"class":95,"line":10},[162,166,170],{"type":15,"tag":93,"props":163,"children":164},{"style":99},[165],{"type":21,"value":102},{"type":15,"tag":93,"props":167,"children":168},{"style":105},[169],{"type":21,"value":108},{"type":15,"tag":93,"props":171,"children":172},{"style":105},[173],{"type":21,"value":174}," credvault-sdk\n",{"type":15,"tag":40,"props":176,"children":177},{},[178,180,186],{"type":21,"value":179},"The public npm package ",{"type":15,"tag":46,"props":181,"children":183},{"className":182},[],[184],{"type":21,"value":185},"credvault-cie",{"type":21,"value":187}," is the CLI package, not this Node.js application SDK.",{"type":15,"tag":71,"props":189,"children":191},{"id":190},"connecting-to-credvault",[192],{"type":21,"value":193},"Connecting to CredVault",{"type":15,"tag":40,"props":195,"children":196},{},[197,199,205],{"type":21,"value":198},"The SDK defaults to ",{"type":15,"tag":46,"props":200,"children":202},{"className":201},[],[203],{"type":21,"value":204},"http:\u002F\u002Flocalhost:5000\u002Fapi",{"type":21,"value":206},", which is only for local backend development. Production apps must pass the CredVault backend API URL.",{"type":15,"tag":83,"props":208,"children":212},{"className":209,"code":210,"language":211,"meta":8,"style":8},"language-javascript shiki shiki-themes github-dark","import { CredVault } from \"credvault-edge\";\n\nconst credvault = new CredVault({\n  apiKey: process.env.CREDVAULT_API_KEY,\n  baseUrl: \"https:\u002F\u002F\u003Cyour-credvault-backend>\u002Fapi\",\n});\n\nconst customers = await credvault.data.query(\"customers\", {\n  status: \"active\",\n});\n\nconsole.log(customers);\n","javascript",[213],{"type":15,"tag":46,"props":214,"children":215},{"__ignoreMap":8},[216,246,256,291,310,328,337,345,392,410,418,426],{"type":15,"tag":93,"props":217,"children":218},{"class":95,"line":10},[219,225,231,236,241],{"type":15,"tag":93,"props":220,"children":222},{"style":221},"--shiki-default:#F97583",[223],{"type":21,"value":224},"import",{"type":15,"tag":93,"props":226,"children":228},{"style":227},"--shiki-default:#E1E4E8",[229],{"type":21,"value":230}," { CredVault } ",{"type":15,"tag":93,"props":232,"children":233},{"style":221},[234],{"type":21,"value":235},"from",{"type":15,"tag":93,"props":237,"children":238},{"style":105},[239],{"type":21,"value":240}," \"credvault-edge\"",{"type":15,"tag":93,"props":242,"children":243},{"style":227},[244],{"type":21,"value":245},";\n",{"type":15,"tag":93,"props":247,"children":249},{"class":95,"line":248},2,[250],{"type":15,"tag":93,"props":251,"children":253},{"emptyLinePlaceholder":252},true,[254],{"type":21,"value":255},"\n",{"type":15,"tag":93,"props":257,"children":259},{"class":95,"line":258},3,[260,265,271,276,281,286],{"type":15,"tag":93,"props":261,"children":262},{"style":221},[263],{"type":21,"value":264},"const",{"type":15,"tag":93,"props":266,"children":268},{"style":267},"--shiki-default:#79B8FF",[269],{"type":21,"value":270}," credvault",{"type":15,"tag":93,"props":272,"children":273},{"style":221},[274],{"type":21,"value":275}," =",{"type":15,"tag":93,"props":277,"children":278},{"style":221},[279],{"type":21,"value":280}," new",{"type":15,"tag":93,"props":282,"children":283},{"style":99},[284],{"type":21,"value":285}," CredVault",{"type":15,"tag":93,"props":287,"children":288},{"style":227},[289],{"type":21,"value":290},"({\n",{"type":15,"tag":93,"props":292,"children":294},{"class":95,"line":293},4,[295,300,305],{"type":15,"tag":93,"props":296,"children":297},{"style":227},[298],{"type":21,"value":299},"  apiKey: process.env.",{"type":15,"tag":93,"props":301,"children":302},{"style":267},[303],{"type":21,"value":304},"CREDVAULT_API_KEY",{"type":15,"tag":93,"props":306,"children":307},{"style":227},[308],{"type":21,"value":309},",\n",{"type":15,"tag":93,"props":311,"children":313},{"class":95,"line":312},5,[314,319,324],{"type":15,"tag":93,"props":315,"children":316},{"style":227},[317],{"type":21,"value":318},"  baseUrl: ",{"type":15,"tag":93,"props":320,"children":321},{"style":105},[322],{"type":21,"value":323},"\"https:\u002F\u002F\u003Cyour-credvault-backend>\u002Fapi\"",{"type":15,"tag":93,"props":325,"children":326},{"style":227},[327],{"type":21,"value":309},{"type":15,"tag":93,"props":329,"children":331},{"class":95,"line":330},6,[332],{"type":15,"tag":93,"props":333,"children":334},{"style":227},[335],{"type":21,"value":336},"});\n",{"type":15,"tag":93,"props":338,"children":340},{"class":95,"line":339},7,[341],{"type":15,"tag":93,"props":342,"children":343},{"emptyLinePlaceholder":252},[344],{"type":21,"value":255},{"type":15,"tag":93,"props":346,"children":348},{"class":95,"line":347},8,[349,353,358,362,367,372,377,382,387],{"type":15,"tag":93,"props":350,"children":351},{"style":221},[352],{"type":21,"value":264},{"type":15,"tag":93,"props":354,"children":355},{"style":267},[356],{"type":21,"value":357}," customers",{"type":15,"tag":93,"props":359,"children":360},{"style":221},[361],{"type":21,"value":275},{"type":15,"tag":93,"props":363,"children":364},{"style":221},[365],{"type":21,"value":366}," await",{"type":15,"tag":93,"props":368,"children":369},{"style":227},[370],{"type":21,"value":371}," credvault.data.",{"type":15,"tag":93,"props":373,"children":374},{"style":99},[375],{"type":21,"value":376},"query",{"type":15,"tag":93,"props":378,"children":379},{"style":227},[380],{"type":21,"value":381},"(",{"type":15,"tag":93,"props":383,"children":384},{"style":105},[385],{"type":21,"value":386},"\"customers\"",{"type":15,"tag":93,"props":388,"children":389},{"style":227},[390],{"type":21,"value":391},", {\n",{"type":15,"tag":93,"props":393,"children":395},{"class":95,"line":394},9,[396,401,406],{"type":15,"tag":93,"props":397,"children":398},{"style":227},[399],{"type":21,"value":400},"  status: ",{"type":15,"tag":93,"props":402,"children":403},{"style":105},[404],{"type":21,"value":405},"\"active\"",{"type":15,"tag":93,"props":407,"children":408},{"style":227},[409],{"type":21,"value":309},{"type":15,"tag":93,"props":411,"children":413},{"class":95,"line":412},10,[414],{"type":15,"tag":93,"props":415,"children":416},{"style":227},[417],{"type":21,"value":336},{"type":15,"tag":93,"props":419,"children":421},{"class":95,"line":420},11,[422],{"type":15,"tag":93,"props":423,"children":424},{"emptyLinePlaceholder":252},[425],{"type":21,"value":255},{"type":15,"tag":93,"props":427,"children":429},{"class":95,"line":428},12,[430,435,440],{"type":15,"tag":93,"props":431,"children":432},{"style":227},[433],{"type":21,"value":434},"console.",{"type":15,"tag":93,"props":436,"children":437},{"style":99},[438],{"type":21,"value":439},"log",{"type":15,"tag":93,"props":441,"children":442},{"style":227},[443],{"type":21,"value":444},"(customers);\n",{"type":15,"tag":40,"props":446,"children":447},{},[448,452],{"type":15,"tag":118,"props":449,"children":450},{},[451],{"type":21,"value":122},{"type":21,"value":453}," an array or paginated response containing matching records. If the API key is invalid, you should see an authentication error from CredVault rather than a JavaScript import error.",{"type":15,"tag":40,"props":455,"children":456},{},[457,459,465,467,473,475,481],{"type":21,"value":458},"Use ",{"type":15,"tag":46,"props":460,"children":462},{"className":461},[],[463],{"type":21,"value":464},"apiKey",{"type":21,"value":466}," for server-to-server data routes such as ",{"type":15,"tag":46,"props":468,"children":470},{"className":469},[],[471],{"type":21,"value":472},"\u002Fapi\u002Fv1\u002Fdata",{"type":21,"value":474},". Use ",{"type":15,"tag":46,"props":476,"children":478},{"className":477},[],[479],{"type":21,"value":480},"token",{"type":21,"value":482}," when acting on behalf of a signed-in user for routes such as clusters, functions, webhooks, logs, settings, and API-key management.",{"type":15,"tag":71,"props":484,"children":486},{"id":485},"working-with-data",[487],{"type":21,"value":488},"Working with Data",{"type":15,"tag":40,"props":490,"children":491},{},[492],{"type":21,"value":493},"The data resource calls the platform's data and cluster APIs.",{"type":15,"tag":83,"props":495,"children":497},{"className":209,"code":496,"language":211,"meta":8,"style":8},"const customers = await credvault.data.query(\"customers\", {\n  status: \"active\",\n});\n\nawait credvault.data.insert(\"customers\", {\n  name: \"Acme Ltd\",\n  status: \"active\",\n});\n",[498],{"type":15,"tag":46,"props":499,"children":500},{"__ignoreMap":8},[501,540,555,562,569,598,615,630],{"type":15,"tag":93,"props":502,"children":503},{"class":95,"line":10},[504,508,512,516,520,524,528,532,536],{"type":15,"tag":93,"props":505,"children":506},{"style":221},[507],{"type":21,"value":264},{"type":15,"tag":93,"props":509,"children":510},{"style":267},[511],{"type":21,"value":357},{"type":15,"tag":93,"props":513,"children":514},{"style":221},[515],{"type":21,"value":275},{"type":15,"tag":93,"props":517,"children":518},{"style":221},[519],{"type":21,"value":366},{"type":15,"tag":93,"props":521,"children":522},{"style":227},[523],{"type":21,"value":371},{"type":15,"tag":93,"props":525,"children":526},{"style":99},[527],{"type":21,"value":376},{"type":15,"tag":93,"props":529,"children":530},{"style":227},[531],{"type":21,"value":381},{"type":15,"tag":93,"props":533,"children":534},{"style":105},[535],{"type":21,"value":386},{"type":15,"tag":93,"props":537,"children":538},{"style":227},[539],{"type":21,"value":391},{"type":15,"tag":93,"props":541,"children":542},{"class":95,"line":248},[543,547,551],{"type":15,"tag":93,"props":544,"children":545},{"style":227},[546],{"type":21,"value":400},{"type":15,"tag":93,"props":548,"children":549},{"style":105},[550],{"type":21,"value":405},{"type":15,"tag":93,"props":552,"children":553},{"style":227},[554],{"type":21,"value":309},{"type":15,"tag":93,"props":556,"children":557},{"class":95,"line":258},[558],{"type":15,"tag":93,"props":559,"children":560},{"style":227},[561],{"type":21,"value":336},{"type":15,"tag":93,"props":563,"children":564},{"class":95,"line":293},[565],{"type":15,"tag":93,"props":566,"children":567},{"emptyLinePlaceholder":252},[568],{"type":21,"value":255},{"type":15,"tag":93,"props":570,"children":571},{"class":95,"line":312},[572,577,581,586,590,594],{"type":15,"tag":93,"props":573,"children":574},{"style":221},[575],{"type":21,"value":576},"await",{"type":15,"tag":93,"props":578,"children":579},{"style":227},[580],{"type":21,"value":371},{"type":15,"tag":93,"props":582,"children":583},{"style":99},[584],{"type":21,"value":585},"insert",{"type":15,"tag":93,"props":587,"children":588},{"style":227},[589],{"type":21,"value":381},{"type":15,"tag":93,"props":591,"children":592},{"style":105},[593],{"type":21,"value":386},{"type":15,"tag":93,"props":595,"children":596},{"style":227},[597],{"type":21,"value":391},{"type":15,"tag":93,"props":599,"children":600},{"class":95,"line":330},[601,606,611],{"type":15,"tag":93,"props":602,"children":603},{"style":227},[604],{"type":21,"value":605},"  name: ",{"type":15,"tag":93,"props":607,"children":608},{"style":105},[609],{"type":21,"value":610},"\"Acme Ltd\"",{"type":15,"tag":93,"props":612,"children":613},{"style":227},[614],{"type":21,"value":309},{"type":15,"tag":93,"props":616,"children":617},{"class":95,"line":339},[618,622,626],{"type":15,"tag":93,"props":619,"children":620},{"style":227},[621],{"type":21,"value":400},{"type":15,"tag":93,"props":623,"children":624},{"style":105},[625],{"type":21,"value":405},{"type":15,"tag":93,"props":627,"children":628},{"style":227},[629],{"type":21,"value":309},{"type":15,"tag":93,"props":631,"children":632},{"class":95,"line":347},[633],{"type":15,"tag":93,"props":634,"children":635},{"style":227},[636],{"type":21,"value":336},{"type":15,"tag":40,"props":638,"children":639},{},[640,644,646,652,654,659],{"type":15,"tag":118,"props":641,"children":642},{},[643],{"type":21,"value":122},{"type":21,"value":645}," the query returns existing ",{"type":15,"tag":46,"props":647,"children":649},{"className":648},[],[650],{"type":21,"value":651},"customers",{"type":21,"value":653}," records, and the insert call creates a new ",{"type":15,"tag":46,"props":655,"children":657},{"className":656},[],[658],{"type":21,"value":651},{"type":21,"value":660}," document that appears in the dashboard.",{"type":15,"tag":40,"props":662,"children":663},{},[664],{"type":21,"value":665},"Use the dashboard or API docs to confirm collection names and request fields before shipping production code.",{"type":15,"tag":71,"props":667,"children":669},{"id":668},"cie",[670],{"type":21,"value":671},"CIE",{"type":15,"tag":40,"props":673,"children":674},{},[675],{"type":21,"value":676},"The CIE resource is for Intelligence Engine workflows such as datasets, training, and predictions.",{"type":15,"tag":83,"props":678,"children":680},{"className":209,"code":679,"language":211,"meta":8,"style":8},"const models = await credvault.cie.listModels();\nconst prediction = await credvault.cie.predict(\"model-id\", {\n  amount: 1200,\n  region: \"emea\",\n});\n",[681],{"type":15,"tag":46,"props":682,"children":683},{"__ignoreMap":8},[684,719,761,778,795],{"type":15,"tag":93,"props":685,"children":686},{"class":95,"line":10},[687,691,696,700,704,709,714],{"type":15,"tag":93,"props":688,"children":689},{"style":221},[690],{"type":21,"value":264},{"type":15,"tag":93,"props":692,"children":693},{"style":267},[694],{"type":21,"value":695}," models",{"type":15,"tag":93,"props":697,"children":698},{"style":221},[699],{"type":21,"value":275},{"type":15,"tag":93,"props":701,"children":702},{"style":221},[703],{"type":21,"value":366},{"type":15,"tag":93,"props":705,"children":706},{"style":227},[707],{"type":21,"value":708}," credvault.cie.",{"type":15,"tag":93,"props":710,"children":711},{"style":99},[712],{"type":21,"value":713},"listModels",{"type":15,"tag":93,"props":715,"children":716},{"style":227},[717],{"type":21,"value":718},"();\n",{"type":15,"tag":93,"props":720,"children":721},{"class":95,"line":248},[722,726,731,735,739,743,748,752,757],{"type":15,"tag":93,"props":723,"children":724},{"style":221},[725],{"type":21,"value":264},{"type":15,"tag":93,"props":727,"children":728},{"style":267},[729],{"type":21,"value":730}," prediction",{"type":15,"tag":93,"props":732,"children":733},{"style":221},[734],{"type":21,"value":275},{"type":15,"tag":93,"props":736,"children":737},{"style":221},[738],{"type":21,"value":366},{"type":15,"tag":93,"props":740,"children":741},{"style":227},[742],{"type":21,"value":708},{"type":15,"tag":93,"props":744,"children":745},{"style":99},[746],{"type":21,"value":747},"predict",{"type":15,"tag":93,"props":749,"children":750},{"style":227},[751],{"type":21,"value":381},{"type":15,"tag":93,"props":753,"children":754},{"style":105},[755],{"type":21,"value":756},"\"model-id\"",{"type":15,"tag":93,"props":758,"children":759},{"style":227},[760],{"type":21,"value":391},{"type":15,"tag":93,"props":762,"children":763},{"class":95,"line":258},[764,769,774],{"type":15,"tag":93,"props":765,"children":766},{"style":227},[767],{"type":21,"value":768},"  amount: ",{"type":15,"tag":93,"props":770,"children":771},{"style":267},[772],{"type":21,"value":773},"1200",{"type":15,"tag":93,"props":775,"children":776},{"style":227},[777],{"type":21,"value":309},{"type":15,"tag":93,"props":779,"children":780},{"class":95,"line":293},[781,786,791],{"type":15,"tag":93,"props":782,"children":783},{"style":227},[784],{"type":21,"value":785},"  region: ",{"type":15,"tag":93,"props":787,"children":788},{"style":105},[789],{"type":21,"value":790},"\"emea\"",{"type":15,"tag":93,"props":792,"children":793},{"style":227},[794],{"type":21,"value":309},{"type":15,"tag":93,"props":796,"children":797},{"class":95,"line":312},[798],{"type":15,"tag":93,"props":799,"children":800},{"style":227},[801],{"type":21,"value":336},{"type":15,"tag":40,"props":803,"children":804},{},[805,807,812],{"type":21,"value":806},"For terminal workflows, users can also use the ",{"type":15,"tag":46,"props":808,"children":810},{"className":809},[],[811],{"type":21,"value":668},{"type":21,"value":813}," CLI.",{"type":15,"tag":71,"props":815,"children":817},{"id":816},"available-resources",[818],{"type":21,"value":819},"Available Resources",{"type":15,"tag":821,"props":822,"children":823},"ul",{},[824,836,847,857,868,879,890,901,912,923,934,945,962,973,984,995,1006,1017,1028,1039,1058,1069],{"type":15,"tag":825,"props":826,"children":827},"li",{},[828,834],{"type":15,"tag":46,"props":829,"children":831},{"className":830},[],[832],{"type":21,"value":833},"auth",{"type":21,"value":835}," for sign-in, sign-up, and profile calls",{"type":15,"tag":825,"props":837,"children":838},{},[839,845],{"type":15,"tag":46,"props":840,"children":842},{"className":841},[],[843],{"type":21,"value":844},"data",{"type":21,"value":846}," for clusters and collection data",{"type":15,"tag":825,"props":848,"children":849},{},[850,855],{"type":15,"tag":46,"props":851,"children":853},{"className":852},[],[854],{"type":21,"value":668},{"type":21,"value":856}," for datasets, models, and predictions",{"type":15,"tag":825,"props":858,"children":859},{},[860,866],{"type":15,"tag":46,"props":861,"children":863},{"className":862},[],[864],{"type":21,"value":865},"webhooks",{"type":21,"value":867}," for event delivery",{"type":15,"tag":825,"props":869,"children":870},{},[871,877],{"type":15,"tag":46,"props":872,"children":874},{"className":873},[],[875],{"type":21,"value":876},"functions",{"type":21,"value":878}," for serverless functions",{"type":15,"tag":825,"props":880,"children":881},{},[882,888],{"type":15,"tag":46,"props":883,"children":885},{"className":884},[],[886],{"type":21,"value":887},"triggers",{"type":21,"value":889}," for collection events",{"type":15,"tag":825,"props":891,"children":892},{},[893,899],{"type":15,"tag":46,"props":894,"children":896},{"className":895},[],[897],{"type":21,"value":898},"backups",{"type":21,"value":900}," for backup and restore",{"type":15,"tag":825,"props":902,"children":903},{},[904,910],{"type":15,"tag":46,"props":905,"children":907},{"className":906},[],[908],{"type":21,"value":909},"schema",{"type":21,"value":911}," for schema and indexes",{"type":15,"tag":825,"props":913,"children":914},{},[915,921],{"type":15,"tag":46,"props":916,"children":918},{"className":917},[],[919],{"type":21,"value":920},"apiKeys",{"type":21,"value":922}," for API key management",{"type":15,"tag":825,"props":924,"children":925},{},[926,932],{"type":15,"tag":46,"props":927,"children":929},{"className":928},[],[930],{"type":21,"value":931},"metrics",{"type":21,"value":933}," for platform monitoring",{"type":15,"tag":825,"props":935,"children":936},{},[937,943],{"type":15,"tag":46,"props":938,"children":940},{"className":939},[],[941],{"type":21,"value":942},"logs",{"type":21,"value":944}," for activity and audit logs",{"type":15,"tag":825,"props":946,"children":947},{},[948,954,956],{"type":15,"tag":46,"props":949,"children":951},{"className":950},[],[952],{"type":21,"value":953},"notifications",{"type":21,"value":955}," for notifications; preference methods should be checked against ",{"type":15,"tag":46,"props":957,"children":959},{"className":958},[],[960],{"type":21,"value":961},"\u002Fapi-docs",{"type":15,"tag":825,"props":963,"children":964},{},[965,971],{"type":15,"tag":46,"props":966,"children":968},{"className":967},[],[969],{"type":21,"value":970},"settings",{"type":21,"value":972}," for account settings, but some methods still need backend route alignment",{"type":15,"tag":825,"props":974,"children":975},{},[976,982],{"type":15,"tag":46,"props":977,"children":979},{"className":978},[],[980],{"type":21,"value":981},"robots",{"type":21,"value":983}," for robot\u002Fdevice endpoints, but this area still needs route alignment before it is public-ready",{"type":15,"tag":825,"props":985,"children":986},{},[987,993],{"type":15,"tag":46,"props":988,"children":990},{"className":989},[],[991],{"type":21,"value":992},"orchestration",{"type":21,"value":994}," for jobs, runs, assets, sensors, schedules, and launching jobs",{"type":15,"tag":825,"props":996,"children":997},{},[998,1004],{"type":15,"tag":46,"props":999,"children":1001},{"className":1000},[],[1002],{"type":21,"value":1003},"lineage",{"type":21,"value":1005}," for namespaces, datasets, jobs, runs, versions, search, and lineage",{"type":15,"tag":825,"props":1007,"children":1008},{},[1009,1015],{"type":15,"tag":46,"props":1010,"children":1012},{"className":1011},[],[1013],{"type":21,"value":1014},"metadata",{"type":21,"value":1016}," for tables, databases, search, and lineage",{"type":15,"tag":825,"props":1018,"children":1019},{},[1020,1026],{"type":15,"tag":46,"props":1021,"children":1023},{"className":1022},[],[1024],{"type":21,"value":1025},"notebooks",{"type":21,"value":1027}," for notebook operations and code execution",{"type":15,"tag":825,"props":1029,"children":1030},{},[1031,1037],{"type":15,"tag":46,"props":1032,"children":1034},{"className":1033},[],[1035],{"type":21,"value":1036},"pipelines",{"type":21,"value":1038}," for creating, running, and inspecting pipelines",{"type":15,"tag":825,"props":1040,"children":1041},{},[1042,1048,1050,1056],{"type":15,"tag":46,"props":1043,"children":1045},{"className":1044},[],[1046],{"type":21,"value":1047},"dashboards",{"type":21,"value":1049}," and ",{"type":15,"tag":46,"props":1051,"children":1053},{"className":1052},[],[1054],{"type":21,"value":1055},"alerts",{"type":21,"value":1057}," for operational monitoring",{"type":15,"tag":825,"props":1059,"children":1060},{},[1061,1067],{"type":15,"tag":46,"props":1062,"children":1064},{"className":1063},[],[1065],{"type":21,"value":1066},"realtime",{"type":21,"value":1068}," for stream management and WebSocket stream URLs",{"type":15,"tag":825,"props":1070,"children":1071},{},[1072,1078],{"type":15,"tag":46,"props":1073,"children":1075},{"className":1074},[],[1076],{"type":21,"value":1077},"agentSessions",{"type":21,"value":1079}," for authenticated agent session and event calls",{"type":15,"tag":71,"props":1081,"children":1083},{"id":1082},"platform-integrations",[1084],{"type":21,"value":1085},"Platform Integrations",{"type":15,"tag":83,"props":1087,"children":1089},{"className":209,"code":1088,"language":211,"meta":8,"style":8},"const jobs = await credvault.orchestration.listJobs();\nawait credvault.orchestration.runJob(\"daily_customer_refresh\");\n\nconst lineage = await credvault.lineage.getLineage({\n  nodeId: \"dataset:customers\",\n  depth: 3,\n  direction: \"DOWNSTREAM\",\n});\n\nconst metadata = await credvault.metadata.search({ q: \"customers\" });\n\nconst pipelineRun = await credvault.pipelines.run(\"pipeline-id\");\nconst dashboardData = await credvault.dashboards.data(\"dashboard-id\");\n\nawait credvault.alerts.recordMetric(\"alert-id\", 92.5);\n",[1090],{"type":15,"tag":46,"props":1091,"children":1092},{"__ignoreMap":8},[1093,1127,1157,1164,1198,1215,1232,1249,1256,1263,1307,1314,1357,1400,1408],{"type":15,"tag":93,"props":1094,"children":1095},{"class":95,"line":10},[1096,1100,1105,1109,1113,1118,1123],{"type":15,"tag":93,"props":1097,"children":1098},{"style":221},[1099],{"type":21,"value":264},{"type":15,"tag":93,"props":1101,"children":1102},{"style":267},[1103],{"type":21,"value":1104}," jobs",{"type":15,"tag":93,"props":1106,"children":1107},{"style":221},[1108],{"type":21,"value":275},{"type":15,"tag":93,"props":1110,"children":1111},{"style":221},[1112],{"type":21,"value":366},{"type":15,"tag":93,"props":1114,"children":1115},{"style":227},[1116],{"type":21,"value":1117}," credvault.orchestration.",{"type":15,"tag":93,"props":1119,"children":1120},{"style":99},[1121],{"type":21,"value":1122},"listJobs",{"type":15,"tag":93,"props":1124,"children":1125},{"style":227},[1126],{"type":21,"value":718},{"type":15,"tag":93,"props":1128,"children":1129},{"class":95,"line":248},[1130,1134,1138,1143,1147,1152],{"type":15,"tag":93,"props":1131,"children":1132},{"style":221},[1133],{"type":21,"value":576},{"type":15,"tag":93,"props":1135,"children":1136},{"style":227},[1137],{"type":21,"value":1117},{"type":15,"tag":93,"props":1139,"children":1140},{"style":99},[1141],{"type":21,"value":1142},"runJob",{"type":15,"tag":93,"props":1144,"children":1145},{"style":227},[1146],{"type":21,"value":381},{"type":15,"tag":93,"props":1148,"children":1149},{"style":105},[1150],{"type":21,"value":1151},"\"daily_customer_refresh\"",{"type":15,"tag":93,"props":1153,"children":1154},{"style":227},[1155],{"type":21,"value":1156},");\n",{"type":15,"tag":93,"props":1158,"children":1159},{"class":95,"line":258},[1160],{"type":15,"tag":93,"props":1161,"children":1162},{"emptyLinePlaceholder":252},[1163],{"type":21,"value":255},{"type":15,"tag":93,"props":1165,"children":1166},{"class":95,"line":293},[1167,1171,1176,1180,1184,1189,1194],{"type":15,"tag":93,"props":1168,"children":1169},{"style":221},[1170],{"type":21,"value":264},{"type":15,"tag":93,"props":1172,"children":1173},{"style":267},[1174],{"type":21,"value":1175}," lineage",{"type":15,"tag":93,"props":1177,"children":1178},{"style":221},[1179],{"type":21,"value":275},{"type":15,"tag":93,"props":1181,"children":1182},{"style":221},[1183],{"type":21,"value":366},{"type":15,"tag":93,"props":1185,"children":1186},{"style":227},[1187],{"type":21,"value":1188}," credvault.lineage.",{"type":15,"tag":93,"props":1190,"children":1191},{"style":99},[1192],{"type":21,"value":1193},"getLineage",{"type":15,"tag":93,"props":1195,"children":1196},{"style":227},[1197],{"type":21,"value":290},{"type":15,"tag":93,"props":1199,"children":1200},{"class":95,"line":312},[1201,1206,1211],{"type":15,"tag":93,"props":1202,"children":1203},{"style":227},[1204],{"type":21,"value":1205},"  nodeId: ",{"type":15,"tag":93,"props":1207,"children":1208},{"style":105},[1209],{"type":21,"value":1210},"\"dataset:customers\"",{"type":15,"tag":93,"props":1212,"children":1213},{"style":227},[1214],{"type":21,"value":309},{"type":15,"tag":93,"props":1216,"children":1217},{"class":95,"line":330},[1218,1223,1228],{"type":15,"tag":93,"props":1219,"children":1220},{"style":227},[1221],{"type":21,"value":1222},"  depth: ",{"type":15,"tag":93,"props":1224,"children":1225},{"style":267},[1226],{"type":21,"value":1227},"3",{"type":15,"tag":93,"props":1229,"children":1230},{"style":227},[1231],{"type":21,"value":309},{"type":15,"tag":93,"props":1233,"children":1234},{"class":95,"line":339},[1235,1240,1245],{"type":15,"tag":93,"props":1236,"children":1237},{"style":227},[1238],{"type":21,"value":1239},"  direction: ",{"type":15,"tag":93,"props":1241,"children":1242},{"style":105},[1243],{"type":21,"value":1244},"\"DOWNSTREAM\"",{"type":15,"tag":93,"props":1246,"children":1247},{"style":227},[1248],{"type":21,"value":309},{"type":15,"tag":93,"props":1250,"children":1251},{"class":95,"line":347},[1252],{"type":15,"tag":93,"props":1253,"children":1254},{"style":227},[1255],{"type":21,"value":336},{"type":15,"tag":93,"props":1257,"children":1258},{"class":95,"line":394},[1259],{"type":15,"tag":93,"props":1260,"children":1261},{"emptyLinePlaceholder":252},[1262],{"type":21,"value":255},{"type":15,"tag":93,"props":1264,"children":1265},{"class":95,"line":412},[1266,1270,1275,1279,1283,1288,1293,1298,1302],{"type":15,"tag":93,"props":1267,"children":1268},{"style":221},[1269],{"type":21,"value":264},{"type":15,"tag":93,"props":1271,"children":1272},{"style":267},[1273],{"type":21,"value":1274}," metadata",{"type":15,"tag":93,"props":1276,"children":1277},{"style":221},[1278],{"type":21,"value":275},{"type":15,"tag":93,"props":1280,"children":1281},{"style":221},[1282],{"type":21,"value":366},{"type":15,"tag":93,"props":1284,"children":1285},{"style":227},[1286],{"type":21,"value":1287}," credvault.metadata.",{"type":15,"tag":93,"props":1289,"children":1290},{"style":99},[1291],{"type":21,"value":1292},"search",{"type":15,"tag":93,"props":1294,"children":1295},{"style":227},[1296],{"type":21,"value":1297},"({ q: ",{"type":15,"tag":93,"props":1299,"children":1300},{"style":105},[1301],{"type":21,"value":386},{"type":15,"tag":93,"props":1303,"children":1304},{"style":227},[1305],{"type":21,"value":1306}," });\n",{"type":15,"tag":93,"props":1308,"children":1309},{"class":95,"line":420},[1310],{"type":15,"tag":93,"props":1311,"children":1312},{"emptyLinePlaceholder":252},[1313],{"type":21,"value":255},{"type":15,"tag":93,"props":1315,"children":1316},{"class":95,"line":428},[1317,1321,1326,1330,1334,1339,1344,1348,1353],{"type":15,"tag":93,"props":1318,"children":1319},{"style":221},[1320],{"type":21,"value":264},{"type":15,"tag":93,"props":1322,"children":1323},{"style":267},[1324],{"type":21,"value":1325}," pipelineRun",{"type":15,"tag":93,"props":1327,"children":1328},{"style":221},[1329],{"type":21,"value":275},{"type":15,"tag":93,"props":1331,"children":1332},{"style":221},[1333],{"type":21,"value":366},{"type":15,"tag":93,"props":1335,"children":1336},{"style":227},[1337],{"type":21,"value":1338}," credvault.pipelines.",{"type":15,"tag":93,"props":1340,"children":1341},{"style":99},[1342],{"type":21,"value":1343},"run",{"type":15,"tag":93,"props":1345,"children":1346},{"style":227},[1347],{"type":21,"value":381},{"type":15,"tag":93,"props":1349,"children":1350},{"style":105},[1351],{"type":21,"value":1352},"\"pipeline-id\"",{"type":15,"tag":93,"props":1354,"children":1355},{"style":227},[1356],{"type":21,"value":1156},{"type":15,"tag":93,"props":1358,"children":1360},{"class":95,"line":1359},13,[1361,1365,1370,1374,1378,1383,1387,1391,1396],{"type":15,"tag":93,"props":1362,"children":1363},{"style":221},[1364],{"type":21,"value":264},{"type":15,"tag":93,"props":1366,"children":1367},{"style":267},[1368],{"type":21,"value":1369}," dashboardData",{"type":15,"tag":93,"props":1371,"children":1372},{"style":221},[1373],{"type":21,"value":275},{"type":15,"tag":93,"props":1375,"children":1376},{"style":221},[1377],{"type":21,"value":366},{"type":15,"tag":93,"props":1379,"children":1380},{"style":227},[1381],{"type":21,"value":1382}," credvault.dashboards.",{"type":15,"tag":93,"props":1384,"children":1385},{"style":99},[1386],{"type":21,"value":844},{"type":15,"tag":93,"props":1388,"children":1389},{"style":227},[1390],{"type":21,"value":381},{"type":15,"tag":93,"props":1392,"children":1393},{"style":105},[1394],{"type":21,"value":1395},"\"dashboard-id\"",{"type":15,"tag":93,"props":1397,"children":1398},{"style":227},[1399],{"type":21,"value":1156},{"type":15,"tag":93,"props":1401,"children":1403},{"class":95,"line":1402},14,[1404],{"type":15,"tag":93,"props":1405,"children":1406},{"emptyLinePlaceholder":252},[1407],{"type":21,"value":255},{"type":15,"tag":93,"props":1409,"children":1411},{"class":95,"line":1410},15,[1412,1416,1421,1426,1430,1435,1440,1445],{"type":15,"tag":93,"props":1413,"children":1414},{"style":221},[1415],{"type":21,"value":576},{"type":15,"tag":93,"props":1417,"children":1418},{"style":227},[1419],{"type":21,"value":1420}," credvault.alerts.",{"type":15,"tag":93,"props":1422,"children":1423},{"style":99},[1424],{"type":21,"value":1425},"recordMetric",{"type":15,"tag":93,"props":1427,"children":1428},{"style":227},[1429],{"type":21,"value":381},{"type":15,"tag":93,"props":1431,"children":1432},{"style":105},[1433],{"type":21,"value":1434},"\"alert-id\"",{"type":15,"tag":93,"props":1436,"children":1437},{"style":227},[1438],{"type":21,"value":1439},", ",{"type":15,"tag":93,"props":1441,"children":1442},{"style":267},[1443],{"type":21,"value":1444},"92.5",{"type":15,"tag":93,"props":1446,"children":1447},{"style":227},[1448],{"type":21,"value":1156},{"type":15,"tag":40,"props":1450,"children":1451},{},[1452,1456],{"type":15,"tag":118,"props":1453,"children":1454},{},[1455],{"type":21,"value":122},{"type":21,"value":1457}," each call should return the platform resource it touched, such as job lists, lineage results, metadata matches, pipeline run state, dashboard data, or metric acknowledgement.",{"type":15,"tag":71,"props":1459,"children":1461},{"id":1460},"security",[1462],{"type":21,"value":1463},"Security",{"type":15,"tag":40,"props":1465,"children":1466},{},[1467],{"type":21,"value":1468},"Keep API keys in environment variables:",{"type":15,"tag":83,"props":1470,"children":1472},{"className":85,"code":1471,"language":87,"meta":8,"style":8},"export CREDVAULT_API_KEY=\"...\"\n",[1473],{"type":15,"tag":46,"props":1474,"children":1475},{"__ignoreMap":8},[1476],{"type":15,"tag":93,"props":1477,"children":1478},{"class":95,"line":10},[1479,1484,1489,1494],{"type":15,"tag":93,"props":1480,"children":1481},{"style":221},[1482],{"type":21,"value":1483},"export",{"type":15,"tag":93,"props":1485,"children":1486},{"style":227},[1487],{"type":21,"value":1488}," CREDVAULT_API_KEY",{"type":15,"tag":93,"props":1490,"children":1491},{"style":221},[1492],{"type":21,"value":1493},"=",{"type":15,"tag":93,"props":1495,"children":1496},{"style":105},[1497],{"type":21,"value":1498},"\"...\"\n",{"type":15,"tag":40,"props":1500,"children":1501},{},[1502],{"type":21,"value":1503},"Never put API keys in frontend browser code. This SDK should be used from trusted backend code, scripts, workers, and CI jobs.",{"type":15,"tag":1505,"props":1506,"children":1507},"style",{},[1508],{"type":21,"value":1509},"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);}",{"title":8,"searchDepth":248,"depth":248,"links":1511},[1512,1513,1514,1515,1516,1517,1518],{"id":73,"depth":248,"text":76},{"id":190,"depth":248,"text":193},{"id":485,"depth":248,"text":488},{"id":668,"depth":248,"text":671},{"id":816,"depth":248,"text":819},{"id":1082,"depth":248,"text":1085},{"id":1460,"depth":248,"text":1463},"markdown","content:docs:sdks:nodejs.md","content","docs\u002Fsdks\u002Fnodejs.md","docs\u002Fsdks\u002Fnodejs","md",1794695981469]