Start collecting data today with this simple guide.
API Setup
Lets add connect to your data using the serial API.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Serial","colors":{"primary":"#1C2D33","light":"#F8FAFC","dark":"#21293A"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/serial/SIljb6ZyxcerJBNg/logo/Submark%20Light.png?fit=max\u0026auto=format\u0026n=SIljb6ZyxcerJBNg\u0026q=85\u0026s=31021d14e90d5ffbc0622406b344f8d9","dark":"https://mintcdn.com/serial/SIljb6ZyxcerJBNg/logo/Submark%20Dark.png?fit=max\u0026auto=format\u0026n=SIljb6ZyxcerJBNg\u0026q=85\u0026s=9e16c13a91307a0330308e371fc3228a"},"navbar":{"primary":{"type":"button","label":"Get Started","href":"https:www.app.serial.io"}},"footer":{"socials":{"twitter":"https://twitter.com/Serialmfg","linkedin":"https://www.linkedin.com/company/serialmfg"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"serial","hasAudioNarration":false,"actualSubdomain":"serial","customDomains":["docs.serial.io"],"gitSource":{"type":"github","owner":"serialmfg","repo":"serial-app","deployBranch":"main","contentDirectory":"documentation","mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c34c4d01e0d38c5e4773","collectionId":"9b1df4db-5db5-4588-a1f2-d7ee487458d9","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c34c4d01e0d38c5e4773:success","clientVersion":"0.0.3902","searchFilterCounts":[{"language":"default","tag":"API Reference","count":41},{"language":"default","tag":"Work Orders","count":12},{"language":"default","tag":"Documentation","count":9},{"language":"default","tag":"Component Instances","count":5},{"language":"default","tag":"Processes","count":5},{"language":"default","tag":"Setup","count":5},{"language":"default","tag":"Datasets","count":4},{"language":"default","tag":"Properties","count":4},{"language":"default","tag":"Components","count":3},{"language":"default","tag":"Legacy API","count":3}]},"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":false},"customCss":[],"page":{"pagePath":"welcome/introduction","slug":"/welcome/introduction","pageMetadata":{"title":"Introduction","description":"Let us know if you can't find the answer to your question","href":"/welcome/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: \"Let us know if you can’t find the answer to your question\"\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},{Card,CardGroup,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`welcome-to-the-serial-documentation`,children:`Welcome to the Serial documentation`}),`\n`,_jsx(_components.p,{children:`This is your one stop shop for all serial related questions and concerns`}),`\n`,_jsx(Heading,{level:`2`,id:`quick-links`,children:`Quick links`}),`\n`,_jsxs(CardGroup,{children:[_jsx(Card,{title:`Serial Setup`,icon:`gear`,href:`/setup/start`,children:_jsx(_components.p,{children:`Start collecting data today with this simple guide.`})}),_jsx(Card,{title:`API Setup`,icon:`square-code`,href:`/api-reference/python/quickstart`,children:_jsx(_components.p,{children:`Lets add connect to your data using the serial API.`})})]})]})}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":"Let us know if you can't find the answer to your question","href":"/welcome/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Welcome to the Serial documentation","slug":"welcome-to-the-serial-documentation","depth":3,"children":[]},{"title":"Quick links","slug":"quick-links","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"serial","siteName":"Serial","title":"Introduction - Serial","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:47:29.160Z","originalFileLocation":"welcome/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=\"Let us know if you can\u0026#x27;t find the answer to your question\">\u003cmeta data-mint-head name=\"application-name\" content=\"Serial\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/serial/c5ZUi_E9f6w_jgf7/_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/serial/c5ZUi_E9f6w_jgf7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/serial/c5ZUi_E9f6w_jgf7/_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/serial/c5ZUi_E9f6w_jgf7/_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/serial/c5ZUi_E9f6w_jgf7/_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/serial/c5ZUi_E9f6w_jgf7/_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/serial/c5ZUi_E9f6w_jgf7/_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/serial/c5ZUi_E9f6w_jgf7/_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/serial/c5ZUi_E9f6w_jgf7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Serial\">\u003cmeta data-mint-head property=\"og:description\" content=\"Let us know if you can\u0026#x27;t find the answer to your question\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Serial\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.serial.io/welcome/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 - Serial\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Let us know if you can\u0026#x27;t find the answer to your question\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/serial/c5ZUi_E9f6w_jgf7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Serial\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1C2D33\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.serial.io/welcome/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/welcome/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.serial.io/#organization\",\"name\":\"Serial\",\"url\":\"https://docs.serial.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/serial/SIljb6ZyxcerJBNg/logo/Submark%20Light.png?fit=max\u0026auto=format\u0026n=SIljb6ZyxcerJBNg\u0026q=85\u0026s=31021d14e90d5ffbc0622406b344f8d9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.serial.io#website\",\"name\":\"Serial\",\"url\":\"https://docs.serial.io\",\"publisher\":{\"@id\":\"https://docs.serial.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.serial.io/welcome/introduction#webpage\",\"url\":\"https://docs.serial.io/welcome/introduction\",\"name\":\"Introduction\",\"description\":\"Let us know if you can't find the answer to your question\",\"dateModified\":\"2026-01-06T22:47:29.160Z\",\"isPartOf\":{\"@id\":\"https://docs.serial.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.serial.io/welcome/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.serial.io/welcome/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Serial\",\"item\":\"https://docs.serial.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.serial.io/welcome/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.serial.io/welcome/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Let us know if you can't find the answer to your question\",\"url\":\"https://docs.serial.io/welcome/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.serial.io/welcome/introduction#webpage\"},\"dateModified\":\"2026-01-06T22:47:29.160Z\",\"publisher\":{\"@id\":\"https://docs.serial.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.serial.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Serial\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Serial","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":{"name":"book-open","style":"duotone"},"groups":[{"group":"Welcome","pages":[{"title":"Introduction","href":"/welcome/introduction"}]},{"group":"Setup","pages":[{"title":"Getting Started","description":"Let's walk through the serial setup steps","href":"/setup/start"},{"title":"1. Configure Serial","href":"/setup/configure"},{"title":"2. Deploy Serial","href":"/setup/deploy"},{"title":"3. Search Data","href":"/setup/search"},{"title":"4. Adding Users","href":"/setup/users"}]},{"group":"Features","pages":[{"title":"Production Template","href":"/features/productionTemplate"},{"title":"Process Builder","href":"/features/processBuilder"}]},{"group":"FAQ","pages":[{"title":"General","href":"/faq/general"}]}]},{"anchor":"API Reference","icon":"rectangle-terminal","color":{"light":"#1e293b","dark":"#1e293b"},"pages":[{"title":"API Reference","href":"/api-reference/component-instances/get-component-instances"}]},{"anchor":"Python Library","icon":"python","color":{"light":"#1e293b","dark":"#1e293b"},"pages":[{"title":"Python Library","href":"/python/quickstart"}]},{"anchor":"Blog","href":"https://www.serial.io/blog","icon":"newspaper","color":{"light":"#1e293b","dark":"#1e293b"}}]},"title":"Introduction - Serial","buildId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","deploymentId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","dynamics":[],"chunks":[]}