Interaction with Occtoo occurs, from a technical viewpoint, through one of two use cases: as an integration component ingesting data to the platform or as a consumer of data using an Occtoo destination. The purpose of this page is to provide the reader with an understanding of how integration is performed within these two use cases.
The official .NET client, Occtoo.Sdk, handles authentication and token caching, typed source ingest, file uploads, applications, managed tags, and events. The code and documentation are in the Occtoo/dotnet-sdk repository, and the package is available on nuget.org.
The SDK is pre-1.0. Expect breaking changes until version 1.0.
Interaction with the ingest API requires authentication to ensure that only authorized applications can perform the actions available via the API. This requirement extends to protected destinations, which also demand authentication before granting access to their resources. Occtoo utilizes OAuth 2.0 and bearer tokens to ensure secure authorization and access to the right resources.OAuth 2.0 is an open standard framework for authorization that enables third-party applications to access a user’s resources without exposing their credentials. It is commonly used for delegated access, allowing users to grant limited access to their resources on one site to another site or application without sharing their credentials.A bearer token is one of the authentication methods employed in OAuth 2.0. In this method, a bearer token is a string representing the authorization granted to the client. The client includes this token in the Authorization header when making requests to access protected resources. The server validates the token and grants access if it is valid. Bearer tokens are self-contained and do not require additional information to be presented during the authentication process.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Occtoo Documentation","colors":{"primary":"#E36103","light":"#FA9A17","dark":"#EB8F38"},"logo":{"light":"https://mintcdn.com/occtoo/-gNJJgSF3T9V_IbQ/logo/occtoo-light.svg?fit=max\u0026auto=format\u0026n=-gNJJgSF3T9V_IbQ\u0026q=85\u0026s=21e485640a50820820a663446d883d87","dark":"https://mintcdn.com/occtoo/-gNJJgSF3T9V_IbQ/logo/occtoo-dark.svg?fit=max\u0026auto=format\u0026n=-gNJJgSF3T9V_IbQ\u0026q=85\u0026s=d127d743e86586f660c4432069ac6e7f"},"favicon":"https://mintcdn.com/occtoo/wBeHKCIOR2NPRpYE/favicon.ico?fit=max\u0026auto=format\u0026n=wBeHKCIOR2NPRpYE\u0026q=85\u0026s=2ef86d93e26a6f82f9947f1881a0e8e8","navbar":{"links":[{"href":"https://www.occtoo.com","label":"occtoo.com"}]},"footer":{"socials":{"github":"https://github.com/Occtoo","linkedin":"https://www.linkedin.com/company/occtoo"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"occtoo","hasAudioNarration":false,"actualSubdomain":"occtoo","customDomains":["docs.occtoo.com"],"gitSource":{"type":"github","owner":"occtoo","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adb5f3cb256aa4200f8bb43","collectionId":"9fb5ceeb-bec7-4a13-8fd7-bd3f632e547b","liveDeploymentHistoryId":"6adb5f3cb256aa4200f8bb43","schemaVersion":"v3"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adb5f3cb256aa4200f8bb43","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Documentation","count":131},{"language":"default","tag":"Guides","count":112},{"language":"default","tag":"Occtoo Studio","count":99},{"language":"default","tag":"API Reference","count":44},{"language":"default","tag":"Sources","count":33},{"language":"default","tag":"Configuration API","count":26},{"language":"default","tag":"Destinations","count":18},{"language":"default","tag":"Partner Zone","count":13},{"language":"default","tag":"Cards","count":13},{"language":"default","tag":"Get started","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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":[{"filePath":"style.css","content":"table td:first-child>code:only-child{white-space:nowrap}.occ-hero h1,.occ-home{margin:0 auto;color:var(--occ-ink)}.occ-home{--occ-accent:rgb(var(--primary));--occ-accent-text:color-mix(in srgb, rgb(var(--primary)) 82%, #1d1916);--occ-ink:#1d1916;--occ-strong:#2c2825;--occ-muted:#565250;--occ-border:rgb(3 7 18 / 0.1);--occ-card:#ffffff;--occ-tile:rgb(var(--primary) / 0.09);--occ-panel:rgb(var(--primary) / 0.06);--occ-hover-border:rgb(var(--primary) / 0.45);--occ-on-accent:#ffffff;--occ-shadow:rgba(29, 25, 22, 0.22);max-width:72rem;padding:0 1.5rem 5rem;font-size:15px;line-height:1.55}.dark .occ-home{--occ-accent:rgb(var(--primary-light));--occ-accent-text:rgb(var(--primary-light));--occ-ink:#e5e1de;--occ-strong:#ffffff;--occ-muted:#a39d97;--occ-border:rgb(255 255 255 / 0.1);--occ-card:rgb(var(--background-dark));--occ-tile:rgb(var(--primary-light) / 0.14);--occ-panel:rgb(var(--primary-light) / 0.07);--occ-hover-border:rgb(var(--primary-light) / 0.45);--occ-on-accent:rgb(var(--background-dark));--occ-shadow:rgba(0, 0, 0, 0.55)}.occ-home a{text-decoration:none}.occ-arrow{flex:none;width:15px;height:15px}.occ-hero{text-align:center;padding:3.75rem 0 2.5rem}.occ-eyebrow{font-size:11px;font-weight:700;letter-spacing:.14em;text-transform:uppercase;color:var(--occ-accent-text);margin:0 0 1.25rem}.occ-hero h1{max-width:18ch;font-size:clamp(2.25rem,5.2vw,3.4rem);font-weight:800;letter-spacing:-.03em;line-height:1.07}.occ-dot,.occ-pill svg{color:var(--occ-accent)}.occ-hl{color:var(--occ-accent-text)}.occ-lede{max-width:44ch;margin:1.15rem auto 0;color:var(--occ-muted)}.occ-popular{display:flex;flex-wrap:wrap;align-items:center;justify-content:center;gap:.5rem;margin-top:1.65rem}.occ-pill,.occ-popular-label{font-size:12px;font-weight:600}.occ-popular-label{margin-right:.25rem;color:var(--occ-muted)}.occ-pill{display:inline-flex;align-items:center;gap:.4rem;padding:.35rem .8rem;border:1px solid var(--occ-border);border-radius:999px;background:var(--occ-card);color:var(--occ-ink);transition:border-color .15s ease,transform .15s ease}.occ-pill:hover{border-color:var(--occ-accent);transform:translateY(-1px)}.occ-pill svg{flex:none}.occ-section-head{display:flex;align-items:baseline;justify-content:space-between;gap:1rem;margin:1.1rem 0}.occ-card h3,.occ-panel-head h2,.occ-section-head h2{font-weight:700;letter-spacing:-.02em;color:var(--occ-ink)}.occ-section-head h2{margin:0;font-size:1.35rem}.occ-section-link{display:inline-flex;align-items:center;gap:.35rem;font-size:13px;font-weight:600;white-space:nowrap;color:var(--occ-accent);transition:opacity .15s ease}.occ-section-link:hover{opacity:.75}.occ-grid{display:grid;grid-template-columns:repeat(3,minmax(0,1fr));gap:1rem}.occ-card{display:flex;flex-direction:column;padding:1.5rem;border:1px solid var(--occ-border);border-radius:14px;background:var(--occ-card);transition:border-color .15s ease,box-shadow .15s ease}.occ-card:hover{border-color:var(--occ-hover-border);box-shadow:0 8px 22px -14px var(--occ-shadow)}.occ-tile{--occ-tile-size:34px;display:inline-flex;align-items:center;justify-content:center;flex:none;width:var(--occ-tile-size);height:var(--occ-tile-size);border-radius:10px;background:var(--occ-tile);color:var(--occ-accent)}.occ-card .occ-tile{--occ-tile-size:44px;border-radius:12px;margin-bottom:1.25rem}.occ-card .occ-tile svg{width:22px;height:22px}.occ-card h3{margin:0 0 .5rem;font-size:17px;letter-spacing:-.01em;color:var(--occ-strong)}.occ-card p{margin:0 0 1.35rem;font-size:13.5px;line-height:1.55;color:var(--occ-muted)}.occ-card-links{margin-top:auto}.occ-sub{display:flex;align-items:center;justify-content:space-between;gap:.5rem;padding:.6rem 0;border-top:1px solid var(--occ-border);font-size:13px;font-weight:500;color:var(--occ-accent-text);transition:color .15s ease}.occ-sub .occ-arrow{opacity:.55}.occ-sub:hover{color:var(--occ-accent)}.occ-sub:hover .occ-arrow{opacity:1}.occ-panel{margin-top:1.75rem;padding:1.5rem;border:1px solid var(--occ-border);border-radius:16px;background:var(--occ-panel)}.occ-panel-head{display:flex;flex-wrap:wrap;align-items:center;justify-content:space-between;gap:1rem;margin-bottom:1.25rem}.occ-panel-head h2{margin:.35rem 0 0;font-size:1.3rem}.occ-button{display:inline-flex;align-items:center;gap:.4rem;padding:.5rem 1rem;border-radius:8px;background:var(--occ-accent);color:var(--occ-on-accent);font-size:12.5px;font-weight:700;white-space:nowrap;transition:filter .15s ease,transform .15s ease}.occ-button:hover{filter:brightness(1.07);transform:translateY(-1px)}.occ-steps{display:grid;grid-template-columns:repeat(4,minmax(0,1fr));gap:.85rem}.occ-step{padding:.9rem;border:1px solid var(--occ-border);border-radius:12px;background:var(--occ-card)}.occ-step-num{display:inline-flex;align-items:center;justify-content:center;width:20px;height:20px;margin-bottom:.85rem;border-radius:999px;background:var(--occ-accent);color:var(--occ-on-accent);font-size:11px;font-weight:700}.occ-footer-card h3,.occ-step h4{margin:0 0 .25rem;font-size:12.5px;font-weight:700;color:var(--occ-strong)}.occ-footer-card p,.occ-step p{margin:0;font-size:11.5px;line-height:1.45;color:var(--occ-muted)}.occ-footer-grid{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));gap:1rem;margin-top:1.75rem}.occ-footer-card{display:flex;align-items:flex-start;gap:.75rem;padding:1rem 1.1rem;border:1px solid var(--occ-border);border-radius:14px;background:var(--occ-card);transition:border-color .15s ease}.occ-footer-card:hover{border-color:var(--occ-hover-border)}.occ-footer-card h3{margin:0 0 .15rem;font-size:13.5px}.occ-footer-card p{font-size:12px}.occ-footer-arrow{margin-left:auto;color:var(--occ-muted)}@media (max-width:900px){.occ-grid,.occ-steps{grid-template-columns:repeat(2,minmax(0,1fr))}}@media (max-width:620px){.occ-footer-grid,.occ-grid,.occ-steps{grid-template-columns:minmax(0,1fr)}.occ-hero{padding-top:2.5rem}}"}],"page":{"pagePath":"api-reference/overview","slug":"/api-reference/overview","pageMetadata":{"title":"API overview","description":null,"href":"/api-reference/overview"},"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`,code:`code`,em:`em`,p:`p`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Interaction with Occtoo occurs, from a technical viewpoint, through one of two use cases: as an integration component ingesting data to the platform `,_jsx(_components.em,{children:`or`}),` as a consumer of data using an Occtoo destination. The purpose of this page is to provide the reader with an understanding of how integration is performed within these two use cases.`]}),`\n`,_jsx(Heading,{level:`2`,id:`net-sdk`,children:`.NET SDK`}),`\n`,_jsxs(_components.p,{children:[`The official .NET client, `,_jsx(_components.code,{children:`Occtoo.Sdk`}),`, handles authentication and token caching, typed source ingest, file uploads, applications, managed tags, and events. The code and documentation are in the `,_jsx(_components.a,{href:`https://github.com/Occtoo/dotnet-sdk`,children:`Occtoo/dotnet-sdk`}),` repository, and the package is available on `,_jsx(_components.a,{href:`https://www.nuget.org/packages/Occtoo.Sdk`,children:`nuget.org`}),`.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The SDK is pre-1.0. Expect breaking changes until version 1.0.`})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`Interaction with the ingest API requires authentication to ensure that only authorized applications can perform the actions available via the API. This requirement extends to protected destinations, which also demand authentication before granting access to their resources. Occtoo utilizes OAuth 2.0 and bearer tokens to ensure secure authorization and access to the right resources.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`https://oauth.net/2/`,children:`OAuth 2.0`}),` is an open standard framework for authorization that enables third-party applications to access a user’s resources without exposing their credentials. It is commonly used for delegated access, allowing users to grant limited access to their resources on one site to another site or application without sharing their credentials.`]}),`\n`,_jsxs(_components.p,{children:[`A `,_jsx(_components.a,{href:`https://oauth.net/2/bearer-tokens/`,children:`bearer token`}),` is one of the authentication methods employed in OAuth 2.0. In this method, a bearer token is a string representing the authorization granted to the client. The client includes this token in the Authorization header when making requests to access protected resources. The server validates the token and grants access if it is valid. Bearer tokens are self-contained and do not require additional information to be presented during the authentication process.`]})]})}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":"API overview","description":null,"href":"/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":".NET SDK","slug":"net-sdk","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"occtoo","siteName":"Occtoo Documentation","title":"API overview - Occtoo Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T13:22:01.613Z","originalFileLocation":"api-reference/overview.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=\"application-name\" content=\"Occtoo 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/occtoo/7xHmPomztRvrPxPl/_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/occtoo/7xHmPomztRvrPxPl/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/occtoo/7xHmPomztRvrPxPl/_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/occtoo/7xHmPomztRvrPxPl/_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/occtoo/7xHmPomztRvrPxPl/_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/occtoo/7xHmPomztRvrPxPl/_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/occtoo/7xHmPomztRvrPxPl/_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/occtoo/7xHmPomztRvrPxPl/_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/occtoo/7xHmPomztRvrPxPl/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API overview - Occtoo Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Occtoo Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.occtoo.com/api-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://occtoo.mintlify.app/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=API+overview\u0026amp;theme=088d609b25a5d30f2fe21826\u0026amp;signature=02f018987264fdda58def5af0c96b63759285c18a2cc392c9bc1ab0399db4e96\">\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=\"API overview - Occtoo Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://occtoo.mintlify.app/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=API+overview\u0026amp;theme=088d609b25a5d30f2fe21826\u0026amp;signature=02f018987264fdda58def5af0c96b63759285c18a2cc392c9bc1ab0399db4e96\">\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/occtoo/7xHmPomztRvrPxPl/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Occtoo Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E36103\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.occtoo.com/api-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.occtoo.com/#organization\",\"name\":\"Occtoo Documentation\",\"url\":\"https://docs.occtoo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/occtoo/-gNJJgSF3T9V_IbQ/logo/occtoo-light.svg?fit=max\u0026auto=format\u0026n=-gNJJgSF3T9V_IbQ\u0026q=85\u0026s=21e485640a50820820a663446d883d87\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.occtoo.com#website\",\"name\":\"Occtoo Documentation\",\"url\":\"https://docs.occtoo.com\",\"publisher\":{\"@id\":\"https://docs.occtoo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.occtoo.com/api-reference/overview#webpage\",\"url\":\"https://docs.occtoo.com/api-reference/overview\",\"name\":\"API overview\",\"dateModified\":\"2026-10-23T13:22:01.613Z\",\"isPartOf\":{\"@id\":\"https://docs.occtoo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.occtoo.com/api-reference/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.occtoo.com/api-reference/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Occtoo Documentation\",\"item\":\"https://docs.occtoo.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API overview\",\"item\":\"https://docs.occtoo.com/api-reference/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.occtoo.com/api-reference/overview#article\",\"headline\":\"API overview\",\"name\":\"API overview\",\"url\":\"https://docs.occtoo.com/api-reference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.occtoo.com/api-reference/overview#webpage\"},\"dateModified\":\"2026-10-23T13:22:01.613Z\",\"publisher\":{\"@id\":\"https://docs.occtoo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.occtoo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Occtoo Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Occtoo Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/get-started/introduction"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Getting started","pages":[{"title":"API overview","href":"/api-reference/overview"}]},{"group":"Application authentication","pages":[{"title":"Request an Application access token","sidebarTitle":"Application access token","description":"Exchange Application or Data Provider credentials for a short-lived Occtoo access token.","openapi":"api-reference/openapi/applications.json POST /oauth2/token","playground":"interactive","href":"/api-reference/authentication/application-token"}]},{"group":"Ingest API","pages":[{"title":"Ingest","href":"/api-reference/ingest/overview"},{"title":"Ingest typed JSON into a source","deprecated":null,"version":null,"sidebarTitle":"Typed source entries","tag":"NEW","openapi":"/api-reference/openapi/ingest.json post /v1/sources/{sourceId}","href":"/api-reference/ingest/typed-source-entries"},{"title":"Read source entries by ID","deprecated":null,"version":null,"sidebarTitle":"Read source entries","openapi":"/api-reference/openapi/ingest.json get /v1/sources/{sourceId}/entries","href":"/api-reference/ingest/read-source-entries"},{"title":"Read a typed source entry","deprecated":null,"version":null,"sidebarTitle":"Read source entry","openapi":"/api-reference/openapi/ingest.json get /v1/sources/{sourceId}/entries/{entryId}","href":"/api-reference/ingest/read-source-entry"},{"title":"Start an asynchronous ingest","deprecated":true,"version":null,"openapi":"/api-reference/openapi/ingest.json post /datasources/{dataSource}/import","href":"/api-reference/ingest/start-an-asynchronous-ingest"}]},{"group":"Events API","pages":[{"title":"Events","href":"/api-reference/events/overview"},{"title":"List public event types and schema versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi/events.json get /v1/event-types","href":"/api-reference/event-discovery/list-public-event-types-and-schema-versions"},{"title":"Pull public events","deprecated":null,"version":null,"openapi":"/api-reference/openapi/events.json get /v1/events","href":"/api-reference/event-delivery/pull-public-events"},{"title":"Get public event stream metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi/events.json get /v1/events/metadata","href":"/api-reference/event-delivery/get-public-event-stream-metadata"},{"title":"Stream public events using SSE","deprecated":null,"version":null,"openapi":"/api-reference/openapi/events.json get /v1/events/stream","href":"/api-reference/event-delivery/stream-public-events-using-sse"},{"title":"Get a versioned event data schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi/events.json get /v1/events/schemas/{type}/{version}","href":"/api-reference/event-schemas/get-a-versioned-event-data-schema"},{"title":"Event stream (SSE)","href":"/api-reference/events/streaming"},{"title":"Durable consumers","href":"/api-reference/events/durable-consumers"},{"title":"Pull the next leased batch of events","deprecated":null,"version":null,"openapi":"/api-reference/openapi/events.json post /v1/event-destinations/{id}/pull","href":"/api-reference/event-delivery/pull-the-next-leased-batch-of-events"},{"title":"Acknowledge a leased batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi/events.json post /v1/event-destinations/{id}/acknowledge","href":"/api-reference/event-delivery/acknowledge-a-leased-batch"}]},{"group":"Configuration API","pages":[{"title":"Configuration","href":"/api-reference/configuration/overview"},{"group":"Sources","pages":[{"title":"List sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/sources","href":"/api-reference/sources/list-sources"},{"title":"Create a source","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json post /v1/sources","href":"/api-reference/sources/create-a-source"},{"title":"Get a source","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/sources/{sourceId}","href":"/api-reference/sources/get-a-source"},{"title":"Update source metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json patch /v1/sources/{sourceId}","href":"/api-reference/sources/update-source-metadata"},{"title":"Delete a source","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json delete /v1/sources/{sourceId}","href":"/api-reference/sources/delete-a-source"},{"title":"List source properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/sources/{sourceId}/properties","href":"/api-reference/sources/list-source-properties"},{"title":"Get a source property","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/sources/{sourceId}/properties/{propertyId}","href":"/api-reference/sources/get-a-source-property"},{"title":"Create or update a source property","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json put /v1/sources/{sourceId}/properties/{propertyId}","href":"/api-reference/sources/create-or-update-a-source-property"},{"title":"Delete a source property","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json delete /v1/sources/{sourceId}/properties/{propertyId}","href":"/api-reference/sources/delete-a-source-property"}]},{"group":"Applications","pages":[{"title":"List applications","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/applications","href":"/api-reference/applications/list-applications"},{"title":"Create an application","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json post /v1/applications","href":"/api-reference/applications/create-an-application"},{"title":"Discover application access options","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/applications/access-catalog","href":"/api-reference/applications/discover-application-access-options"},{"title":"Get an application","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/applications/{applicationId}","href":"/api-reference/applications/get-an-application"},{"title":"Replace application settings and access","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json put /v1/applications/{applicationId}","href":"/api-reference/applications/replace-application-settings-and-access"},{"title":"Delete an application and revoke its credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json delete /v1/applications/{applicationId}","href":"/api-reference/applications/delete-an-application-and-revoke-its-credentials"}]},{"group":"Managed tags","pages":[{"title":"List managed tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/managed-tags","href":"/api-reference/managed-tags/list-managed-tags"},{"title":"Create a managed tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json post /v1/managed-tags","href":"/api-reference/managed-tags/create-a-managed-tag"},{"title":"Get a managed tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/managed-tags/{managedTagId}","href":"/api-reference/managed-tags/get-a-managed-tag"},{"title":"Replace managed tag settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json put /v1/managed-tags/{managedTagId}","href":"/api-reference/managed-tags/replace-managed-tag-settings"},{"title":"Delete a managed tag and its values","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json delete /v1/managed-tags/{managedTagId}","href":"/api-reference/managed-tags/delete-a-managed-tag-and-its-values"},{"title":"List managed tag values","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/managed-tags/{managedTagId}/values","href":"/api-reference/managed-tag-values/list-managed-tag-values"},{"title":"Create a managed tag value","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json post /v1/managed-tags/{managedTagId}/values","href":"/api-reference/managed-tag-values/create-a-managed-tag-value"},{"title":"Get a managed tag value","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json get /v1/managed-tags/{managedTagId}/values/{key}","href":"/api-reference/managed-tag-values/get-a-managed-tag-value"},{"title":"Replace a managed tag value","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json put /v1/managed-tags/{managedTagId}/values/{key}","href":"/api-reference/managed-tag-values/replace-a-managed-tag-value"},{"title":"Delete a managed tag value","deprecated":null,"version":null,"openapi":"/api-reference/openapi/configuration.json delete /v1/managed-tags/{managedTagId}/values/{key}","href":"/api-reference/managed-tag-values/delete-a-managed-tag-value"}]}]},{"group":"Data consumption","pages":[{"title":"Destination","href":"/api-reference/consumption/overview"}]}]},{"tab":"Integrations","icon":"plug","hidden":true,"pages":[{"title":"Integrations","href":"/integrations/providers/overview"}]},{"tab":"Changelog","icon":"list-check","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Announcements","icon":"bullhorn","pages":[{"title":"Announcements","href":"/announcements/overview"}]}]},"title":"API overview - Occtoo Documentation","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":[],"chunks":[]}