{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Chroma Docs","colors":{"primary":"#ff6446","light":"#3b82f6","dark":"#3b82f6"},"logo":{"light":"https://mintcdn.com/chroma-8943dec5/zDKM3GBjHr8r61ad/images/light-logo.svg?fit=max\u0026auto=format\u0026n=zDKM3GBjHr8r61ad\u0026q=85\u0026s=d487d229a3d00bed252f4728417390fe","dark":"https://mintcdn.com/chroma-8943dec5/zDKM3GBjHr8r61ad/images/dark-logo.svg?fit=max\u0026auto=format\u0026n=zDKM3GBjHr8r61ad\u0026q=85\u0026s=9a0a6a79ac0ebba171a05f875bd724e1"},"favicon":"https://mintcdn.com/chroma-8943dec5/zDKM3GBjHr8r61ad/images/favicon.svg?fit=max\u0026auto=format\u0026n=zDKM3GBjHr8r61ad\u0026q=85\u0026s=490f4b16d291523f62110db3bdff5500","api":{"examples":{"languages":["curl","terminal","python","typescript","rust"]}},"appearance":{"default":"system"},"navbar":{"links":[{"icon":"github","href":"https://github.com/chroma-core/chroma","label":"27k"},{"icon":"discord","href":"https://discord.gg/dSHcBEMSk7","label":"11k"},{"icon":"x-twitter","href":"https://x.com/trychroma","label":"29k"}],"primary":{"type":"button","label":"Dashboard","href":"https://trychroma.com/login"}},"footer":{"socials":{"github":"https://github.com/chroma-core/chroma","x":"https://x.com/trychroma","discord":"https://discord.gg/MMeYNTmh3x","youtube":"https://youtube.com/@trychroma"},"links":[{"items":[{"label":"Enterprise","href":"https://trychroma.com/enterprise"},{"label":"Pricing","href":"https://trychroma.com/pricing"},{"label":"Changelog","href":"https://trychroma.com/changelog"}]}]},"fonts":{"family":"Inter"},"integrations":{"gtm":{"tagId":"GTM-T8MGS4GJ"},"posthog":{"apiKey":"phc_M1NrBVW8hgvKCGYxVtYusnbBvpVq9sKpE7FJMew9suK","sessionRecording":false}},"contextual":{"options":["copy","view","grok","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"background":"https://mintcdn.com/chroma-8943dec5/4JUAmIxOVRcPzFno/images/og-bg.png?fit=max\u0026auto=format\u0026n=4JUAmIxOVRcPzFno\u0026q=85\u0026s=1bad42a6df47084c8ff628738967bc4b"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chroma-8943dec5","hasAudioNarration":false,"actualSubdomain":"chroma-8943dec5","customDomains":["docs.trychroma.com"],"gitSource":{"type":"github","owner":"chroma-core","repo":"chroma","deployBranch":"main","contentDirectory":"docs/mintlify","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac93781cda84f472b9a3a94","collectionId":"1ddac6b4-9b9b-4e14-9b24-8dd580601cc1","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac93781cda84f472b9a3a94"},"feedback":{"edits":true,"issues":false,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ac93781cda84f472b9a3a94","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Reference","count":65},{"language":"default","tag":"APIs","count":44},{"language":"default","tag":"Integrations","count":39},{"language":"default","tag":"Docs","count":29},{"language":"default","tag":"Chroma Core API","count":27},{"language":"default","tag":"Chroma Cloud","count":25},{"language":"default","tag":"Dense Embedding Models","count":21},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"Frameworks","count":13},{"language":"default","tag":"SDKs","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@trychroma.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-bash","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-component-part=step-number]>div{border-radius:0;border:1px solid #000;background-color:#fff;font-family:ui-monospace,monospace;font-weight:400;box-shadow:2px 2px 0 0 #000}.dark [data-component-part=step-number]>div{border-color:#c4c5c8;background-color:#111827;box-shadow:2px 2px 0 0 #babbbf}[data-component-part=step-line]{background-color:#000;background-image:none!important}.dark [data-component-part=step-line]{background-color:#c4c5c8}[data-testid=tab-TypeScript] .tab-icon,a[href*=\"mintlify.com?utm_campaign=poweredBy\"] span{display:none}[data-testid=tab-TypeScript]::before{content:\"\";display:inline-block;width:1rem;height:1rem;background-color:currentColor;-webkit-mask-image:url(/images/typescript.svg);mask-image:url(/images/typescript.svg);-webkit-mask-size:contain;mask-size:contain;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}a[href*=\"mintlify.com?utm_campaign=poweredBy\"]::after{content:\"is powered by Chroma\"}a[href=\"/reference/typescript\"] [data-component-part=card-icon] svg{-webkit-mask-image:url(/images/typescript.svg)!important;mask-image:url(/images/typescript.svg)!important;-webkit-mask-size:contain;mask-size:contain;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.dark #topbar-cta-button{opacity:.85}"}],"page":{"pagePath":"reference/sync-api/system/get-service-health-status","slug":"/reference/sync-api/system/get-service-health-status","pageMetadata":{"title":"Get service health status","description":"Returns the health status of the sync service.","deprecated":null,"version":null,"openapi":"/sync.openapi.json get /health","href":"/reference/sync-api/system/get-service-health-status","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns the health status of the sync service.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get service health status","description":"Returns the health status of the sync service.","deprecated":null,"version":null,"openapi":"/sync.openapi.json get /health","href":"/reference/sync-api/system/get-service-health-status","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["System"],"summary":"Get service health status","description":"Returns the health status of the sync service.","operationId":"health_check","responses":{"200":"ad38657c-5b6d-4b93-a519-a6a5ebc1c968","503":"494a4a34-e18a-40b7-9837-300de386cba2"},"method":"get","type":"path","servers":["4f6f5417-d220-4d78-a798-b9e7325d49f3"],"security":[],"path":"/health","baseUrlOptions":["https://sync.trychroma.com"],"title":"Get service health status","codeSamples":[],"requestExampleLanguages":["bash","terminal","python","typescript","rust"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"ad38657c-5b6d-4b93-a519-a6a5ebc1c968":{"description":"Health check successful","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"494a4a34-e18a-40b7-9837-300de386cba2":{"description":"Service is unavailable","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"4f6f5417-d220-4d78-a798-b9e7325d49f3":{"url":"https://sync.trychroma.com"}}},"originalFileLocation":"sync.openapi.json"},"subdomain":"chroma-8943dec5","siteName":"Chroma Docs","title":"Get service health status - Chroma Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-28T21:42:45.957Z","originalFileLocation":"reference/sync-api/system/get-service-health-status.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=\"Returns the health status of the sync service.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chroma Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chroma-8943dec5/DnUzSTuBJGyCs29f/_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/chroma-8943dec5/DnUzSTuBJGyCs29f/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chroma-8943dec5/DnUzSTuBJGyCs29f/_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/chroma-8943dec5/DnUzSTuBJGyCs29f/_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/chroma-8943dec5/DnUzSTuBJGyCs29f/_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/chroma-8943dec5/DnUzSTuBJGyCs29f/_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/chroma-8943dec5/DnUzSTuBJGyCs29f/_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/chroma-8943dec5/DnUzSTuBJGyCs29f/_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/chroma-8943dec5/DnUzSTuBJGyCs29f/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get service health status - Chroma Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the health status of the sync service.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chroma Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chroma-8943dec5.mintlify.app/_mintlify/api/og/v2?division=System\u0026amp;title=Get+service+health+status\u0026amp;description=Returns+the+health+status+of+the+sync+service.\u0026amp;theme=614106df5e95be29b6cef6ac\u0026amp;signature=694fd621d1bcb97db37a5aae3e6681d3f9ed811bbb322c673e335bd99d688ffd\">\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=\"Get service health status - Chroma Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the health status of the sync service.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chroma-8943dec5.mintlify.app/_mintlify/api/og/v2?division=System\u0026amp;title=Get+service+health+status\u0026amp;description=Returns+the+health+status+of+the+sync+service.\u0026amp;theme=614106df5e95be29b6cef6ac\u0026amp;signature=694fd621d1bcb97db37a5aae3e6681d3f9ed811bbb322c673e335bd99d688ffd\">\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/chroma-8943dec5/DnUzSTuBJGyCs29f/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chroma Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff6446\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/sync-api/system/get-service-health-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.trychroma.com/#organization\",\"name\":\"Chroma Docs\",\"url\":\"https://docs.trychroma.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chroma-8943dec5/zDKM3GBjHr8r61ad/images/light-logo.svg?fit=max\u0026auto=format\u0026n=zDKM3GBjHr8r61ad\u0026q=85\u0026s=d487d229a3d00bed252f4728417390fe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.trychroma.com#website\",\"name\":\"Chroma Docs\",\"url\":\"https://docs.trychroma.com\",\"publisher\":{\"@id\":\"https://docs.trychroma.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status#webpage\",\"url\":\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status\",\"name\":\"Get service health status\",\"description\":\"Returns the health status of the sync service.\",\"dateModified\":\"2026-04-28T21:42:45.957Z\",\"isPartOf\":{\"@id\":\"https://docs.trychroma.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.trychroma.com/reference/chroma-api/tenant/create-tenant\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Chroma Sync API\",\"item\":\"https://docs.trychroma.com/reference/sync-api/invocation/list-invocations\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get service health status\",\"item\":\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status#apireference\",\"headline\":\"Get service health status\",\"name\":\"Get service health status\",\"description\":\"Returns the health status of the sync service.\",\"url\":\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.trychroma.com/reference/sync-api/system/get-service-health-status#webpage\"},\"dateModified\":\"2026-04-28T21:42:45.957Z\",\"publisher\":{\"@id\":\"https://docs.trychroma.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.trychroma.com#website\"}}]}\u003c/script>","siteName":"Chroma Docs","nav":{"global":null,"tabs":[{"tab":"Docs","icon":"book","pages":[{"title":"Docs","href":"/docs/overview/introduction"}]},{"tab":"Chroma Cloud","icon":"cloud","pages":[{"title":"Chroma Cloud","href":"/cloud/getting-started"}]},{"tab":"Guides","icon":"map","pages":[{"title":"Guides","href":"/guides/build/building-with-ai"}]},{"tab":"Integrations","icon":"code-merge","pages":[{"title":"Integrations","href":"/integrations/chroma-integrations"}]},{"tab":"Reference","icon":"code","pages":[{"title":"Overview","href":"/reference/overview"},{"group":"Self-Hosted Chroma","pages":[{"title":"Chroma Configuration","href":"/reference/server-env-vars"}]},{"group":"SDKs","pages":[{"group":"Python","pages":[{"title":"Client","href":"/reference/python/client"},{"title":"Collection","href":"/reference/python/collection"},{"title":"Embedding Functions","href":"/reference/python/embedding-functions"},{"title":"Search","href":"/reference/python/search"},{"title":"Schema","href":"/reference/python/schema"},{"title":"Where Filters","href":"/reference/python/where-filter"}]},{"group":"TypeScript","pages":[{"title":"Client","href":"/reference/typescript/client"},{"title":"Collection","href":"/reference/typescript/collection"},{"title":"Embedding Functions","href":"/reference/typescript/embedding-functions"},{"title":"Search","href":"/reference/typescript/search"},{"title":"Schema","href":"/reference/typescript/schema"},{"title":"Where Filters","href":"/reference/typescript/where-filter"}]},{"title":"Rust","url":"https://docs.rs/chroma/latest/chroma/","href":"/reference/rust"}]},{"group":"Beta SDKs","pages":[{"title":"Kotlin","url":"https://github.com/chroma-core/chroma-android","href":"/reference/kotlin"},{"title":"Swift","url":"https://github.com/chroma-core/chroma-swift","href":"/reference/swift"}]},{"group":"APIs","pages":[{"group":"Chroma Core API","pages":[{"group":"Tenant","pages":[{"title":"Create tenant","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants","href":"/reference/chroma-api/tenant/create-tenant"},{"title":"Get tenant","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/tenants/{tenant_name}","href":"/reference/chroma-api/tenant/get-tenant"},{"title":"Update tenant","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json patch /api/v2/tenants/{tenant_name}","href":"/reference/chroma-api/tenant/update-tenant"}]},{"group":"Database","pages":[{"title":"List databases","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/tenants/{tenant}/databases","href":"/reference/chroma-api/database/list-databases"},{"title":"Create database","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases","href":"/reference/chroma-api/database/create-database"},{"title":"Get database","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/tenants/{tenant}/databases/{database}","href":"/reference/chroma-api/database/get-database"},{"title":"Delete database","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json delete /api/v2/tenants/{tenant}/databases/{database}","href":"/reference/chroma-api/database/delete-database"}]},{"group":"Collection","pages":[{"title":"List collections","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/tenants/{tenant}/databases/{database}/collections","href":"/reference/chroma-api/collection/list-collections"},{"title":"Get number of collections","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/tenants/{tenant}/databases/{database}/collections_count","href":"/reference/chroma-api/collection/get-number-of-collections"},{"title":"Create collection","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections","href":"/reference/chroma-api/collection/create-collection"},{"title":"Get collection","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}","href":"/reference/chroma-api/collection/get-collection"},{"title":"Update collection","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json put /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}","href":"/reference/chroma-api/collection/update-collection"},{"title":"Delete collection","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json delete /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}","href":"/reference/chroma-api/collection/delete-collection"}]},{"group":"Record","pages":[{"title":"Add records","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/add","href":"/reference/chroma-api/record/add-records"},{"title":"Get number of records","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/count","href":"/reference/chroma-api/record/get-number-of-records"},{"title":"Delete records","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/delete","href":"/reference/chroma-api/record/delete-records"},{"title":"Get indexing status","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/indexing_status","href":"/reference/chroma-api/record/get-indexing-status"},{"title":"Get records","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/get","href":"/reference/chroma-api/record/get-records"},{"title":"Query collection","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/query","href":"/reference/chroma-api/record/query-collection"},{"title":"Search records","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/search","href":"/reference/chroma-api/record/search-records"},{"title":"Update records","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/update","href":"/reference/chroma-api/record/update-records"},{"title":"Upsert records","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/upsert","href":"/reference/chroma-api/record/upsert-records"}]},{"group":"System","pages":[{"title":"Healthcheck","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/healthcheck","href":"/reference/chroma-api/system/healthcheck"},{"title":"Heartbeat","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/heartbeat","href":"/reference/chroma-api/system/heartbeat"},{"title":"Pre-flight checks","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/pre-flight-checks","href":"/reference/chroma-api/system/pre-flight-checks"},{"title":"Get version","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/version","href":"/reference/chroma-api/system/get-version"}]},{"group":"Authentication","pages":[{"title":"Get user identity","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/auth/identity","href":"/reference/chroma-api/authentication/get-user-identity"}]}]},{"group":"Chroma Cloud API","pages":[{"group":"Collection","pages":[{"title":"Fork collection","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/fork","href":"/api-reference/collection/fork-collection"}]},{"group":"Function","pages":[{"title":"Attach function","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/functions/attach","href":"/api-reference/function/attach-function"},{"title":"Get attached function","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json get /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/functions/{function_name}","href":"/api-reference/function/get-attached-function"},{"title":"Detach function","deprecated":null,"version":null,"openapi":"https://api.trychroma.com/openapi.json post /api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/attached_functions/{name}/detach","href":"/api-reference/function/detach-function"}]}]},{"group":"Chroma Sync API","pages":[{"group":"Invocation","pages":[{"title":"List invocations","deprecated":null,"version":null,"openapi":"/sync.openapi.json get /api/v1/invocations","href":"/reference/sync-api/invocation/list-invocations"},{"title":"Get invocation","deprecated":null,"version":null,"openapi":"/sync.openapi.json get /api/v1/invocations/{invocation_id}","href":"/reference/sync-api/invocation/get-invocation"},{"title":"Cancel invocation","deprecated":null,"version":null,"openapi":"/sync.openapi.json put /api/v1/invocations/{invocation_id}","href":"/reference/sync-api/invocation/cancel-invocation"},{"title":"Create invocation","deprecated":null,"version":null,"openapi":"/sync.openapi.json post /api/v1/sources/{source_id}/invocations","href":"/reference/sync-api/invocation/create-invocation"},{"title":"Get latest invocations by keys","deprecated":null,"version":null,"openapi":"/sync.openapi.json post /api/v1/sources/{source_id}/invocations/latest-by-keys","href":"/reference/sync-api/invocation/get-latest-invocations-by-keys"}]},{"group":"Source","pages":[{"title":"List sources","deprecated":null,"version":null,"openapi":"/sync.openapi.json get /api/v1/sources","href":"/reference/sync-api/source/list-sources"},{"title":"Create source","deprecated":null,"version":null,"openapi":"/sync.openapi.json post /api/v1/sources","href":"/reference/sync-api/source/create-source"},{"title":"Get source","deprecated":null,"version":null,"openapi":"/sync.openapi.json get /api/v1/sources/{source_id}","href":"/reference/sync-api/source/get-source"},{"title":"Delete source","description":"Deletes a source with the provided ID.","deprecated":null,"version":null,"openapi":"/sync.openapi.json delete /api/v1/sources/{source_id}","href":"/reference/sync-api/source/delete-source"}]},{"group":"System","pages":[{"title":"Get service health status","deprecated":null,"version":null,"openapi":"/sync.openapi.json get /health","href":"/reference/sync-api/system/get-service-health-status"}]},{"group":"File Upload","pages":[{"title":"Upload and index a file","description":"Uploads a file and creates an invocation to index it into the specified collection.\n\nThe first time this endpoint is called for a database, a `file_upload` source is created automatically; subsequent calls reuse that source. The collection is created on the first invocation if it does not already exist.\n\n**Multipart field ordering:** `database_name` and `collection_name` MUST appear before `file`. The server uses these to authorize the request before streaming file bytes to storage.\n\n**Size limits:** maximum 200 MiB per file. The declared size in `x-upload-content-length` is enforced.","deprecated":null,"version":null,"openapi":"/sync.openapi.json post /api/v1/add-file","href":"/reference/sync-api/file-upload/upload-and-index-a-file"}]}]},{"group":"Chroma Cloud Embeddings API","pages":[{"title":"Generate dense embeddings","deprecated":null,"version":null,"openapi":"https://embed.trychroma.com/openapi.json post /embed","href":"/reference/embeddings-api/generate-dense-embeddings"},{"title":"Generate sparse embeddings","deprecated":null,"version":null,"openapi":"https://embed.trychroma.com/openapi.json post /embed_sparse","href":"/reference/embeddings-api/generate-sparse-embeddings"}]}]},{"group":"Dictionary Syntax","pages":[{"title":"Search","href":"/reference/search"},{"title":"Where Filters","href":"/reference/where-filter"}]},{"group":"Architecture","pages":[{"title":"Architecture Overview","href":"/reference/architecture/overview"},{"title":"Distributed Architecture","href":"/reference/architecture/distributed"}]}]}]},"title":"Get service health status - Chroma Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}