Reference for the gcai ping commands in the GC AI CLI, with the synopsis and flags for each command.
gcai ping
Health check
gcai ping
Wraps GET /ping — see Health check for full parameter semantics.
Last modified on September 23, 2026
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"GC AI","description":"The GC AI API reference (REST API, MCP server and CLI), plus support, account and troubleshooting help. Product docs for signed-in users are in the GC AI app.","colors":{"primary":"#003047","light":"#50abda"},"logo":{"light":"https://mintcdn.com/gcai/0BlqBDRwAhV-CbPw/logo/light.svg?fit=max\u0026auto=format\u0026n=0BlqBDRwAhV-CbPw\u0026q=85\u0026s=d11c2834d42373b30d3f9dc6d3138367","dark":"https://mintcdn.com/gcai/0BlqBDRwAhV-CbPw/logo/dark.svg?fit=max\u0026auto=format\u0026n=0BlqBDRwAhV-CbPw\u0026q=85\u0026s=32c5457a1bac33bb819c590260c1cbc9"},"favicon":"https://mintcdn.com/gcai/0BlqBDRwAhV-CbPw/favicon.svg?fit=max\u0026auto=format\u0026n=0BlqBDRwAhV-CbPw\u0026q=85\u0026s=7b86bbec08c30a471c9cd2d8a6b20504","navbar":{"links":[{"href":"mailto:support@gc.ai","label":"support@gc.ai"}],"primary":{"type":"button","label":"Go to GC AI","href":"https://app.gc.ai"}},"footer":{"socials":{"x":"https://x.com/gcai_co","linkedin":"https://linkedin.com/company/gc-ai"}},"seo":{"organization":{"url":"https://gc.ai","sameAs":["https://x.com/gcai_co","https://linkedin.com/company/gc-ai"]},"indexing":"navigable"},"integrations":{"posthog":{"apiKey":"phc_EhQwXWGMSQx1y3M9f5uLqZUgeFqpagTuYPXGw1QYztC","apiHost":"https://app.posthog.com"}},"interaction":{"drilldown":false},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://gc.ai/slack"},{"anchor":"Blog","icon":"newspaper","href":"https://gc.ai/blog"},{"anchor":"Classes","icon":"graduation-cap","href":"https://gc.ai/classes"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gcai","hasAudioNarration":false,"actualSubdomain":"gcai","customDomains":["docs.gc.ai"],"gitSource":{"type":"github","owner":"gc-ai-inc","repo":"app-gc-ai","deployBranch":"main","contentDirectory":"apps/product-docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afa366200819710da550d6d","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":165},{"language":"default","tag":"REST","count":113},{"language":"default","tag":"Endpoints","count":100},{"language":"default","tag":"Contract Intelligence","count":34},{"language":"default","tag":"MCP","count":33},{"language":"default","tag":"Tools","count":28},{"language":"default","tag":"Projects","count":22},{"language":"default","tag":"CLI","count":20},{"language":"default","tag":"Playbooks","count":18},{"language":"default","tag":"Commands","count":15}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@gc.ai","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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".surface-map table{width:100%;table-layout:fixed}.surface-map--method th:last-child,.surface-map--method td:last-child{width:6rem}.surface-map--behavior th:last-child,.surface-map--behavior td:last-child{width:8rem}.surface-map .method,.surface-map .behavior{display:inline-block;padding:1px 6px;border-radius:6px;font-family:ui-monospace, SFMono-Regular, Menlo, monospace;font-size:0.72rem;font-weight:600;letter-spacing:0.02em}.surface-map .method-get{color:#10b981;background:rgba(16, 185, 129, 0.13)}.surface-map .method-post{color:#3b82f6;background:rgba(59, 130, 246, 0.13)}.surface-map .method-put{color:#f59e0b;background:rgba(245, 158, 11, 0.13)}.surface-map .method-patch{color:#f97316;background:rgba(249, 115, 22, 0.13)}.surface-map .method-delete{color:#ef4444;background:rgba(239, 68, 68, 0.13)}.surface-map .behavior-read-only{color:#10b981;background:rgba(16, 185, 129, 0.13)}.surface-map .behavior-additive{color:#3b82f6;background:rgba(59, 130, 246, 0.13)}.surface-map .behavior-destructive{color:#ef4444;background:rgba(239, 68, 68, 0.13)}.surface-map .behavior-open-world{color:#8b5cf6;background:rgba(139, 92, 246, 0.13)}"}],"page":{"pagePath":"api-reference/cli/commands/ping","slug":"/api-reference/cli/commands/ping","pageMetadata":{"title":"gcai ping CLI commands","sidebarTitle":"Ping","description":"Reference for the `gcai ping` commands in the GC AI CLI, with the synopsis and flags for each command.","href":"/api-reference/cli/commands/ping"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Reference for the \", _jsx(_components.code, {\n children: \"gcai ping\"\n }), \" commands in the GC AI CLI, with the synopsis and flags for each command.\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`gcai-ping`,children:_jsx(_components.code,{children:`gcai ping`})}),`\n`,_jsx(_components.p,{children:`Health check`}),`\n`,_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:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gcai`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ping`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Wraps `,_jsx(_components.code,{children:`GET /ping`}),` — see `,_jsx(_components.a,{href:`/api-reference/ping`,children:`Health check`}),` for full parameter semantics.`]})]})}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":"gcai ping CLI commands","sidebarTitle":"Ping","description":"Reference for the `gcai ping` commands in the GC AI CLI, with the synopsis and flags for each command.","href":"/api-reference/cli/commands/ping"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"gcai ping","slug":"gcai-ping","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"gcai","siteName":"GC AI","title":"gcai ping CLI commands - GC AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T21:22:49.215Z","gitLastModified":"2026-09-23T21:22:28.000Z","originalFileLocation":"api-reference/cli/commands/ping.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=\"Reference for the gcai ping commands in the GC AI CLI, with the synopsis and flags for each command.\">\u003cmeta data-mint-head name=\"application-name\" content=\"GC AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gcai/XpTjQtvSBPYuCpWI/_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/gcai/XpTjQtvSBPYuCpWI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gcai/XpTjQtvSBPYuCpWI/_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/gcai/XpTjQtvSBPYuCpWI/_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/gcai/XpTjQtvSBPYuCpWI/_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/gcai/XpTjQtvSBPYuCpWI/_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/gcai/XpTjQtvSBPYuCpWI/_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/gcai/XpTjQtvSBPYuCpWI/_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/gcai/XpTjQtvSBPYuCpWI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"gcai ping CLI commands - GC AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference for the gcai ping commands in the GC AI CLI, with the synopsis and flags for each command.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GC AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gc.ai/api-reference/cli/commands/ping\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gcai.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=gcai+ping+CLI+commands\u0026amp;description=Reference+for+the+%60gcai+ping%60+commands+in+the+GC+AI+CLI%2C+with+the+synopsis+and+flags+for+each+command.\u0026amp;theme=0fe006a5f9e0d576e50fc869\u0026amp;signature=82e127c0bb9d40209b55978aaa1d6201e90d6b0de0065400b0cb070873069672\">\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=\"gcai ping CLI commands - GC AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference for the gcai ping commands in the GC AI CLI, with the synopsis and flags for each command.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gcai.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=gcai+ping+CLI+commands\u0026amp;description=Reference+for+the+%60gcai+ping%60+commands+in+the+GC+AI+CLI%2C+with+the+synopsis+and+flags+for+each+command.\u0026amp;theme=0fe006a5f9e0d576e50fc869\u0026amp;signature=82e127c0bb9d40209b55978aaa1d6201e90d6b0de0065400b0cb070873069672\">\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/gcai/XpTjQtvSBPYuCpWI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GC AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#003047\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gc.ai/api-reference/cli/commands/ping\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cli/commands/ping.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://gc.ai/#organization\",\"name\":\"GC AI\",\"url\":\"https://gc.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gcai/0BlqBDRwAhV-CbPw/logo/light.svg?fit=max\u0026auto=format\u0026n=0BlqBDRwAhV-CbPw\u0026q=85\u0026s=d11c2834d42373b30d3f9dc6d3138367\"},\"sameAs\":[\"https://x.com/gcai_co\",\"https://linkedin.com/company/gc-ai\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gc.ai#website\",\"name\":\"GC AI\",\"url\":\"https://docs.gc.ai\",\"publisher\":{\"@id\":\"https://gc.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gc.ai/api-reference/cli/commands/ping#webpage\",\"url\":\"https://docs.gc.ai/api-reference/cli/commands/ping\",\"name\":\"gcai ping CLI commands\",\"description\":\"Reference for the gcai ping commands in the GC AI CLI, with the synopsis and flags for each command.\",\"dateModified\":\"2026-09-23T21:22:28.000Z\",\"isPartOf\":{\"@id\":\"https://docs.gc.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gc.ai/api-reference/cli/commands/ping#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gc.ai/api-reference/cli/commands/ping#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CLI\",\"item\":\"https://docs.gc.ai/api-reference/cli/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Commands\",\"item\":\"https://docs.gc.ai/api-reference/cli/commands/chat\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"gcai ping CLI commands\",\"item\":\"https://docs.gc.ai/api-reference/cli/commands/ping\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.gc.ai/api-reference/cli/commands/ping#article\",\"headline\":\"gcai ping CLI commands\",\"name\":\"gcai ping CLI commands\",\"description\":\"Reference for the gcai ping commands in the GC AI CLI, with the synopsis and flags for each command.\",\"url\":\"https://docs.gc.ai/api-reference/cli/commands/ping\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gc.ai/api-reference/cli/commands/ping#webpage\"},\"dateModified\":\"2026-09-23T21:22:28.000Z\",\"publisher\":{\"@id\":\"https://gc.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gc.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GC AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"GC AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/cli/commands/ping.md","siteName":"GC AI","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://gc.ai/slack"},{"anchor":"Blog","icon":"newspaper","href":"https://gc.ai/blog"},{"anchor":"Classes","icon":"graduation-cap","href":"https://gc.ai/classes"}]},"tabs":[{"tab":"Help","pages":[{"title":"Help","href":"/support"}]},{"tab":"API Reference","groups":[{"group":"REST","pages":[{"title":"API Introduction","href":"/api-reference/introduction"},{"title":"REST API surface map","sidebarTitle":"Surface map","href":"/api-reference/rest-surface-map"},{"group":"Concepts","pages":[{"title":"How to Enable","href":"/api-reference/how-to-enable"},{"title":"API Keys","href":"/api-reference/concepts/api-keys"},{"title":"Asynchronous Requests","href":"/api-reference/concepts/async-jobs"},{"title":"Chat Visibility","href":"/api-reference/concepts/chat-visibility"},{"title":"Multi-turn Conversations","href":"/api-reference/concepts/multi-turn"},{"title":"Tool permissions","href":"/api-reference/concepts/tool-permissions"},{"title":"Rate Limits","href":"/api-reference/concepts/rate-limits"},{"title":"Running an example on Replit","href":"/api-reference/concepts/running-on-replit"}]},{"group":"Examples","pages":[{"title":"Contract Risk Heatmap","href":"/api-reference/examples/contract-risk-heatmap"},{"title":"Triage \u0026 Route","href":"/api-reference/examples/triage-and-route"},{"title":"Slack Triage Bot","href":"/api-reference/examples/slack-triage-bot"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"Async Jobs","pages":[{"title":"Get Async Job Status","openapi":"GET /jobs/{id}","href":"/api-reference/get-async-job"}]},{"group":"Chat","pages":[{"title":"Create Chat Completion","openapi":"POST /chat/completions","href":"/api-reference/create-chat-completion"},{"title":"Materialize an API Chat","openapi":"POST /chat/{id}/materialize","href":"/api-reference/materialize-chat"},{"title":"Search Chats","openapi":"GET /chat/search","href":"/api-reference/search-chats"}]},{"group":"Chats","pages":[{"title":"Create a Public Share Link","openapi":"POST /chats/{id}/share","href":"/api-reference/create-chat-share-link"},{"title":"Delete a Chat","openapi":"DELETE /chats/{id}","href":"/api-reference/delete-chat"},{"title":"Detach a File From a Chat","openapi":"DELETE /chats/{id}/files/{fileId}","href":"/api-reference/detach-file-from-chat"},{"title":"Duplicate a Chat","openapi":"POST /chats/{id}/duplicate","href":"/api-reference/duplicate-chat"},{"title":"Get a Chat","openapi":"GET /chats/{id}","href":"/api-reference/get-chat"},{"title":"List Messages in a Chat","openapi":"GET /chats/{id}/messages","href":"/api-reference/list-chat-messages"},{"title":"List Chats","openapi":"GET /chats","href":"/api-reference/list-chats"},{"title":"Revoke a Public Share Link","openapi":"DELETE /chats/{id}/share","href":"/api-reference/revoke-chat-share-link"},{"title":"Update a Chat","openapi":"PATCH /chats/{id}","href":"/api-reference/update-chat"}]},{"group":"Contract Intelligence","pages":[{"title":"Add a Member to a Vault","openapi":"POST /vaults/{id}/members","href":"/api-reference/add-vault-member"},{"title":"Archive a Vault","openapi":"POST /vaults/{id}/archive","href":"/api-reference/archive-vault"},{"title":"Create a Vault","openapi":"POST /vaults","href":"/api-reference/create-vault"},{"title":"Add a Column to a Vault","openapi":"POST /vaults/{id}/columns","href":"/api-reference/create-vault-column"},{"title":"Create a Saved View","openapi":"POST /vaults/{id}/views","href":"/api-reference/create-vault-view"},{"title":"Delete a Vault","openapi":"DELETE /vaults/{id}","href":"/api-reference/delete-vault"},{"title":"Remove a Column From a Vault","openapi":"DELETE /vaults/{id}/columns/{columnId}","href":"/api-reference/delete-vault-column"},{"title":"Remove a Document From a Vault","openapi":"DELETE /vaults/{id}/documents/{documentId}","href":"/api-reference/delete-vault-document"},{"title":"Delete a Saved View","openapi":"DELETE /vaults/{id}/views/{viewId}","href":"/api-reference/delete-vault-view"},{"title":"Get a Vault","openapi":"GET /vaults/{id}","href":"/api-reference/get-vault"},{"title":"Get One Document Row","openapi":"GET /vaults/{id}/documents/{documentId}","href":"/api-reference/get-vault-document"},{"title":"List a Vault's Columns","openapi":"GET /vaults/{id}/columns","href":"/api-reference/list-vault-columns"},{"title":"Read a Vault's Document Table","openapi":"GET /vaults/{id}/documents","href":"/api-reference/list-vault-documents"},{"title":"List a Vault's Members","openapi":"GET /vaults/{id}/members","href":"/api-reference/list-vault-members"},{"title":"List a Vault's Saved Views","openapi":"GET /vaults/{id}/views","href":"/api-reference/list-vault-views"},{"title":"List Vaults","openapi":"GET /vaults","href":"/api-reference/list-vaults"},{"title":"Remove a Member From a Vault","openapi":"DELETE /vaults/{id}/members/{userId}","href":"/api-reference/remove-vault-member"},{"title":"Restore an Archived Vault","openapi":"POST /vaults/{id}/restore","href":"/api-reference/restore-vault"},{"title":"Restore a Removed Document","openapi":"POST /vaults/{id}/documents/{documentId}/restore","href":"/api-reference/restore-vault-document"},{"title":"Restore the Extracted Value of a Cell","openapi":"POST /vaults/{id}/documents/{documentId}/cells/{fieldKey}/revert","href":"/api-reference/revert-vault-document-cell"},{"title":"Update a Vault","openapi":"PATCH /vaults/{id}","href":"/api-reference/update-vault"},{"title":"Update a Vault Column","openapi":"PATCH /vaults/{id}/columns/{columnId}","href":"/api-reference/update-vault-column"},{"title":"Set a Cell Value by Hand","openapi":"PATCH /vaults/{id}/documents/{documentId}/cells/{fieldKey}","href":"/api-reference/update-vault-document-cell"},{"title":"Change a Member's Role","openapi":"PATCH /vaults/{id}/members/{userId}","href":"/api-reference/update-vault-member-role"},{"title":"Update a Saved View","openapi":"PATCH /vaults/{id}/views/{viewId}","href":"/api-reference/update-vault-view"},{"title":"Add a Document to a Vault","openapi":"POST /vaults/{id}/documents","href":"/api-reference/upload-vault-document"}]},{"group":"Files","pages":[{"title":"Abort a Chunked Upload","openapi":"DELETE /files/uploads/{upload_id}","href":"/api-reference/abort-upload"},{"title":"Complete a Chunked Upload","openapi":"POST /files/uploads/{upload_id}/complete","href":"/api-reference/complete-upload"},{"title":"Get File Status","openapi":"GET /files/{id}","href":"/api-reference/get-file-status"},{"title":"Initiate a Chunked Upload","openapi":"POST /files/uploads","href":"/api-reference/initiate-upload"},{"title":"Search Files","openapi":"GET /files","href":"/api-reference/search-files"},{"title":"Move a File","openapi":"PATCH /files/{id}","href":"/api-reference/update-file"},{"title":"Upload a File","openapi":"POST /files","href":"/api-reference/upload-file"},{"title":"Upload a File Part","openapi":"PUT /files/uploads/{upload_id}/parts/{part_number}","href":"/api-reference/upload-part"}]},{"group":"Folders","pages":[{"title":"Create a Folder","openapi":"POST /folders","href":"/api-reference/create-folder"},{"title":"Delete a Folder","openapi":"DELETE /folders/{id}","href":"/api-reference/delete-folder"},{"title":"Get a Folder","openapi":"GET /folders/{id}","href":"/api-reference/get-folder"},{"title":"List a Folder's Children","openapi":"GET /folders/{id}/children","href":"/api-reference/list-folder-children"},{"title":"List Folders","openapi":"GET /folders","href":"/api-reference/list-folders"},{"title":"Update a Folder","openapi":"PATCH /folders/{id}","href":"/api-reference/update-folder"}]},{"group":"MCP","pages":[{"title":"Provision MCP Client-credentials","openapi":"POST /mcp/credentials","href":"/api-reference/provision-mcp-credentials"}]},{"group":"Playbooks","pages":[{"title":"Create a Playbook","openapi":"POST /playbooks","href":"/api-reference/create-playbook"},{"title":"Add a Check to a Playbook","openapi":"POST /playbooks/{id}/checks","href":"/api-reference/create-playbook-check"},{"title":"Delete a Playbook","openapi":"DELETE /playbooks/{id}","href":"/api-reference/delete-playbook"},{"title":"Remove a Check From a Playbook","openapi":"DELETE /playbooks/{id}/checks/{checkId}","href":"/api-reference/delete-playbook-check"},{"title":"Duplicate a Playbook","openapi":"POST /playbooks/{id}/duplicate","href":"/api-reference/duplicate-playbook"},{"title":"Get a Playbook","openapi":"GET /playbooks/{id}","href":"/api-reference/get-playbook"},{"title":"Get a Check","openapi":"GET /playbooks/{id}/checks/{checkId}","href":"/api-reference/get-playbook-check"},{"title":"List a Playbook's Checks","openapi":"GET /playbooks/{id}/checks","href":"/api-reference/list-playbook-checks"},{"title":"List Playbooks","openapi":"GET /playbooks","href":"/api-reference/list-playbooks"},{"title":"Reorder a Playbook's Checks","openapi":"POST /playbooks/{id}/checks/reorder","href":"/api-reference/reorder-playbook-checks"},{"title":"Run a Playbook Against Uploaded Files","openapi":"POST /playbooks/{id}/run","href":"/api-reference/run-playbook"},{"title":"Update a Playbook","openapi":"PATCH /playbooks/{id}","href":"/api-reference/update-playbook"},{"title":"Update a Check","openapi":"PATCH /playbooks/{id}/checks/{checkId}","href":"/api-reference/update-playbook-check"}]},{"group":"Profiles","pages":[{"title":"Get a Company Profile","openapi":"GET /company-profiles/{id}","href":"/api-reference/get-company-profile"},{"title":"Get the Company Profile","openapi":"GET /company-profile","href":"/api-reference/get-default-company-profile"},{"title":"Identify the Caller","openapi":"GET /me","href":"/api-reference/get-me"},{"title":"Get Your Personal Profile","openapi":"GET /me/profile","href":"/api-reference/get-my-profile"},{"title":"List Company Profiles","openapi":"GET /company-profiles","href":"/api-reference/list-company-profiles"},{"title":"Update a Company Profile","openapi":"PATCH /company-profiles/{id}","href":"/api-reference/update-company-profile"},{"title":"Update the Company Profile","openapi":"PATCH /company-profile","href":"/api-reference/update-default-company-profile"},{"title":"Update Your Personal Profile","openapi":"PATCH /me/profile","href":"/api-reference/update-my-profile"}]},{"group":"Projects","pages":[{"title":"File a Chat Into a Project","openapi":"POST /projects/{id}/chats","href":"/api-reference/attach-chat-to-project"},{"title":"Attach a File to a Project","openapi":"POST /projects/{id}/files","href":"/api-reference/attach-file-to-project"},{"title":"Attach a Folder to a Project","openapi":"POST /projects/{id}/folders","href":"/api-reference/attach-folder-to-project"},{"title":"Create a Project","openapi":"POST /projects","href":"/api-reference/create-project"},{"title":"Delete a Project","openapi":"DELETE /projects/{id}","href":"/api-reference/delete-project"},{"title":"Detach a File From a Project","openapi":"DELETE /projects/{id}/files/{fileId}","href":"/api-reference/detach-file-from-project"},{"title":"Detach a Folder From a Project","openapi":"DELETE /projects/{id}/folders/{folderId}","href":"/api-reference/detach-folder-from-project"},{"title":"Get a Project","openapi":"GET /projects/{id}","href":"/api-reference/get-project"},{"title":"List Chats in a Project","openapi":"GET /projects/{id}/chats","href":"/api-reference/list-project-chats"},{"title":"List Files on a Project","openapi":"GET /projects/{id}/files","href":"/api-reference/list-project-files"},{"title":"List Folders Linked to a Project","openapi":"GET /projects/{id}/folders","href":"/api-reference/list-project-folders"},{"title":"List Projects","openapi":"GET /projects","href":"/api-reference/list-projects"},{"title":"Pin a Project","openapi":"POST /projects/{id}/pin","href":"/api-reference/pin-project"},{"title":"Pin a Project (legacy Star Alias)","openapi":"POST /projects/{id}/star","href":"/api-reference/star-project"},{"title":"Unpin a Project","openapi":"DELETE /projects/{id}/pin","href":"/api-reference/unpin-project"},{"title":"Unpin a Project (legacy Star Alias)","openapi":"DELETE /projects/{id}/star","href":"/api-reference/unstar-project"},{"title":"Update a Project","openapi":"PATCH /projects/{id}","href":"/api-reference/update-project"}]},{"group":"Skills","pages":[{"title":"Create a Skill","openapi":"POST /skills","href":"/api-reference/create-skill"},{"title":"Delete a Skill","openapi":"DELETE /skills/{id}","href":"/api-reference/delete-skill"},{"title":"Get a Skill","openapi":"GET /skills/{id}","href":"/api-reference/get-skill"},{"title":"List Skills","openapi":"GET /skills","href":"/api-reference/list-skills"},{"title":"Update a Skill","openapi":"PATCH /skills/{id}","href":"/api-reference/update-skill"}]},{"group":"Usage","pages":[{"title":"Get Credit Usage","openapi":"GET /credit-usage","href":"/api-reference/get-credit-usage"},{"title":"Get Usage Summary","openapi":"GET /usage","href":"/api-reference/get-usage"}]},{"group":"Utility","pages":[{"title":"Health Check","openapi":"GET /ping","href":"/api-reference/ping"}]}]}]},{"group":"MCP","pages":[{"title":"MCP Introduction","href":"/api-reference/mcp/overview"},{"title":"MCP tools surface map","sidebarTitle":"Surface map","href":"/api-reference/mcp/surface-map"},{"group":"Concepts","pages":[{"title":"Connecting","href":"/api-reference/mcp/connecting"},{"title":"Client credentials (M2M)","href":"/api-reference/mcp/machine-access"}]},{"group":"Tools","expanded":true,"pages":[{"group":"Ask GC AI","pages":[{"title":"Create chat completion","href":"/api-reference/mcp/tools/ask-gcai"},{"title":"Check chat completion status","href":"/api-reference/mcp/tools/ask-gcai-status"},{"title":"Save chat","href":"/api-reference/mcp/tools/ask-gcai-save-chat"}]},{"group":"Files","pages":[{"title":"Get files","href":"/api-reference/mcp/tools/get-files"},{"title":"Upload file","href":"/api-reference/mcp/tools/upload-file"},{"title":"Start file upload","href":"/api-reference/mcp/tools/start-file-upload"},{"title":"Finish file upload","href":"/api-reference/mcp/tools/finish-file-upload"}]},{"group":"Projects","pages":[{"title":"Get projects","href":"/api-reference/mcp/tools/get-projects"},{"title":"Create project","href":"/api-reference/mcp/tools/create-project"},{"title":"Update project","href":"/api-reference/mcp/tools/update-project"},{"title":"Attach files to project","href":"/api-reference/mcp/tools/attach-to-project"},{"title":"Detach files from project","href":"/api-reference/mcp/tools/detach-from-project"}]},{"group":"Playbooks","pages":[{"title":"Get playbooks","href":"/api-reference/mcp/tools/get-playbooks"},{"title":"Create playbook","href":"/api-reference/mcp/tools/create-playbook"},{"title":"Update playbook","href":"/api-reference/mcp/tools/update-playbook"},{"title":"Run a playbook against uploaded files","href":"/api-reference/mcp/tools/run-playbook"},{"title":"Check playbook run status","href":"/api-reference/mcp/tools/run-playbook-status"}]},{"group":"Skills","pages":[{"title":"Get skills","href":"/api-reference/mcp/tools/get-skills"},{"title":"Create skill","href":"/api-reference/mcp/tools/create-skill"},{"title":"Update skill","href":"/api-reference/mcp/tools/update-skill"}]},{"group":"Contract Intelligence","pages":[{"title":"Get vaults","href":"/api-reference/mcp/tools/get-vaults"},{"title":"Get vault documents","href":"/api-reference/mcp/tools/get-vault-documents"},{"title":"Get vault columns","href":"/api-reference/mcp/tools/get-vault-columns"},{"title":"Create vault","href":"/api-reference/mcp/tools/create-vault"},{"title":"Update vault","href":"/api-reference/mcp/tools/update-vault"},{"title":"Create vault column","href":"/api-reference/mcp/tools/create-vault-column"},{"title":"Update vault column","href":"/api-reference/mcp/tools/update-vault-column"},{"title":"Update vault document cell","href":"/api-reference/mcp/tools/update-vault-document-cell"}]}]}]},{"group":"CLI","pages":[{"title":"CLI Introduction","href":"/api-reference/cli/overview"},{"title":"CLI surface map","sidebarTitle":"Surface map","href":"/api-reference/cli/surface-map"},{"group":"Concepts","pages":[{"title":"Authentication","href":"/api-reference/cli/authentication"},{"title":"Output and scripting","href":"/api-reference/cli/output"},{"title":"Async and polling","href":"/api-reference/cli/async"}]},{"group":"Commands","expanded":true,"pages":[{"title":"gcai chat CLI commands","sidebarTitle":"Chat","href":"/api-reference/cli/commands/chat"},{"title":"gcai company CLI commands","sidebarTitle":"Company","href":"/api-reference/cli/commands/company"},{"title":"gcai company-profiles CLI commands","sidebarTitle":"Company-profiles","href":"/api-reference/cli/commands/company-profiles"},{"title":"gcai files CLI commands","sidebarTitle":"Files","href":"/api-reference/cli/commands/files"},{"title":"gcai folders CLI commands","sidebarTitle":"Folders","href":"/api-reference/cli/commands/folders"},{"title":"gcai jobs CLI commands","sidebarTitle":"Jobs","href":"/api-reference/cli/commands/jobs"},{"title":"gcai mcp CLI commands","sidebarTitle":"Mcp","href":"/api-reference/cli/commands/mcp"},{"title":"gcai me CLI commands","sidebarTitle":"Me","description":"Reference for the `gcai me` commands in the GC AI CLI, with the synopsis and flags for each command.","href":"/api-reference/cli/commands/me"},{"title":"gcai ping CLI commands","sidebarTitle":"Ping","href":"/api-reference/cli/commands/ping"},{"title":"gcai playbooks CLI commands","sidebarTitle":"Playbooks","description":"Reference for the `gcai playbooks` commands in the GC AI CLI, with the synopsis and flags for each command.","href":"/api-reference/cli/commands/playbooks"},{"title":"gcai profile CLI commands","sidebarTitle":"Profile","href":"/api-reference/cli/commands/profile"},{"title":"gcai projects CLI commands","sidebarTitle":"Projects","href":"/api-reference/cli/commands/projects"},{"title":"gcai skills CLI commands","sidebarTitle":"Skills","href":"/api-reference/cli/commands/skills"},{"title":"gcai usage CLI commands","sidebarTitle":"Usage","href":"/api-reference/cli/commands/usage"},{"title":"gcai vaults CLI commands","sidebarTitle":"Vaults","href":"/api-reference/cli/commands/vaults"}]}]}]}]},"basePath":"","title":"gcai ping CLI commands - GC AI","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}