Set up a new folder wherever you want and create a virtual env:
python3 -m virtualenv .venv
Source virtual env:
source .venv/bin/activate
Install Beam SDK
Install Beam SDK
pip install beam-sdk
Defining a runtime
Your Beam runtime is defined in Python. Running the code below will create an
environment with the compute defined above, build the image, and hot reload as
you work.
The number of CPU cores to provide to your runtime
memory
string
The amount of memory to provide to your runtime
gpu
int
The number of GPU cores to provide to your runtime
python_version
string
The Python version to install in your runtime
python_packages
array
The Python libraries to install in your runtime. These can have versioned specified, e.g. tensorflow==0.2.10
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Slai","colors":{"primary":"#477ff7","light":"#93c5fd","dark":"#2563eb"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/slai-docs/x8Ejwqb1sXwT0acS/logo/light.svg?fit=max\u0026auto=format\u0026n=x8Ejwqb1sXwT0acS\u0026q=85\u0026s=db8f5b5f184192d8225e18682bdcdd17","dark":"https://mintcdn.com/slai-docs/x8Ejwqb1sXwT0acS/logo/dark.svg?fit=max\u0026auto=format\u0026n=x8Ejwqb1sXwT0acS\u0026q=85\u0026s=e9a2faa70ba540818bf6e625ae5b9f56"},"navbar":{"links":[{"label":"Dashboard","href":"https://www.slai.io/models"}],"primary":{"type":"button","label":"Start a new project","href":"https://www.slai.io/launchpad"}},"footer":{"socials":{"website":"https://slai.io"}},"integrations":{"ga4":{"measurementId":"G-XN1SS41L9X"},"logrocket":{"appId":"tmarkn/slai-production"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"slai-docs","hasAudioNarration":false,"actualSubdomain":"slai-docs","customDomains":["docs.slai.io"],"gitSource":{"type":"github","owner":"slai-labs","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae913e4efc85bd31467acd5:success","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":26},{"language":"default","tag":"Sandbox","count":7},{"language":"default","tag":"Integrations","count":5},{"language":"default","tag":"User Guides","count":5},{"language":"default","tag":"Security","count":3},{"language":"default","tag":"Dashboard","count":2},{"language":"default","tag":"Terms and Conditions","count":2},{"language":"default","tag":"API Reference","count":1},{"language":"default","tag":"Home","count":1},{"language":"default","tag":"Pricing","count":1}]},"assistantConfig":{},"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"beam/tools/sdk","slug":"/beam/tools/sdk","pageMetadata":{"title":"SDK","description":"The library for creating and managing Beam apps","href":"/beam/tools/sdk"},"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: \"The library for creating and managing Beam apps\"\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={code:`code`,em:`em`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,Heading,Table}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`installation`,children:`Installation`}),`\n`,_jsxs(AccordionGroup,{children:[_jsxs(Accordion,{title:`Setup Virtual Environment`,icon:`circle-1`,iconType:`solid`,id:`setup-virtual-environment`,children:[_jsx(_components.p,{children:`Set up a new folder wherever you want and create a virtual env:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`python3 -m virtualenv .venv`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:`Source virtual env:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`source .venv/bin/activate`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(Accordion,{title:`Install Beam SDK`,icon:`circle-2`,iconType:`solid`,id:`install-beam-sdk`,children:[_jsx(_components.p,{children:`Install Beam SDK`}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`pip install beam-sdk`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`defining-a-runtime`,children:`Defining a runtime`}),`\n`,_jsx(_components.p,{children:`Your Beam runtime is defined in Python. Running the code below will create an\nenvironment with the compute defined above, build the image, and hot reload as\nyou work.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`python`,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:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`beam.App(`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`\tname`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"testapp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`\tcpu`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`8`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`\tmemory`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"4Gi\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`\tgpu`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`\tpython_version`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"python3.8\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`\tpython_packages`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"numpy\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`app-reference`,children:`app() reference`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`name`})}),_jsx(_components.td,{children:_jsx(_components.em,{children:`string`})}),_jsx(_components.td,{children:`The name for your app`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cpu`})}),_jsx(_components.td,{children:_jsx(_components.em,{children:`int, 0-16`})}),_jsx(_components.td,{children:`The number of CPU cores to provide to your runtime`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`memory`})}),_jsx(_components.td,{children:_jsx(_components.em,{children:`string`})}),_jsx(_components.td,{children:`The amount of memory to provide to your runtime`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`gpu`})}),_jsx(_components.td,{children:_jsx(_components.em,{children:`int`})}),_jsx(_components.td,{children:`The number of GPU cores to provide to your runtime`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`python_version`})}),_jsx(_components.td,{children:_jsx(_components.em,{children:`string`})}),_jsx(_components.td,{children:`The Python version to install in your runtime`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`python_packages`})}),_jsx(_components.td,{children:_jsx(_components.em,{children:`array`})}),_jsxs(_components.td,{children:[`The Python libraries to install in your runtime. These can have versioned specified, e.g. `,_jsx(_components.code,{children:`tensorflow==0.2.10`})]})]})]})]})]})}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":"SDK","description":"The library for creating and managing Beam apps","href":"/beam/tools/sdk"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Installation","slug":"installation","depth":3,"children":[]},{"title":"Defining a runtime","slug":"defining-a-runtime","depth":3,"children":[]},{"title":"app() reference","slug":"app-reference","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"slai-docs","siteName":"Slai","title":"SDK - Slai","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:37:44.623Z","originalFileLocation":"beam/tools/sdk.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=\"The library for creating and managing Beam apps\">\u003cmeta data-mint-head name=\"application-name\" content=\"Slai\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/slai-docs/SXx20scKi4GaiL1r/_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/slai-docs/SXx20scKi4GaiL1r/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/slai-docs/SXx20scKi4GaiL1r/_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/slai-docs/SXx20scKi4GaiL1r/_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/slai-docs/SXx20scKi4GaiL1r/_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/slai-docs/SXx20scKi4GaiL1r/_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/slai-docs/SXx20scKi4GaiL1r/_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/slai-docs/SXx20scKi4GaiL1r/_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/slai-docs/SXx20scKi4GaiL1r/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"SDK - Slai\">\u003cmeta data-mint-head property=\"og:description\" content=\"The library for creating and managing Beam apps\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Slai\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.slai.io/beam/tools/sdk\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://slai-docs.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=SDK\u0026amp;description=The+library+for+creating+and+managing+Beam+apps\u0026amp;theme=472d36610d7350bc36259636\u0026amp;signature=bd6a40413532200547f6b3d378ba22786a395a230b0e66d453458df9240f57b0\">\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=\"SDK - Slai\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The library for creating and managing Beam apps\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://slai-docs.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=SDK\u0026amp;description=The+library+for+creating+and+managing+Beam+apps\u0026amp;theme=472d36610d7350bc36259636\u0026amp;signature=bd6a40413532200547f6b3d378ba22786a395a230b0e66d453458df9240f57b0\">\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/slai-docs/SXx20scKi4GaiL1r/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Slai\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#477ff7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.slai.io/beam/tools/sdk\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/beam/tools/sdk.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.slai.io/#organization\",\"name\":\"Slai\",\"url\":\"https://docs.slai.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/slai-docs/x8Ejwqb1sXwT0acS/logo/light.svg?fit=max\u0026auto=format\u0026n=x8Ejwqb1sXwT0acS\u0026q=85\u0026s=db8f5b5f184192d8225e18682bdcdd17\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.slai.io#website\",\"name\":\"Slai\",\"url\":\"https://docs.slai.io\",\"publisher\":{\"@id\":\"https://docs.slai.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.slai.io/beam/tools/sdk#webpage\",\"url\":\"https://docs.slai.io/beam/tools/sdk\",\"name\":\"SDK\",\"description\":\"The library for creating and managing Beam apps\",\"dateModified\":\"2026-01-06T22:37:44.623Z\",\"isPartOf\":{\"@id\":\"https://docs.slai.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.slai.io/beam/tools/sdk#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.slai.io/beam/tools/sdk#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tools\",\"item\":\"https://docs.slai.io/beam/tools/cli\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"SDK\",\"item\":\"https://docs.slai.io/beam/tools/sdk\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.slai.io/beam/tools/sdk#article\",\"headline\":\"SDK\",\"name\":\"SDK\",\"description\":\"The library for creating and managing Beam apps\",\"url\":\"https://docs.slai.io/beam/tools/sdk\",\"mainEntityOfPage\":{\"@id\":\"https://docs.slai.io/beam/tools/sdk#webpage\"},\"dateModified\":\"2026-01-06T22:37:44.623Z\",\"publisher\":{\"@id\":\"https://docs.slai.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.slai.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Slai\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Slai\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/beam/tools/sdk.md","siteName":"Slai","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"anchor":"Launchpad","href":"https://www.slai.io/launchpad","icon":"rocket-launch","color":{"light":"#6365f1","dark":"#6365f1"}},{"anchor":"Chat with us","href":"https://calendly.com/elimernit/slai-discovery-call","icon":"comment-dots","color":{"light":"#06b5d4","dark":"#06b5d4"}},{"anchor":"Migrate Your Model","href":"https://docs.slai.io/user-guides/migrating-an-existing-model","icon":"comments","color":{"light":"#6365f1","dark":"#6365f1"}},{"anchor":"Beam","hidden":true,"icon":"satellite-dish","groups":[{"group":"Guides","pages":[{"title":"Introduction","description":"Beam is a cloud platform where you can provision infrastructure, develop on remote runtimes from your local machine, and deploy apps as serverless functions — without leaving your IDE","href":"/beam"},{"title":"Quickstart","description":"Get started with Beam in just a few minutes","href":"/beam/getting-started/quickstart"},{"title":"Install Beam","description":null,"href":"/beam/getting-started/install-beam"},{"title":"Deploying an ML Model","description":"A short tutorial on building a sentiment analysis model and deploying it as a REST API with Beam","href":"/beam/getting-started/deploying-an-ml-model"},{"title":"Running a Web Scraper","description":"Let's build a simple web scraper which extracts headlines from The New York Times and uses a BERT model from Huggingface to detect the sentiment of each.","href":"/beam/getting-started/running-a-web-scraper"},{"title":"Stable Diffusion API","description":"Building an API to generate images with stable diffusion","href":"/beam/getting-started/stable-diffusion-gpu"},{"title":"Integration into CI/CD","description":"You can integrate Beam into an existing CI/CD process to deploy your code automatically.","href":"/beam/getting-started/ci-integration"}]},{"group":"Triggers","pages":[{"title":"REST API","description":"Deploying a Beam app as a REST API","href":"/beam/triggers/rest-api"},{"title":"Webhook","description":"Deploy async functions on Beam","href":"/beam/triggers/webhook"},{"title":"Scheduled Cron Jobs","description":"Scheduling tasks on Beam","href":"/beam/triggers/cron"}]},{"group":"Data","pages":[{"title":"Outputs","description":"Read and write files from inside a Beam environment","href":"/beam/data/outputs"},{"title":"Persistent Volumes","description":"A readable and writable data store that will persist across tasks","href":"/beam/data/persistent-volumes"}]},{"group":"Deployment","pages":[{"title":"Logging and Monitoring","description":"After deploying, you can view the traffic and container logs on your task in the dashboard.","href":"/beam/deployment/logging-and-monitoring"}]},{"group":"Tools","pages":[{"title":"CLI","description":"Build and deploy Beam apps directly from the command line","href":"/beam/tools/cli"},{"title":"SDK","href":"/beam/tools/sdk"}]},{"group":"Account","pages":[{"title":"API Keys","description":"API keys are used to access the CLI and SDK","href":"/beam/account/api-keys"},{"title":"Secrets Management","description":"Beam includes a secrets manager that allows you to use secrets across your projects.","href":"/beam/account/secrets-management"},{"title":"Pricing and Billing","description":null,"href":"/beam/account/pricing-and-billing"}]},{"group":"Security","pages":[{"title":"Terms and Conditions","description":"These are the terms the Slai Machine Learning Platform is provided under.","href":"/beam/security/terms-and-conditions"},{"title":"Privacy Policy","description":null,"href":"/beam/security/privacy-policy"}]}]}]},"basePath":"","title":"SDK - Slai","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}