Authenticate with an API key or an OAuth bearer token.
The Sequentum Cloud API supports two authentication schemes. API keys are what most server-to-server integrations should use. OAuth bearer tokens are used by the Control Center web UI and by partners building user-facing integrations.
API keys are issued per user and can only be created by a workspace administrator.
As an admin, open the Users page in Control Center.
Find the user the key belongs to and click Manage API keys.
Click New API key.
Set an expiration (default: 1 year — adjust to match your security policy) and an optional description.
Copy the key immediately. Sequentum stores only a hash; if the key is lost, the only path forward is to delete the entry and generate a new one.
API keys are full-access on behalf of the user they were issued to. Treat them like passwords: never commit them, never put them in client-side code, rotate when staff leave.
An admin revokes a key from the same Users → Manage API keys screen. Revocation is immediate; in-flight requests using the key will continue to completion.
For user-context flows (the Control Center web UI, OAuth-integrated partner apps), exchange an OAuth credential for a JWT and send it as a Bearer token:
The JWT carries the user’s identity and Space membership. Bearer tokens are short-lived; refresh per the standard OAuth 2.0 flow when they expire.If you’re building a server-side integration, prefer the API key path above — it’s simpler, doesn’t require a token-refresh loop, and produces clearer audit trails.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sequentum Developer Documentation","description":"Build, run, and operate web data agents at enterprise scale.","colors":{"primary":"#5248f9","light":"#7c74fb","dark":"#14163b"},"logo":{"light":"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=0a67e1bcfec589a284d603f793833f43","dark":"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/logo/wordmark-dark.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=2c2373b40cd1969f989d11624005229b","href":"https://docs.sequentum.com"},"favicon":{"light":"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/favicon-light.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=7b586086bac293498d14050730848a18","dark":"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/favicon-dark.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=93ab6db44ff5945729856e1209d0bc5c"},"navbar":{"links":[{"href":"https://www.sequentum.com/contact-us","label":"Support"}],"primary":{"type":"button","label":"Get API Key","href":"https://dashboard.sequentum.com/user/api-keys"}},"footer":{"socials":{"x":"https://x.com/sequentum","linkedin":"https://www.linkedin.com/company/sequentum","github":"https://github.com/sequentum"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sequentum","hasAudioNarration":false,"actualSubdomain":"sequentum","customDomains":["docs.sequentum.com"],"gitSource":{"type":"github","owner":"sequentum","repo":"sequentum-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae566d14f6cee598f7bd105","collectionId":"1284149c-11bf-4d11-8aa2-609e19837aea","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae566d14f6cee598f7bd105"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae566d14f6cee598f7bd105","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Agents","count":64},{"language":"default","tag":"Documentation","count":60},{"language":"default","tag":"API reference","count":48},{"language":"default","tag":"Commands","count":43},{"language":"default","tag":"Export","count":11},{"language":"default","tag":"Extract","count":9},{"language":"default","tag":"Schedules","count":7},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Agent Builder","count":6},{"language":"default","tag":"Billing","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":"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":"llms-txt-v2","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":"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":"vite-origin","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Authentication","description":"Authenticate with an API key or an OAuth bearer token.","href":"/api-reference/authentication"},"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: \"Authenticate with an API key or an OAuth bearer token.\"\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`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The Sequentum Cloud API supports two authentication schemes. `,_jsx(_components.strong,{children:`API keys`}),` are what most server-to-server integrations should use. `,_jsx(_components.strong,{children:`OAuth bearer tokens`}),` are used by the Control Center web UI and by partners building user-facing integrations.`]}),`\n`,_jsx(Heading,{level:`2`,id:`api-key-recommended`,children:`API key (recommended)`}),`\n`,_jsxs(_components.p,{children:[`Send your key in the `,_jsx(_components.code,{children:`Authorization`}),` header, prefixed with `,_jsx(_components.code,{children:`ApiKey`}),`:`]}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Python`,numberOfLines:`7`,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:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://dashboard.sequentum.com/api/v1/agent/all\"`}),_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:` headers`}),_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:`\"Authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ApiKey `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`os.environ[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'SEQUENTUM_API_KEY'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_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`]})})}),_jsx(CodeBlock,{filename:`TypeScript`,numberOfLines:`3`,language:`typescript`,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:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://dashboard.sequentum.com/api/v1/agent/all\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Authorization:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\" `ApiKey \"}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:\"${\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`process`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`env`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`SEQUENTUM_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"`\"}),_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`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`2`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://dashboard.sequentum.com/api/v1/agent/all\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: ApiKey `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$SEQUENTUM_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`3`,id:`generating-a-key`,children:`Generating a key`}),`\n`,_jsx(_components.p,{children:`API keys are issued per user and can only be created by a workspace administrator.`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`As an admin, open the `,_jsx(_components.strong,{children:`Users`}),` page in Control Center.`]}),`\n`,_jsxs(_components.li,{children:[`Find the user the key belongs to and click `,_jsx(_components.strong,{children:`Manage API keys`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`New API key`}),`.`]}),`\n`,_jsx(_components.li,{children:`Set an expiration (default: 1 year — adjust to match your security policy) and an optional description.`}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Copy the key immediately.`}),` Sequentum stores only a hash; if the key is lost, the only path forward is to delete the entry and generate a new one.`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`API keys are full-access on behalf of the user they were issued to. Treat them like passwords: never commit them, never put them in client-side code, rotate when staff leave.`})}),`\n`,_jsx(Heading,{level:`3`,id:`storing-keys`,children:`Storing keys`}),`\n`,_jsx(_components.p,{children:`Use environment variables, not source files:`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`python`,numberOfLines:`2`,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:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os.environ[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SEQUENTUM_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`ts`,numberOfLines:`1`,language:`typescript`,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:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` process`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`env`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`SEQUENTUM_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`!`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`bash`,numberOfLines:`1`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` SEQUENTUM_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"...\"`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`3`,id:`revocation`,children:`Revocation`}),`\n`,_jsxs(_components.p,{children:[`An admin revokes a key from the same `,_jsx(_components.strong,{children:`Users → Manage API keys`}),` screen. Revocation is immediate; in-flight requests using the key will continue to completion.`]}),`\n`,_jsx(Heading,{level:`3`,id:`scopes`,children:`Scopes`}),`\n`,_jsx(_components.p,{children:`All keys are currently full-access for the user they were issued to. Scoped keys (read-only, runs-only, billing-only) are on the roadmap.`}),`\n`,_jsx(Heading,{level:`2`,id:`oauth-bearer-token`,children:`OAuth bearer token`}),`\n`,_jsx(_components.p,{children:`For user-context flows (the Control Center web UI, OAuth-integrated partner apps), exchange an OAuth credential for a JWT and send it as a Bearer token:`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Python`,numberOfLines:`7`,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:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://dashboard.sequentum.com/api/v1/agent/all\"`}),_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:` headers`}),_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:`\"Authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bearer `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`os.environ[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'JWT'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_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`]})})}),_jsx(CodeBlock,{filename:`TypeScript`,numberOfLines:`3`,language:`typescript`,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:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://dashboard.sequentum.com/api/v1/agent/all\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Authorization:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\" `Bearer \"}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:\"${\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`process`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`env`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`JWT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"`\"}),_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`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`2`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://dashboard.sequentum.com/api/v1/agent/all\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$JWT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})})]}),`\n`,_jsx(_components.p,{children:`The JWT carries the user’s identity and Space membership. Bearer tokens are short-lived; refresh per the standard OAuth 2.0 flow when they expire.`}),`\n`,_jsx(_components.p,{children:`If you’re building a server-side integration, prefer the API key path above — it’s simpler, doesn’t require a token-refresh loop, and produces clearer audit trails.`})]})}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":"Authentication","description":"Authenticate with an API key or an OAuth bearer token.","href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"API key (recommended)","slug":"api-key-recommended","depth":2,"children":[{"title":"Generating a key","slug":"generating-a-key","depth":3,"children":[]},{"title":"Storing keys","slug":"storing-keys","depth":3,"children":[]},{"title":"Revocation","slug":"revocation","depth":3,"children":[]},{"title":"Scopes","slug":"scopes","depth":3,"children":[]}]},{"title":"OAuth bearer token","slug":"oauth-bearer-token","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"sequentum","siteName":"Sequentum Developer Documentation","title":"Authentication - Sequentum Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-20T15:27:34.384Z","originalFileLocation":"api-reference/authentication.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=\"Authenticate with an API key or an OAuth bearer token.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sequentum 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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Sequentum Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authenticate with an API key or an OAuth bearer token.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sequentum Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sequentum.com/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sequentum.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=Authentication\u0026amp;description=Authenticate+with+an+API+key+or+an+OAuth+bearer+token.\u0026amp;theme=79ab2d552dc11d5e80ec210a\u0026amp;signature=cc323a674076d4d66bff10bb2f61a18b25b970c50ad50075efdb2c239e589010\">\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=\"Authentication - Sequentum Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authenticate with an API key or an OAuth bearer token.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sequentum.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=Authentication\u0026amp;description=Authenticate+with+an+API+key+or+an+OAuth+bearer+token.\u0026amp;theme=79ab2d552dc11d5e80ec210a\u0026amp;signature=cc323a674076d4d66bff10bb2f61a18b25b970c50ad50075efdb2c239e589010\">\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/sequentum/VkZlqfknQ1prTgmm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sequentum Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5248f9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sequentum.com/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sequentum.com/#organization\",\"name\":\"Sequentum Developer Documentation\",\"url\":\"https://docs.sequentum.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=0a67e1bcfec589a284d603f793833f43\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sequentum.com#website\",\"name\":\"Sequentum Developer Documentation\",\"url\":\"https://docs.sequentum.com\",\"publisher\":{\"@id\":\"https://docs.sequentum.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sequentum.com/api-reference/authentication#webpage\",\"url\":\"https://docs.sequentum.com/api-reference/authentication\",\"name\":\"Authentication\",\"description\":\"Authenticate with an API key or an OAuth bearer token.\",\"dateModified\":\"2026-05-20T15:27:34.384Z\",\"isPartOf\":{\"@id\":\"https://docs.sequentum.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sequentum.com/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sequentum.com/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overview\",\"item\":\"https://docs.sequentum.com/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.sequentum.com/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.sequentum.com/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Authenticate with an API key or an OAuth bearer token.\",\"url\":\"https://docs.sequentum.com/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sequentum.com/api-reference/authentication#webpage\"},\"dateModified\":\"2026-05-20T15:27:34.384Z\",\"publisher\":{\"@id\":\"https://docs.sequentum.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sequentum.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sequentum Developer Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Sequentum Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","description":"The Sequentum Cloud REST API, organized by resource.","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","description":"Sequentum returns RFC 7807 problem details on every error.","href":"/api-reference/errors"}]},{"group":"Agent Builder","pages":[{"title":"Start an Agent Builder session","openapi":"POST /api/v1/agent-builder/start","mode":"wide","href":"/api-reference/agent-builder/start-session"},{"title":"Get session status","openapi":"GET /api/v1/agent-builder/{sessionId}/status","mode":"wide","href":"/api-reference/agent-builder/session-status"},{"title":"Stop a session","openapi":"POST /api/v1/agent-builder/{sessionId}/stop","mode":"wide","href":"/api-reference/agent-builder/session-stop"}]},{"group":"Agents","pages":[{"title":"List agents","openapi":"GET /api/v1/agent/all","mode":"wide","href":"/api-reference/agents/list"},{"title":"Search agents","openapi":"GET /api/v1/agent/search","mode":"wide","href":"/api-reference/agents/search"},{"title":"Get an agent","openapi":"GET /api/v1/agent/{agentId}","mode":"wide","href":"/api-reference/agents/get"},{"title":"Get agent content","openapi":"GET /api/v1/agent/{agentId}/content","mode":"wide","href":"/api-reference/agents/get-content"},{"title":"Upload agent content","openapi":"POST /api/v1/agent/{agentId}/content","mode":"wide","href":"/api-reference/agents/upload-content"},{"title":"Get agent input parameters","openapi":"GET /api/v1/agent/{agentId}/input-parameters","mode":"wide","href":"/api-reference/agents/input-parameters"},{"title":"Start a run","openapi":"POST /api/v1/agent/{agentId}/start","mode":"wide","href":"/api-reference/agents/start-run"},{"title":"List runs for an agent","openapi":"GET /api/v1/agent/{agentId}/runs","mode":"wide","href":"/api-reference/agents/list-runs"},{"title":"Get run status","openapi":"GET /api/v1/agent/{agentId}/run/{runId}/status","mode":"wide","href":"/api-reference/agents/run-status"},{"title":"Stop a run","openapi":"POST /api/v1/agent/{agentId}/run/{runId}/stop","mode":"wide","href":"/api-reference/agents/stop-run"},{"title":"Kill a run","openapi":"POST /api/v1/agent/{agentId}/run/{runId}/kill","mode":"wide","href":"/api-reference/agents/kill-run"},{"title":"Delete a run","openapi":"DELETE /api/v1/agent/{agentId}/run/{runId}","mode":"wide","href":"/api-reference/agents/delete-run"},{"title":"List run output files","openapi":"GET /api/v1/agent/{agentId}/run/{runId}/files","mode":"wide","href":"/api-reference/agents/run-files"},{"title":"Download a run output file","openapi":"GET /api/v1/agent/{agentId}/run/{runId}/file/{fileId}/download","mode":"wide","href":"/api-reference/agents/run-file-download"},{"title":"List agent versions","openapi":"GET /api/v1/agent/{agentId}/versions","mode":"wide","href":"/api-reference/agents/versions"},{"title":"Get version content","openapi":"GET /api/v1/agent/{agentId}/version/{versionNumber}/content","mode":"wide","href":"/api-reference/agents/version-content"},{"title":"Restore an agent version","openapi":"POST /api/v1/agent/{agentId}/version/{versionNumber}/restore","mode":"wide","href":"/api-reference/agents/restore-version"},{"title":"Archive an agent","openapi":"POST /api/v1/agent/{agentId}/archive","mode":"wide","href":"/api-reference/agents/archive"},{"title":"Unarchive an agent","openapi":"POST /api/v1/agent/{agentId}/unarchive","mode":"wide","href":"/api-reference/agents/unarchive"}]},{"group":"Schedules","pages":[{"title":"List schedules for an agent","openapi":"GET /api/v1/agent/{agentId}/schedules","mode":"wide","href":"/api-reference/schedules/list"},{"title":"Create a schedule","openapi":"POST /api/v1/agent/{agentId}/schedules","mode":"wide","href":"/api-reference/schedules/create"},{"title":"Get a schedule","openapi":"GET /api/v1/agent/{agentId}/schedules/{scheduleId}","mode":"wide","href":"/api-reference/schedules/get"},{"title":"Update a schedule","openapi":"PUT /api/v1/agent/{agentId}/schedules/{scheduleId}","mode":"wide","href":"/api-reference/schedules/update"},{"title":"Delete a schedule","openapi":"DELETE /api/v1/agent/{agentId}/schedules/{scheduleId}","mode":"wide","href":"/api-reference/schedules/delete"},{"title":"Enable a schedule","openapi":"POST /api/v1/agent/{agentId}/schedules/{scheduleId}/enable","mode":"wide","href":"/api-reference/schedules/enable"},{"title":"Disable a schedule","openapi":"POST /api/v1/agent/{agentId}/schedules/{scheduleId}/disable","mode":"wide","href":"/api-reference/schedules/disable"}]},{"group":"Analytics","pages":[{"title":"Runs summary","openapi":"GET /api/v1/analytics/runs/summary","mode":"wide","href":"/api-reference/analytics/runs-summary"},{"title":"Records summary","openapi":"GET /api/v1/analytics/records/summary","mode":"wide","href":"/api-reference/analytics/records-summary"},{"title":"Upcoming schedules","openapi":"GET /api/v1/analytics/schedules/upcoming","mode":"wide","href":"/api-reference/analytics/schedules-upcoming"},{"title":"Run diagnostics","openapi":"GET /api/v1/analytics/agents/{agentId}/runs/{runId}/diagnostics","mode":"wide","href":"/api-reference/analytics/run-diagnostics"},{"title":"Latest failure for an agent","openapi":"GET /api/v1/analytics/agents/{agentId}/latest-failure","mode":"wide","href":"/api-reference/analytics/latest-failure"}]},{"group":"Billing","pages":[{"title":"Get credits balance","openapi":"GET /api/v1/billing/credits","mode":"wide","href":"/api-reference/billing/credits"},{"title":"Get spending","openapi":"GET /api/v1/billing/spending","mode":"wide","href":"/api-reference/billing/spending"},{"title":"Billing history","openapi":"GET /api/v1/billing/history","mode":"wide","href":"/api-reference/billing/history"},{"title":"Per-agent billing summary","openapi":"GET /api/v1/billing/agents","mode":"wide","href":"/api-reference/billing/agents"},{"title":"Agent billing detail","openapi":"GET /api/v1/billing/agents/{agentId}","mode":"wide","href":"/api-reference/billing/agent"},{"title":"Agent run-level billing","openapi":"GET /api/v1/billing/agents/{agentId}/runs","mode":"wide","href":"/api-reference/billing/agent-runs"}]},{"group":"Spaces","pages":[{"title":"List spaces","openapi":"GET /api/v1/spaces","mode":"wide","href":"/api-reference/spaces/list"},{"title":"Get a space","openapi":"GET /api/v1/spaces/{spaceId}","mode":"wide","href":"/api-reference/spaces/get"},{"title":"List agents in a space","openapi":"GET /api/v1/spaces/{spaceId}/agents","mode":"wide","href":"/api-reference/spaces/agents"},{"title":"Run all agents in a space","openapi":"POST /api/v1/spaces/{spaceId}/run-all","mode":"wide","href":"/api-reference/spaces/run-all"},{"title":"Search spaces","openapi":"GET /api/v1/spaces/search","mode":"wide","href":"/api-reference/spaces/search"}]}]}]},"basePath":"","title":"Authentication - Sequentum Developer Documentation","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":[],"chunks":[]}