This site provides everything you need to start working and integrating with Gizmo.Visit our Guides for implementation details, or start building with our detailed API Reference.
Guides
Build custom integrations with our detailed API Documentation.
API Reference
Build custom integrations with our detailed API Documentation.
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Gizmo Docs","colors":{"primary":"#1c1917","light":"#fafaf9","dark":"#1c1917"},"logo":{"light":"https://mintcdn.com/gizmo/BY_OysS1uNfG4Xzc/logo/light.svg?fit=max\u0026auto=format\u0026n=BY_OysS1uNfG4Xzc\u0026q=85\u0026s=f04611449a7ac45644f55b4fdaf104dd","dark":"https://mintcdn.com/gizmo/BY_OysS1uNfG4Xzc/logo/dark.svg?fit=max\u0026auto=format\u0026n=BY_OysS1uNfG4Xzc\u0026q=85\u0026s=7951158134f7555c0e6989fa748260c3","href":"https://usegizmo.com"},"favicon":"/favicon.svg","navbar":{"links":[{"href":"mailto:help@usegizmo.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.usegizmo.com/settings"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"fonts":{"heading":{"family":"Geist"},"body":{"family":"Inter"}},"icons":{"library":"lucide"},"styling":{"codeblocks":{"theme":"dracula"},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gizmo","hasAudioNarration":false,"actualSubdomain":"gizmo","customDomains":["docs.usegizmo.com"],"gitSource":{"type":"github","owner":"gizmo-os","repo":"gizmo","deployBranch":"master","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20cc612c120bcf7e000f4b","collectionId":"ea18f505-36f5-4adf-8224-2b8b4e11bd0d","schemaVersion":"v2"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ab5dfb31875ca6ad0c669de:failure","clientVersion":"0.0.3902","searchFilterCounts":[{"language":"default","tag":"API Reference","count":5},{"language":"default","tag":"Applications","count":3},{"language":"default","tag":"Getting Started","count":2},{"language":"default","tag":"Guides","count":1},{"language":"default","tag":"Agents","count":1},{"language":"default","tag":"Introduction","count":1}]},"assistantConfig":{},"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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"teamspace","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":"vite-origin","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":"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":"revalidation-jwt","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":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Introduction","sidebarTitle":"Getting Started","description":"Welcome to the Gizmo Documentation","mode":"wide","href":"/index"},"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: \"Welcome to the Gizmo Documentation\"\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`,p:`p`,..._provideComponents(),...props.components},{Card,Columns}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Columns)_missingMdxReference(`Columns`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This site provides everything you need to start working and integrating with Gizmo.`}),`\n`,_jsxs(_components.p,{children:[`Visit our `,_jsx(_components.a,{href:`/agents/integration`,children:`Guides`}),` for implementation details, or start building with our detailed `,_jsx(_components.a,{href:`/api-reference/index`,children:`API Reference`}),`.`]}),`\n`,_jsxs(Columns,{cols:2,children:[_jsx(Card,{horizontal:true,title:`Guides`,icon:`graduation-cap`,href:`/agents/integration`,children:_jsx(_components.p,{children:`Build custom integrations with our detailed API Documentation.`})}),_jsx(Card,{horizontal:true,title:`API Reference`,icon:`code`,href:`/api-reference/index`,children:_jsx(_components.p,{children:`Build custom integrations with our detailed API Documentation.`})})]})]})}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":{"codeStyling":{"theme":"dracula"},"config":{},"pageMetadata":{"title":"Introduction","sidebarTitle":"Getting Started","description":"Welcome to the Gizmo Documentation","mode":"wide","href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"gizmo","siteName":"Gizmo Docs","title":"Introduction - Gizmo Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-10-21T11:18:06.227Z","originalFileLocation":"index.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=\"Welcome to the Gizmo Documentation\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gizmo 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/gizmo/7NoI4kQ-FZkTPp92/_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/gizmo/7NoI4kQ-FZkTPp92/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gizmo/7NoI4kQ-FZkTPp92/_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/gizmo/7NoI4kQ-FZkTPp92/_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/gizmo/7NoI4kQ-FZkTPp92/_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/gizmo/7NoI4kQ-FZkTPp92/_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/gizmo/7NoI4kQ-FZkTPp92/_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/gizmo/7NoI4kQ-FZkTPp92/_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/gizmo/7NoI4kQ-FZkTPp92/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Gizmo Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Gizmo Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gizmo Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usegizmo.com\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - Gizmo Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Gizmo Documentation\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gizmo/7NoI4kQ-FZkTPp92/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gizmo Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1c1917\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usegizmo.com\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usegizmo.com/#organization\",\"name\":\"Gizmo Docs\",\"url\":\"https://docs.usegizmo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gizmo/BY_OysS1uNfG4Xzc/logo/light.svg?fit=max\u0026auto=format\u0026n=BY_OysS1uNfG4Xzc\u0026q=85\u0026s=f04611449a7ac45644f55b4fdaf104dd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usegizmo.com#website\",\"name\":\"Gizmo Docs\",\"url\":\"https://docs.usegizmo.com\",\"publisher\":{\"@id\":\"https://docs.usegizmo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usegizmo.com/#webpage\",\"url\":\"https://docs.usegizmo.com/\",\"name\":\"Introduction\",\"description\":\"Welcome to the Gizmo Documentation\",\"dateModified\":\"2025-10-21T11:18:06.227Z\",\"isPartOf\":{\"@id\":\"https://docs.usegizmo.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.usegizmo.com/#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to the Gizmo Documentation\",\"url\":\"https://docs.usegizmo.com/\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usegizmo.com/#webpage\"},\"dateModified\":\"2025-10-21T11:18:06.227Z\",\"publisher\":{\"@id\":\"https://docs.usegizmo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usegizmo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gizmo Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gizmo Docs","nav":{"global":null,"tabs":[{"tab":"Introduction","icon":"rocket","pages":[{"title":"Introduction","sidebarTitle":"Getting Started","mode":"wide","href":""}]},{"tab":"Guides","icon":"graduation-cap","pages":[{"title":"Guides","href":"/agents/integration"}]},{"tab":"API Reference","icon":"code","pages":[{"title":"API Reference","href":"/api-reference"}]}]},"title":"Introduction - Gizmo Docs","buildId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","deploymentId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","dynamics":[],"chunks":[]}