Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin et suscipit tellus, euismod varius enim. In porta rutrum augue non faucibus. Nam purus urna, dapibus dictum porta ut, congue eget dolor. Fusce eget bibendum est, at mollis nisi. Mauris vehicula a tellus ut sagittis. Cras ornare, orci id scelerisque pharetra, metus lorem tempor libero, nec tincidunt risus lectus id felis. Nunc a sem sit amet libero posuere posuere. Phasellus eu tincidunt lorem, sed tempus urna. Morbi bibendum nec arcu non pellentesque. Phasellus rhoncus ex egestas sapien rutrum, ac aliquet nunc porta. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Ut scelerisque lectus vel lorem tempus, quis sodales sem interdum. Mauris eu metus quis ipsum commodo laoreet. Vestibulum non luctus dolor.
Was this page helpful?
⌘I
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Stoaty | Developer Documentation","colors":{"primary":"#3e6555"},"logo":{"light":"https://mintcdn.com/stoaty/nADH59ZT5RD_w2hL/logo/light.svg?fit=max\u0026auto=format\u0026n=nADH59ZT5RD_w2hL\u0026q=85\u0026s=0ed510933563806efb1bb9af076f5050","dark":"https://mintcdn.com/stoaty/nADH59ZT5RD_w2hL/logo/dark.svg?fit=max\u0026auto=format\u0026n=nADH59ZT5RD_w2hL\u0026q=85\u0026s=0685c70b873e42ea27919cbb710ec765"},"favicon":"favicon.svg","api":{},"background":{"decoration":"grid"},"navbar":{"links":[{"label":"Support","href":"mailto:hello@stoaty.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.stoaty.com"}},"footer":{},"navigation":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"https://stoaty.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stoaty","hasAudioNarration":false,"actualSubdomain":"stoaty","customDomains":["docs.stoaty.com"],"gitSource":{"type":"github","owner":"mdcarter","repo":"stoaty","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c7c1ca764992bd9d33a9","collectionId":"bbd62e08-40c6-4932-ae38-3f60e4c5b6f5","schemaVersion":"v2"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6a20c7c1ca764992bd9d33a9:success","clientVersion":"0.0.3908","searchFilterCounts":[{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"API Reference","count":2},{"language":"default","tag":"Products","count":1},{"language":"default","tag":"Subscription","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":"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":"vite-origin","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":"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":false},"customCss":[],"page":{"pagePath":"getting-started/introduction","slug":"/getting-started/introduction","pageMetadata":{"title":"Introduction","description":"Learn how to use the Stoaty API","icon":"rocket","iconType":"light","href":"/getting-started/introduction"},"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: \"Learn how to use the Stoaty API\"\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={p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`lorem-ipsum`,children:`Lorem Ipsum`}),`\n`,_jsx(_components.p,{children:`Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin et suscipit tellus, euismod varius enim.`}),`\n`,_jsx(Heading,{level:`2`,id:`lorem-ipusm`,children:`Lorem ipusm`}),`\n`,_jsx(_components.p,{children:`Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin et suscipit tellus, euismod varius enim. In porta rutrum augue non faucibus. Nam purus urna, dapibus dictum porta ut, congue eget dolor. Fusce eget bibendum est, at mollis nisi. Mauris vehicula a tellus ut sagittis. Cras ornare, orci id scelerisque pharetra, metus lorem tempor libero, nec tincidunt risus lectus id felis. Nunc a sem sit amet libero posuere posuere. Phasellus eu tincidunt lorem, sed tempus urna. Morbi bibendum nec arcu non pellentesque. Phasellus rhoncus ex egestas sapien rutrum, ac aliquet nunc porta. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Ut scelerisque lectus vel lorem tempus, quis sodales sem interdum. Mauris eu metus quis ipsum commodo laoreet. Vestibulum non luctus dolor.`})]})}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":"Introduction","description":"Learn how to use the Stoaty API","icon":"rocket","iconType":"light","href":"/getting-started/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Lorem Ipsum","slug":"lorem-ipsum","depth":2,"children":[]},{"title":"Lorem ipusm","slug":"lorem-ipusm","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"stoaty","siteName":"Stoaty | Developer Documentation","title":"Introduction - Stoaty | Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T06:58:42.294Z","originalFileLocation":"getting-started/introduction.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=\"Learn how to use the Stoaty API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Stoaty | Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stoaty/W9is1TcYEAT1rPyv/_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/stoaty/W9is1TcYEAT1rPyv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stoaty/W9is1TcYEAT1rPyv/_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/stoaty/W9is1TcYEAT1rPyv/_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/stoaty/W9is1TcYEAT1rPyv/_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/stoaty/W9is1TcYEAT1rPyv/_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/stoaty/W9is1TcYEAT1rPyv/_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/stoaty/W9is1TcYEAT1rPyv/_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/stoaty/W9is1TcYEAT1rPyv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Stoaty | Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how to use the Stoaty API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stoaty | Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stoaty.com/getting-started/introduction\">\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 - Stoaty | Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how to use the Stoaty API\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/stoaty/W9is1TcYEAT1rPyv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Stoaty | Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3e6555\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stoaty.com/getting-started/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stoaty.com/#organization\",\"name\":\"Stoaty | Developer Documentation\",\"url\":\"https://docs.stoaty.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stoaty/nADH59ZT5RD_w2hL/logo/light.svg?fit=max\u0026auto=format\u0026n=nADH59ZT5RD_w2hL\u0026q=85\u0026s=0ed510933563806efb1bb9af076f5050\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stoaty.com#website\",\"name\":\"Stoaty | Developer Documentation\",\"url\":\"https://docs.stoaty.com\",\"publisher\":{\"@id\":\"https://docs.stoaty.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stoaty.com/getting-started/introduction#webpage\",\"url\":\"https://docs.stoaty.com/getting-started/introduction\",\"name\":\"Introduction\",\"description\":\"Learn how to use the Stoaty API\",\"dateModified\":\"2026-01-07T06:58:42.294Z\",\"isPartOf\":{\"@id\":\"https://docs.stoaty.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stoaty.com/getting-started/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stoaty.com/getting-started/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Stoaty | Developer Documentation\",\"item\":\"https://docs.stoaty.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.stoaty.com/getting-started/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.stoaty.com/getting-started/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Learn how to use the Stoaty API\",\"url\":\"https://docs.stoaty.com/getting-started/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stoaty.com/getting-started/introduction#webpage\"},\"dateModified\":\"2026-01-07T06:58:42.294Z\",\"publisher\":{\"@id\":\"https://docs.stoaty.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stoaty.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Stoaty | Developer Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Stoaty | Developer Documentation","nav":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"https://stoaty.com"}]},"tabs":[{"tab":"Guides","groups":[{"group":"Get Started","pages":[{"title":"Introduction","icon":"rocket","iconType":"light","href":"/getting-started/introduction"},{"title":"Authentication","description":"How to authenticate yourself to the API ?","icon":"key","iconType":"light","href":"/getting-started/authentication"},{"title":"Tokens usage","icon":"coin-front","iconType":"light","href":"/getting-started/tokens-usage"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/endpoint/analyze"}]}]},"title":"Introduction - Stoaty | Developer Documentation","buildId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","deploymentId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","dynamics":[],"chunks":[]}