To use CyborgDB, you’ll need an API key that authenticates your requests and determines your service capabilities. This guide will walk you through the process of signing up and generating your API key.
Enter your email address and create a secure password
Verify your email address by clicking the link sent to your inbox
Complete your profile setup
Your account starts with access to free API keys by default.
2
Choose Your Plan (Optional)
If you need production capabilities, upgrade to a paid plan.
Navigate to the “Billing” section in your dashboard
Review the available plans and features
Select the plan that best fits your needs
Complete the payment setup
Plan Disclosure: Paid plans unlock cyborgdb-core with unlimited vectors, GPU acceleration, and all backing stores. Free plans have a 1M item limite per index. You can always start free and upgrade later.
3
Generate Your API Key
Create a new API key from your dashboard.
In your CyborgDB dashboard, locate the “API Keys” section
Click the “Add” button next to “API Keys”
CyborgDB Dashboard - API Keys Section
4
Copy and Secure Your API Key
Your API key will be generated and displayed.
CyborgDB Dashboard - API Key Generated
Important: Copy your API key immediately and store it securely. For security reasons, you won’t be able to see the full key again after leaving this page.
Best Practices:
Store your API key in environment variables, not in your code
Never commit API keys to version control
Use different keys for development and production environments
Rotate keys regularly for enhanced security
Using Your API Key
Once you have your API key, you can use it with any CyborgDB deployment:
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"CyborgDB Docs","description":"Documentation for CyborgDB, the Confidential Vector Database.","colors":{"primary":"#10A3AE","light":"#5DC3CA","dark":"#314656"},"logo":{"light":"https://mintcdn.com/cyborg/o5z3-JbkwPXf99Si/images/logo/cyborgdb-docs-light.svg?fit=max\u0026auto=format\u0026n=o5z3-JbkwPXf99Si\u0026q=85\u0026s=bbb0a6cc479d27f584896c628b66b73d","dark":"https://mintcdn.com/cyborg/o5z3-JbkwPXf99Si/images/logo/cyborgdb-docs-dark.svg?fit=max\u0026auto=format\u0026n=o5z3-JbkwPXf99Si\u0026q=85\u0026s=fe902ba2a6f1b755aa4d58a35c06612e"},"favicon":"https://mintcdn.com/cyborg/o5z3-JbkwPXf99Si/images/favicon-light.svg?fit=max\u0026auto=format\u0026n=o5z3-JbkwPXf99Si\u0026q=85\u0026s=ea79e6f8996aea0934264cb309ca5795","navbar":{"links":[{"href":"/quickstart","label":"Quickstart"},{"href":"https://www.cyborg.co/contact","label":"Support"}],"primary":{"type":"button","label":"Get API Key","href":"https://cyborgdb.co/new"}},"footer":{"socials":{"x":"https://x.com/CyborgHQ","github":"https://github.com/cyborginc","linkedin":"https://linkedin.com/company/cyborginc","website":"https://www.cyborg.co"}},"search":{"prompt":"Search documentation..."},"seo":{"metatags":{"description":"Documentation for CyborgDB, the Confidential Vector Database","keywords":"vector database, encryption, confidential computing, AI, RAG"}},"integrations":{"plausible":{"domain":"docs.cyborg.co","server":"d1w0psmo3bkh8z.cloudfront.net"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cyborg","hasAudioNarration":false,"actualSubdomain":"cyborg","customDomains":["docs.cyborg.co"],"gitSource":{"type":"github","owner":"cyborginc","repo":"cyborgdb-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afb40ad988193f87805845e","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"CyborgDB Service","count":109},{"language":"default","tag":"Encrypted Index","count":47},{"language":"default","tag":"Guides","count":43},{"language":"default","tag":"CyborgDB Embedded","count":37},{"language":"default","tag":"Client","count":31},{"language":"default","tag":"Python SDK Reference","count":22},{"language":"default","tag":"REST API Reference","count":21},{"language":"default","tag":"Introduction","count":20},{"language":"default","tag":"Go SDK Reference","count":20},{"language":"default","tag":"JS/TS SDK Reference","count":20}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@cyborg.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"div[class*=\"mt-8\"][class*=\"lg:mt-0\"][class*=\"flex\"][class*=\"xl:hidden\"]{display:none!important}"}]}
{"page":{"pagePath":"versions/v0.16.x/intro/get-api-key","slug":"/versions/v0.16.x/intro/get-api-key","pageMetadata":{"title":"Getting an API Key","sidebarTitle":"Get an API Key","mode":"wide","noindex":true,"description":null,"href":"/versions/v0.16.x/intro/get-api-key"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,hr:`hr`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,Frame,Heading,Note,OptimizedImage,Step,Steps,Tab,Tabs,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`To use CyborgDB, you’ll need an API key that authenticates your requests and determines your service capabilities. This guide will walk you through the process of signing up and generating your API key.`}),`\n`,_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`CyborgDB offers both free and paid API keys:`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsxs(Card,{title:`Free API Key`,icon:`gift`,children:[_jsx(_components.p,{children:_jsx(_components.em,{children:`Perfect for evaluation and testing`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Up to 1M vectors maximum`}),`\n`,_jsx(_components.li,{children:`Community support`}),`\n`]})]}),_jsxs(Card,{title:`Paid API Key`,icon:`credit-card`,children:[_jsx(_components.p,{children:_jsx(_components.em,{children:`Full production capabilities`})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Access to `,_jsx(_components.code,{children:`cyborgdb-core`}),` features`]}),`\n`,_jsx(_components.li,{children:`Unlimited items and vectors`}),`\n`,_jsx(_components.li,{children:`All backing stores (PostgreSQL, Redis, Memory)`}),`\n`,_jsx(_components.li,{children:`GPU acceleration support`}),`\n`,_jsx(_components.li,{children:`Priority support`}),`\n`]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`step-by-step-guide`,children:`Step-by-Step Guide`}),`\n`,_jsxs(Steps,{children:[_jsxs(Step,{title:`Sign Up for CyborgDB`,children:[_jsxs(_components.p,{children:[`Visit `,_jsx(_components.a,{href:`https://cyborgdb.co`,children:`cyborgdb.co`}),` and create your account.`]}),_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`“Sign Up”`}),` in the top navigation`]}),`\n`,_jsx(_components.li,{children:`Enter your email address and create a secure password`}),`\n`,_jsx(_components.li,{children:`Verify your email address by clicking the link sent to your inbox`}),`\n`,_jsx(_components.li,{children:`Complete your profile setup`}),`\n`]}),_jsx(Note,{children:_jsx(_components.p,{children:`Your account starts with access to free API keys by default.`})})]}),_jsxs(Step,{title:`Choose Your Plan (Optional)`,children:[_jsx(_components.p,{children:`If you need production capabilities, upgrade to a paid plan.`}),_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Navigate to the `,_jsx(_components.strong,{children:`“Billing”`}),` section in your dashboard`]}),`\n`,_jsx(_components.li,{children:`Review the available plans and features`}),`\n`,_jsx(_components.li,{children:`Select the plan that best fits your needs`}),`\n`,_jsx(_components.li,{children:`Complete the payment setup`}),`\n`]}),_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Plan Disclosure`}),`: Paid plans unlock `,_jsx(_components.code,{children:`cyborgdb-core`}),` with unlimited vectors, GPU acceleration, and all backing stores. Free plans have a 1M item limite per index. You can always start free and upgrade later.`]})})]}),_jsxs(Step,{title:`Generate Your API Key`,children:[_jsx(_components.p,{children:`Create a new API key from your dashboard.`}),_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`In your CyborgDB dashboard, locate the `,_jsx(_components.strong,{children:`“API Keys”`}),` section`]}),`\n`,_jsxs(_components.li,{children:[`Click the `,_jsx(_components.strong,{children:`“Add”`}),` button next to “API Keys”`]}),`\n`]}),_jsx(Frame,{caption:`CyborgDB Dashboard - API Keys Section`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-create-api-key.png?fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=92a9c1d24ff3c459a118eea46067980a`,alt:`Screenshot of CyborgDB Dashboard with API Keys 'Add' button highlighted`,\"data-og-width\":`3464`,width:`3464`,\"data-og-height\":`2566`,height:`2566`,\"data-path\":`images/cyborgdb-dashboard-create-api-key.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-create-api-key.png?w=280\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=39b59703710db6cec22e9c2c1cc6235d 280w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-create-api-key.png?w=560\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=9df95f1e5dbaa39a835ca94a297e8cd9 560w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-create-api-key.png?w=840\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=7f19abe0055ca694b5b7ce1f20e12369 840w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-create-api-key.png?w=1100\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=f95d4b4847440de0f0c45898d1dd7136 1100w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-create-api-key.png?w=1650\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=595ccb9028de5d08a2f89bdac8983b1d 1650w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-create-api-key.png?w=2500\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=ca6992de02f3af5425c32d16ac151734 2500w`})})]}),_jsxs(Step,{title:`Copy and Secure Your API Key`,children:[_jsx(_components.p,{children:`Your API key will be generated and displayed.`}),_jsx(Frame,{caption:`CyborgDB Dashboard - API Key Generated`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-api-key-created.png?fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=c58f991a49804f9f41f5ba416fe0c261`,alt:`Screenshot of CyborgDB Dashboard showing generated API key`,\"data-og-width\":`3464`,width:`3464`,\"data-og-height\":`2566`,height:`2566`,\"data-path\":`images/cyborgdb-dashboard-api-key-created.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-api-key-created.png?w=280\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=98ad5be05833125dd99d928b213cef75 280w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-api-key-created.png?w=560\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=4264e3fb814553190308d6dac296c7fc 560w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-api-key-created.png?w=840\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=5087bb4cb0299970938391ff5fe17316 840w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-api-key-created.png?w=1100\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=fe992d3acb9dae51abc47933f67a0f74 1100w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-api-key-created.png?w=1650\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=3defeef4db9ce9f0ee29baabe0413d53 1650w, https://mintcdn.com/cyborg/kXyFWu9saA_TjOzS/images/cyborgdb-dashboard-api-key-created.png?w=2500\u0026fit=max\u0026auto=format\u0026n=kXyFWu9saA_TjOzS\u0026q=85\u0026s=211c70d62302ccbd9f78c3ec3ec46423 2500w`})}),_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Important`}),`: Copy your API key immediately and store it securely. For security reasons, you won’t be able to see the full key again after leaving this page.`]})}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Best Practices:`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Store your API key in environment variables, not in your code`}),`\n`,_jsx(_components.li,{children:`Never commit API keys to version control`}),`\n`,_jsx(_components.li,{children:`Use different keys for development and production environments`}),`\n`,_jsx(_components.li,{children:`Rotate keys regularly for enhanced security`}),`\n`]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`using-your-api-key`,children:`Using Your API Key`}),`\n`,_jsx(_components.p,{children:`Once you have your API key, you can use it with any CyborgDB deployment:`}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Environment Variable (Recommended)`,id:`environment-variable-recommended`,children:[_jsx(_components.p,{children:`Set your API key as an environment variable:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` CYBORGDB_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-api-key-here\"`})]}),`\n`]})})}),_jsx(_components.p,{children:`Then reference it in your code:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb_core `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Client`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Client(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`os.getenv(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CYBORGDB_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`))`})]}),`\n`]})})})]}),_jsxs(Tab,{title:`Direct Usage`,id:`direct-usage`,children:[_jsx(_components.p,{children:`Use your API key directly in your code (not recommended for production):`}),_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb_core `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Client`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Client(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-api-key-here\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})})]}),_jsxs(Tab,{title:`Configuration File`,id:`configuration-file`,children:[_jsx(_components.p,{children:`Store in a configuration file that’s excluded from version control:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# config.py (add to .gitignore)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:`CYBORGDB_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"your-api-key-here\"`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# main.py`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` config `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:` CYBORGDB_API_KEY`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb_core `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Client`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Client(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:`CYBORGDB_API_KEY`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`managing-your-api-keys`,children:`Managing Your API Keys`}),`\n`,_jsx(Heading,{level:`3`,id:`dashboard-management`,children:`Dashboard Management`}),`\n`,_jsx(_components.p,{children:`From your CyborgDB dashboard, you can:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`View all API keys`}),` - See all keys associated with your account`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Create new keys`}),` - Generate additional keys for different projects`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Revoke keys`}),` - Disable keys that are no longer needed`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Monitor usage`}),` - Track API key usage and performance`]}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next Steps`}),`\n`,_jsxs(CardGroup,{cols:3,children:[_jsxs(Card,{title:`Start Building`,href:`/versions/v0.16.x/intro/quickstart`,icon:`rocket`,children:[_jsx(_components.p,{children:_jsx(_components.em,{children:`Jump into the quickstart guide`})}),_jsx(_components.p,{children:`Use your new API key to get started with CyborgDB`})]}),_jsxs(Card,{title:`Choose Deployment`,href:`/versions/v0.16.x/intro/deployment-models`,icon:`server`,children:[_jsx(_components.p,{children:_jsx(_components.em,{children:`Service vs Embedded`})}),_jsx(_components.p,{children:`Decide between CyborgDB Service or Embedded libraries`})]}),_jsxs(Card,{title:`Framework Integration`,href:`/versions/v0.16.x/integrations/langchain/introduction`,icon:`plug`,children:[_jsx(_components.p,{children:_jsx(_components.em,{children:`LangChain integration`})}),_jsx(_components.p,{children:`Replace your existing vector store with CyborgDB`})]})]}),`\n`,_jsx(_components.p,{children:`Got your API key? You’re ready to start building confidential AI applications!`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Getting an API Key","sidebarTitle":"Get an API Key","mode":"wide","noindex":true,"description":null,"href":"/versions/v0.16.x/intro/get-api-key"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"Step-by-Step Guide","slug":"step-by-step-guide","depth":2,"children":[]},{"title":"Using Your API Key","slug":"using-your-api-key","depth":2,"children":[]},{"title":"Managing Your API Keys","slug":"managing-your-api-keys","depth":2,"children":[{"title":"Dashboard Management","slug":"dashboard-management","depth":3,"children":[]}]},{"title":"Next Steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"cyborg","siteName":"CyborgDB Docs","title":"Getting an API Key - CyborgDB Docs","navMaps":{"firstHrefInVersion":{"v0.18.x":{"href":"/versions/latest/intro/get-api-key","matchLevel":1},"v0.17.x":{"href":"/versions/v0.17.x/intro/get-api-key","matchLevel":1,"noindex":true},"v0.16.x":{"href":"/versions/v0.16.x/intro/get-api-key","matchLevel":0},"v0.15.x":{"href":"/versions/v0.15.x/intro/get-api-key","matchLevel":1,"noindex":true}},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T18:55:56.539Z","originalFileLocation":"versions/v0.16.x/intro/get-api-key.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Documentation for CyborgDB, the Confidential Vector Database\">\u003cmeta data-mint-head name=\"keywords\" content=\"vector database, encryption, confidential computing, AI, RAG\">\u003cmeta data-mint-head name=\"application-name\" content=\"CyborgDB Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting an API Key - CyborgDB Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Documentation for CyborgDB, the Confidential Vector Database\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CyborgDB Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cyborg.co/versions/v0.16.x/intro/get-api-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cyborg.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Getting+an+API+Key\u0026amp;theme=0150e3d458a38d4dcc0f6e24\u0026amp;signature=a4667bba700e8c5f7e2ccb10e14329c302de47fb8bd55c692316533d034796c1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Getting an API Key - CyborgDB Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Documentation for CyborgDB, the Confidential Vector Database\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cyborg.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Getting+an+API+Key\u0026amp;theme=0150e3d458a38d4dcc0f6e24\u0026amp;signature=a4667bba700e8c5f7e2ccb10e14329c302de47fb8bd55c692316533d034796c1\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CyborgDB Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#10A3AE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cyborg.co/versions/v0.16.x/intro/get-api-key\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/versions/v0.16.x/intro/get-api-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CyborgDB Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"CyborgDB Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/versions/v0.16.x/intro/get-api-key.md","siteName":"CyborgDB Docs","nav":{"global":null,"versions":[{"version":"v0.18.x","tag":"Latest","pages":[{"title":"v0.18.x","href":"/versions/latest/intro/get-api-key"}]},{"version":"v0.17.x","pages":[{"title":"v0.17.x","href":"/versions/v0.17.x/intro/get-api-key"}]},{"version":"v0.16.x","tabs":[{"tab":"Introduction","groups":[{"group":"CyborgDB Docs","pages":[{"title":"CyborgDB Docs","sidebarTitle":"Introduction","mode":"wide","href":""},{"title":"About CyborgDB","href":"/versions/v0.16.x/intro/about"},{"title":"Deployment Models","href":"/versions/v0.16.x/intro/deployment-models"},{"title":"Backing Stores","href":"/versions/v0.16.x/intro/backing-stores"}]},{"group":"Getting Started","pages":[{"title":"Quickstart Guide","sidebarTitle":"Quickstart","mode":"wide","description":null,"href":"/versions/v0.16.x/intro/quickstart"},{"title":"Getting an API Key","sidebarTitle":"Get an API Key","mode":"wide","href":"/versions/v0.16.x/intro/get-api-key"},{"title":"Using the Docs","mode":"wide","description":null,"href":"/versions/v0.16.x/intro/using-docs"},{"title":"Migrating from Another Vector Database","sidebarTitle":"Migration","mode":"wide","href":"/versions/v0.16.x/intro/migrate"}]},{"group":"Security","pages":[{"title":"Security Overview","sidebarTitle":"Overview","href":"/versions/v0.16.x/intro/security-overview"},{"title":"Threat Model","href":"/versions/v0.16.x/intro/threat-model"},{"title":"Embedding Inversion","sidebarTitle":"Embedding Inversion","href":"/versions/v0.16.x/intro/embedding-inversion"},{"title":"Encryption","href":"/versions/v0.16.x/intro/encryption"}]},{"group":"Resources","pages":[{"title":"CyborgDB Release Notes","sidebarTitle":"Release Notes","mode":"wide","href":"/changelog"},{"title":"Open Source","sidebarTitle":"Open Source","mode":"wide","href":"/versions/v0.16.x/intro/open-source"}]}]},{"tab":"CyborgDB Service","dropdowns":[{"dropdown":"Guides","icon":"book","groups":[{"group":"CyborgDB Service","pages":[{"title":"CyborgDB Service","sidebarTitle":"Introduction","mode":"wide","href":"/versions/v0.16.x/service/guides/intro/about"},{"title":"Python Service Quickstart","sidebarTitle":"Python Quickstart","mode":"wide","href":"/versions/v0.16.x/service/guides/intro/quickstart-python"},{"title":"Docker Service Quickstart","sidebarTitle":"Docker Quickstart","mode":"wide","href":"/versions/v0.16.x/service/guides/intro/quickstart-docker"}]},{"group":"Encrypted Indexes","pages":[{"title":"Introduction to Encrypted Indexes","sidebarTitle":"Introduction","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/introduction"},{"title":"Create Client","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/create-client"},{"title":"Create a New Encrypted Index","sidebarTitle":"Create New Index","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/create-index"},{"title":"Load an Existing Encrypted Index","sidebarTitle":"Load Existing Index","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/load-index"},{"title":"List Encrypted Indexes","sidebarTitle":"List Indexes","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/list-indexes"},{"title":"Delete an Encrypted Index","sidebarTitle":"Delete Index","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/delete-index"}]},{"group":"Data Operations","pages":[{"title":"Add Items to an Encrypted Index","sidebarTitle":"Add Items","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/add-items"},{"title":"Query Encrypted Index","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/query"},{"title":"Metadata Filtering","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/metadata-filtering"},{"title":"Get Encrypted Items","sidebarTitle":"Get Items","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/get-items"},{"title":"Delete Encrypted Items","sidebarTitle":"Delete Items","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/delete-items"}]},{"group":"Advanced","pages":[{"title":"Managing Encryption Keys","href":"/versions/v0.16.x/service/guides/advanced/managing-keys"},{"title":"Environment Variables","mode":"wide","href":"/versions/v0.16.x/service/guides/advanced/env-vars"},{"title":"Configure an Encrypted Index","sidebarTitle":"Configure Index","href":"/versions/v0.16.x/service/guides/advanced/configure-index"},{"title":"Train an Encrypted Index","sidebarTitle":"Train Index","mode":"wide","href":"/versions/v0.16.x/service/guides/advanced/train-index"},{"title":"CyborgDB Usage Telemetry","sidebarTitle":"Usage Telemetry","mode":"wide","href":"/versions/v0.16.x/service/guides/advanced/usage-telemetry"}]}]},{"dropdown":"REST API Reference","icon":"rectangle-terminal","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB REST API Reference","sidebarTitle":"REST API Introduction","mode":"wide","href":"/versions/v0.16.x/service/rest-api/introduction"}]},{"group":"Client","pages":[{"title":"Health Check","mode":"wide","api":"GET /v1/health","playground":"simple","href":"/versions/v0.16.x/service/rest-api/client/get-health"},{"title":"Create Index","mode":"wide","api":"POST /v1/indexes/create","playground":"simple","href":"/versions/v0.16.x/service/rest-api/client/create-index"},{"title":"List Indexes","mode":"wide","api":"GET /v1/indexes/list","playground":"simple","href":"/versions/v0.16.x/service/rest-api/client/list-indexes"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert Vectors","mode":"wide","api":"POST /v1/vectors/upsert","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/upsert"},{"title":"Query Vectors","mode":"wide","api":"POST /v1/vectors/query","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/query"},{"title":"Train Index","mode":"wide","api":"POST /v1/indexes/train","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/train"},{"title":"Get Vectors","mode":"wide","api":"POST /v1/vectors/get","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/get"},{"title":"Delete Vectors","mode":"wide","api":"POST /v1/vectors/delete","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","api":"POST /v1/indexes/delete","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/delete-index"}]},{"group":"Types \u0026 Getters","pages":[{"title":"Describe Index","mode":"wide","api":"POST /v1/indexes/describe","playground":"simple","href":"/versions/v0.16.x/service/rest-api/getters/describe-index"},{"title":"Get Vector Count","mode":"wide","api":"POST /v1/vectors/num_vectors","playground":"simple","href":"/versions/v0.16.x/service/rest-api/getters/get-vector-count"}]}]},{"dropdown":"Python SDK Reference","icon":"python","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB - Python SDK Reference","sidebarTitle":"Python SDK Introduction","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/client"},{"title":"Get Health","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/get-health"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/list-indexes"},{"title":"Generate Key","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/generate-key"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/upsert"},{"title":"Query","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/query"},{"title":"Train","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/train"},{"title":"Get","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/get"},{"title":"List IDs","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/list-ids"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/delete-index"}]},{"group":"Types \u0026 Helpers","pages":[{"title":"Getters","href":"/versions/v0.16.x/service/python-sdk/getters"},{"title":"Types","href":"/versions/v0.16.x/service/python-sdk/types"}]}]},{"dropdown":"JS/TS SDK Reference","icon":"js","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB - JavaScript/TypeScript SDK Reference","sidebarTitle":"JS/TS SDK Introduction","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/client"},{"title":"Get Health","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/get-health"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/list-indexes"},{"title":"Generate Key","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/generate-key"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/upsert"},{"title":"Query","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/query"},{"title":"Train","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/train"},{"title":"Get","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/get"},{"title":"List IDs","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/list-ids"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/delete-index"}]},{"group":"Types \u0026 Helpers","pages":[{"title":"Getters","href":"/versions/v0.16.x/service/js-ts-sdk/getters"},{"title":"Types","href":"/versions/v0.16.x/service/js-ts-sdk/types"}]}]},{"dropdown":"Go SDK Reference","icon":"golang","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB - Go SDK Reference","sidebarTitle":"Go SDK Introduction","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/client"},{"title":"Get Health","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/get-health"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/list-indexes"},{"title":"Generate Key","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/generate-key"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/upsert"},{"title":"Query","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/query"},{"title":"Train","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/train"},{"title":"Get","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/get"},{"title":"List IDs","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/list-ids"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/delete-index"}]},{"group":"Types \u0026 Helpers","pages":[{"title":"Getters","href":"/versions/v0.16.x/service/go-sdk/getters"},{"title":"Types","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/types"}]}]}]},{"tab":"CyborgDB Embedded","dropdowns":[{"dropdown":"Guides","icon":"book","groups":[{"group":"Intro","pages":[{"title":"CyborgDB Embedded","sidebarTitle":"Introduction","mode":"wide","href":"/versions/v0.16.x/embedded/guides/intro/about"},{"title":"CyborgDB Embedded Quickstart","sidebarTitle":"Quickstart","mode":"wide","href":"/versions/v0.16.x/embedded/guides/intro/quickstart"}]},{"group":"Encrypted Indexes","pages":[{"title":"Introduction to Encrypted Indexes","sidebarTitle":"Introduction","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/introduction"},{"title":"Create Client","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/create-client"},{"title":"Create a New Encrypted Index","sidebarTitle":"Create New Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/create-index"},{"title":"Load an Existing Encrypted Index","sidebarTitle":"Load Existing Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/load-index"},{"title":"List Encrypted Indexes","sidebarTitle":"List Indexes","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/list-indexes"},{"title":"Train an Encrypted Index","sidebarTitle":"Train Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/train-index"},{"title":"Delete an Encrypted Index","sidebarTitle":"Delete Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/delete-index"}]},{"group":"Data Operations","pages":[{"title":"Add Items to an Encrypted Index","sidebarTitle":"Add Items","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/add-items"},{"title":"Query Encrypted Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/query"},{"title":"Metadata Filtering","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/metadata-filtering"},{"title":"Get Encrypted Items","sidebarTitle":"Get Items","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/get-items"},{"title":"Delete Encrypted Items","sidebarTitle":"Delete Items","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/delete-items"}]},{"group":"Advanced","pages":[{"title":"Managing Encryption Keys","href":"/versions/v0.16.x/embedded/guides/advanced/managing-keys"},{"title":"Configure an Encrypted Index","sidebarTitle":"Configure Index","href":"/versions/v0.16.x/embedded/guides/advanced/configure-index"},{"title":"CyborgDB Usage Telemetry","sidebarTitle":"Usage Telemetry","mode":"wide","href":"/versions/v0.16.x/embedded/guides/advanced/usage-telemetry"}]}]},{"dropdown":"Python API Reference","icon":"python","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB Embedded - Python API Reference","sidebarTitle":"Python API Introduction","mode":"wide","href":"/versions/v0.16.x/embedded/python/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/client"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/list-indexes"},{"title":"Logger","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/logger"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/upsert"},{"title":"Query","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/query"},{"title":"Train Index","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/train"},{"title":"Get","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/get"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/delete-index"}]},{"group":"Types \u0026 Getters","pages":[{"title":"Getter Functions","href":"/versions/v0.16.x/embedded/python/getters"},{"title":"Types","href":"/versions/v0.16.x/embedded/python/types"}]}]},{"dropdown":"C++ API Reference","icon":"brackets-curly","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB Embedded - C++ API Reference","sidebarTitle":"C++ API Introduction","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/client"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/list-indexes"},{"title":"Logger","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/logger"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/upsert"},{"title":"Query","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/query"},{"title":"Train Index","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/train"},{"title":"Get","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/get"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/delete-index"}]},{"group":"Types \u0026 Getters","pages":[{"title":"Getter Functions","href":"/versions/v0.16.x/embedded/cpp/getters"},{"title":"Types","href":"/versions/v0.16.x/embedded/cpp/types"}]}]}]},{"tab":"Integrations","dropdowns":[{"dropdown":"Integrations","icon":"puzzle-piece","groups":[{"group":"Overview","pages":[{"title":"CyborgDB Integrations","sidebarTitle":"Integrations","mode":"wide","href":"/versions/v0.16.x/integrations/about"}]}]},{"dropdown":"LangChain","icon":"link","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB - LangChain Integration","sidebarTitle":"LangChain Introduction","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/introduction"}]},{"group":"CyborgVectorStore","pages":[{"title":"__init__","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/init"},{"title":"add_texts","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/add_texts"},{"title":"add_documents","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/add_documents"},{"title":"get","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/get"},{"title":"list_ids","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/list_ids"},{"title":"delete","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/delete"},{"title":"similarity_search","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/similarity_search"},{"title":"similarity_search_with_score","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/similarity_search_with_score"},{"title":"similarity_search_by_vector","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/similarity_search_by_vector"},{"title":"max_marginal_relevance_search","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/max_marginal_relevance_search"},{"title":"from_texts","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/from_texts"},{"title":"from_documents","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/from_documents"},{"title":"as_retriever","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/as_retriever"},{"title":"generate_key","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/generate_key"},{"title":"get_embeddings","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/get_embeddings"}]},{"group":"Types","pages":[{"title":"Types","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/types"}]}]}]}]},{"version":"v0.15.x","pages":[{"title":"v0.15.x","href":"/versions/v0.15.x/intro/get-api-key"}]}]},"basePath":"","title":"Getting an API Key - CyborgDB Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-BRsfsIIG.js","DynamicMarkdown-NFqqduU7.js","zoom-image-lightbox-BguUeq2N.js","lightbox-handle-r17bVUz3.js"]}