The Shamrock API is still in an early access state, and is not intended for full use as of now. Some listed endpoints will not have full functionality.
At this time, shamrock is available only to select servers, we apologise for the inconvenience.
In order to generate a Shamrock API key, the owner of a discord server with the Shamrock Bot added must run the !apikey generate command. Shamrock will then attempt to DM you your new API key. Should this key get leaked or compromised you may regenerate it any time via the same command used to create it.
You are responsible for keeping your API key safe.
That’s perfectly fine! We welcome newer developers to experiment with our API, but we must remind you, you do so at your own risk. We will be unable to provide support if something gets messed up due to user error. We are also unable to provide development support unless you are facing an error caused by our systems.
We encourage all experimentation happens in an isolated testing server.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Mintlify Starter Kit","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/shamrock/3LLk-P7rAkEpGcwi/images/Untitled(512x512px)(3000x500px)(2).png?fit=max\u0026auto=format\u0026n=3LLk-P7rAkEpGcwi\u0026q=85\u0026s=b13058af5c42485f198eac863bcb4f95","dark":"https://mintcdn.com/shamrock/3LLk-P7rAkEpGcwi/images/Untitled(512x512px)(3000x500px)(2).png?fit=max\u0026auto=format\u0026n=3LLk-P7rAkEpGcwi\u0026q=85\u0026s=b13058af5c42485f198eac863bcb4f95"},"favicon":{"light":"https://mintcdn.com/shamrock/Mz-62pVhBd-XvbGf/images/Untitled(512x512px).png?fit=max\u0026auto=format\u0026n=Mz-62pVhBd-XvbGf\u0026q=85\u0026s=340320567c4bf6e0480e177dc6ad7229","dark":"https://mintcdn.com/shamrock/Mz-62pVhBd-XvbGf/images/Untitled(512x512px).png?fit=max\u0026auto=format\u0026n=Mz-62pVhBd-XvbGf\u0026q=85\u0026s=340320567c4bf6e0480e177dc6ad7229"},"api":{"playground":{"display":"interactive"},"url":"full","mdx":{"server":"https://apis.shamrockbot.xyz/v1"}},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"mailto:hi@mintlify.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.mintlify.com"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support Server","icon":"discord","color":{"light":"#2ecc71","dark":"#2ecc71"},"href":"https://www.discord.gg/QRMtaN5KHh"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"shamrock","hasAudioNarration":false,"actualSubdomain":"shamrock","customDomains":["apidocs.shamrockbot.xyz"],"gitSource":{"type":"github","owner":"mintlify-community","repo":"docs-shamrock-8d6d4deb","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"52e043a0-ba87-4f6b-a4ee-303b4da4ad24","liveDeploymentHistoryId":"6a446a0b4bf3129bc8e44673","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a446a0b4bf3129bc8e44673:success","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Information","count":2},{"language":"default","tag":"API Docs","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"apiIntro","slug":"/apiIntro","pageMetadata":{"title":"Shamrock Systems API","description":null,"href":"/apiIntro"},"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={code:`code`,hr:`hr`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Danger,Heading,Info,Tip,Warning}=_components;if(!Danger)_missingMdxReference(`Danger`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsx(_components.p,{children:`The Shamrock API is still in an early access state, and is not intended for full use as of now. Some listed endpoints will not have full functionality.`})}),`\n`,_jsx(Info,{children:_jsx(_components.p,{children:`At this time, shamrock is available only to select servers, we apologise for the inconvenience.`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`generating-your-server’s-api-key`,children:`Generating your server’s API Key`}),`\n`,_jsxs(_components.p,{children:[`In order to generate a Shamrock API key, the owner of a discord server with the Shamrock Bot added must run the `,_jsx(_components.code,{children:`!apikey generate`}),` command. Shamrock will then attempt to DM you your new API key. Should this key get leaked or compromised you may regenerate it any time via the same command used to create it.`]}),`\n`,_jsx(Danger,{children:_jsx(_components.p,{children:`You are responsible for keeping your API key safe.`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`not-an-experienced-developer`,children:`Not an experienced developer?`}),`\n`,_jsxs(_components.p,{children:[`That’s perfectly fine! We welcome newer developers to experiment with our API, but we must remind you, `,_jsx(_components.strong,{children:`you do so at your own risk`}),`. We will be unable to provide support if something gets messed up due to user error. We are also unable to provide development support unless you are facing an error caused by our systems.`]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`We encourage all experimentation happens in an isolated testing server.`})}),`\n`,_jsx(_components.hr,{})]})}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":"Shamrock Systems API","description":null,"href":"/apiIntro"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Generating your server’s API Key","slug":"generating-your-server’s-api-key","depth":2,"children":[]},{"title":"Not an experienced developer?","slug":"not-an-experienced-developer","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"shamrock","siteName":"Mintlify Starter Kit","title":"Shamrock Systems API - Mintlify Starter Kit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-01T01:15:02.397Z","originalFileLocation":"apiIntro.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=\"dark\"}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=\"application-name\" content=\"Mintlify Starter Kit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shamrock/CX0N2piIt6dHec67/_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/shamrock/CX0N2piIt6dHec67/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shamrock/CX0N2piIt6dHec67/_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/shamrock/CX0N2piIt6dHec67/_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/shamrock/CX0N2piIt6dHec67/_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/shamrock/CX0N2piIt6dHec67/_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/shamrock/CX0N2piIt6dHec67/_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/shamrock/CX0N2piIt6dHec67/_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/shamrock/CX0N2piIt6dHec67/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Shamrock Systems API - Mintlify Starter Kit\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mintlify Starter Kit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidocs.shamrockbot.xyz/apiIntro\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://shamrock.mintlify.app/_mintlify/api/og/v2?division=Information\u0026amp;title=Shamrock+Systems+API\u0026amp;theme=19fe71b2bfe1e39f9db7721c\u0026amp;signature=4067b4bba4e288e138c6cc48b6456ba4d0d68ba86a3557a60d736c68eb8c845a\">\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=\"Shamrock Systems API - Mintlify Starter Kit\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shamrock.mintlify.app/_mintlify/api/og/v2?division=Information\u0026amp;title=Shamrock+Systems+API\u0026amp;theme=19fe71b2bfe1e39f9db7721c\u0026amp;signature=4067b4bba4e288e138c6cc48b6456ba4d0d68ba86a3557a60d736c68eb8c845a\">\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/shamrock/CX0N2piIt6dHec67/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mintlify Starter Kit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidocs.shamrockbot.xyz/apiIntro\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/apiIntro.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidocs.shamrockbot.xyz/#organization\",\"name\":\"Mintlify Starter Kit\",\"url\":\"https://apidocs.shamrockbot.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/shamrock/3LLk-P7rAkEpGcwi/images/Untitled(512x512px)(3000x500px)(2).png?fit=max\u0026auto=format\u0026n=3LLk-P7rAkEpGcwi\u0026q=85\u0026s=b13058af5c42485f198eac863bcb4f95\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidocs.shamrockbot.xyz#website\",\"name\":\"Mintlify Starter Kit\",\"url\":\"https://apidocs.shamrockbot.xyz\",\"publisher\":{\"@id\":\"https://apidocs.shamrockbot.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidocs.shamrockbot.xyz/apiIntro#webpage\",\"url\":\"https://apidocs.shamrockbot.xyz/apiIntro\",\"name\":\"Shamrock Systems API\",\"dateModified\":\"2026-07-01T01:15:02.397Z\",\"isPartOf\":{\"@id\":\"https://apidocs.shamrockbot.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://apidocs.shamrockbot.xyz/apiIntro#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidocs.shamrockbot.xyz/apiIntro#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Mintlify Starter Kit\",\"item\":\"https://apidocs.shamrockbot.xyz\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Shamrock Systems API\",\"item\":\"https://apidocs.shamrockbot.xyz/apiIntro\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://apidocs.shamrockbot.xyz/apiIntro#article\",\"headline\":\"Shamrock Systems API\",\"name\":\"Shamrock Systems API\",\"url\":\"https://apidocs.shamrockbot.xyz/apiIntro\",\"mainEntityOfPage\":{\"@id\":\"https://apidocs.shamrockbot.xyz/apiIntro#webpage\"},\"dateModified\":\"2026-07-01T01:15:02.397Z\",\"publisher\":{\"@id\":\"https://apidocs.shamrockbot.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://apidocs.shamrockbot.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Mintlify Starter Kit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Mintlify Starter Kit","nav":{"global":{"anchors":[{"anchor":"Support Server","icon":"discord","color":{"light":"#2ecc71","dark":"#2ecc71"},"href":"https://www.discord.gg/QRMtaN5KHh"}]},"groups":[{"group":"Information","pages":[{"title":"Shamrock Systems API","href":"/apiIntro"},{"title":"Global Bans ","description":null,"href":"/g"}]},{"group":"API Docs","pages":[{"title":"Server Status","api":"POST /health","href":"/health"},{"group":"Bans","hidden":true,"pages":[{"title":"Write a ban","api":"POST /gbans/write/","href":"/write-a-ban"}]}]}]},"title":"Shamrock Systems API - Mintlify Starter Kit","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":[],"chunks":[]}
(3000x500px)(2).png?fit=max&auto=format&n=3LLk-P7rAkEpGcwi&q=85&s=b13058af5c42485f198eac863bcb4f95)