Read and update the workspace limits and plan budgets for mode bring-your-own-keys. Amounts are US dollars.The call uses the workspace API key’s BILLING_API scope. Writes run as the key’s service account owner.
workspaceUsageLimit caps included and extra chat and agent usage in usagePeriod. Personal API usage counts toward that cap, and so do Agent API calls with a workspace key when the agent budget is always with a limited amount. Other workspace API usage, workflow runs, and usage of the workspace backbone model do not. usagePeriodSpend is the usage counted toward that cap.monthlyBudgetPerPlan is the included allowance for Standard (standard) and Power user (power_user). Weekly and session budgets are derived and you cannot write them. The weekly amount is the monthly amount divided by 4. The session amount is the weekly amount divided by 3. An unlimited monthly budget stays unlimited on those windows. sessionBudgetPerPlan is null when session limits are off.The monthly amount sets those windows. Extra usage can start when the included weekly or session allowance is used up. It is not a promise that extra usage waits for a calendar month to end.usageRequestsEnabled lets members ask an admin for more usage.agentLimitBehavior.forced chooses what happens after a member or agent limit is reached:
null leaves the choice to the agent owner (Agent owner decides).
switch_model switches to the fallback model (Switch model). This requires a valid fallback.
block_usage stops the agent (Block usage).
fallbackModelId is the configured fallback. null uses the workspace backbone model. Forcing switch_model still requires that resulting model to be valid.
Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.
API key as Bearer token. Format "Bearer YOUR_API_KEY"
Response
Successful response.
USD included and extra chat/agent usage; excludes workflow, API, and backbone-model usage. Weekly budgets are monthly / 4; session budgets are weekly / 3 and null when disabled. PATCH returns null spending; GET retrieves spending.
Forcing switch_model requires a valid fallback model. null forced uses each agent setting. fallbackModelId is the configured override; null uses the workspace backbone fallback.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Docs","colors":{"primary":"#4469FC","light":"#ECF0FF","dark":"#0D001D"},"logo":{"light":"https://mintcdn.com/langdock-34/URgvNwU7CYGZq8R7/logo/light.svg?fit=max\u0026auto=format\u0026n=URgvNwU7CYGZq8R7\u0026q=85\u0026s=594b4bd597e2629fb1a7dccfae6aa1c4","dark":"https://mintcdn.com/langdock-34/URgvNwU7CYGZq8R7/logo/dark.svg?fit=max\u0026auto=format\u0026n=URgvNwU7CYGZq8R7\u0026q=85\u0026s=d063d52fb4d331afb82adad972214673"},"favicon":"https://mintcdn.com/langdock-34/KbxhVmfYOcTup72x/favicon.png?fit=max\u0026auto=format\u0026n=KbxhVmfYOcTup72x\u0026q=85\u0026s=e12cd6cccfe5c94bf4ae6ea4fba7959c","background":{"color":{"dark":"#090014"}},"navbar":{"primary":{"type":"button","label":"Back to app","href":"https://app.langdock.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/langdock"}},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","mcp","cursor","vscode",{"title":"Ask Langdock","description":"Ask Langdock about the current page","icon":"/favicon.png","href":{"base":"https://app.langdock.com/chat","query":[{"key":"q","value":"Read from https://docs.langdock.com$path.md so I can ask questions about it."},{"key":"sendPrompt","value":"true"}]}}],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"newspaper","href":"https://www.langdock.com/changelog"},{"anchor":"Status","icon":"signal-bars","href":"https://status.langdock.com/"},{"anchor":"Support","icon":"messages-question","href":"https://www.langdock.com/contact-us"}]},"languages":[{"language":"en","default":true,"href":"en/using-langdock/get-started/introduction"},{"language":"de","href":"de/using-langdock/get-started/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"langdock-34","hasAudioNarration":false,"actualSubdomain":"langdock-34","customDomains":["docs.langdock.com"],"gitSource":{"type":"github","owner":"langdock","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae1fb3160416b77ca6b5628","collectionId":"2108c72e-8975-475f-87c4-e4d39ce09ed4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae1fb3160416b77ca6b5628"},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae1ff35661bff0c6e733eb8","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"en","tag":"Using Langdock","count":133},{"language":"de","tag":"Langdock nutzen","count":133},{"language":"en","tag":"Developer","count":106},{"language":"de","tag":"Entwickler","count":106},{"language":"en","tag":"Admin","count":100},{"language":"de","tag":"Admin","count":100},{"language":"en","tag":"Manage Integrations","count":43},{"language":"de","tag":"Integrationen verwalten","count":43},{"language":"en","tag":"Guides","count":40},{"language":"de","tag":"Anleitungen","count":40},{"language":"en","tag":"Workflows","count":28},{"language":"de","tag":"Workflows","count":28},{"language":"en","tag":"Integrations","count":19},{"language":"de","tag":"Integrationen","count":19},{"language":"en","tag":"Node Types","count":18},{"language":"de","tag":"Node Types","count":18},{"language":"en","tag":"Integration Setup Guides","count":17},{"language":"de","tag":"Integrations-Setup-Anleitungen","count":17},{"language":"en","tag":"Microsoft Integration Scopes","count":16},{"language":"de","tag":"Microsoft Integration Scopes","count":16}]},"assistantConfig":{"deflection":{"enabled":false}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/developer/billing-api/get-settings","slug":"/en/developer/billing-api/get-settings","pageMetadata":{"title":"Get Workspace Settings","description":"Read workspace usage limits, plan budgets, usage requests, and agent limit behavior","openapi":"GET /billing/v1/bring-your-own-keys/settings","keywords":["api","billing","settings","workspace limit","plan budget"],"href":"/en/developer/billing-api/get-settings"},"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: \"Read workspace usage limits, plan budgets, usage requests, and agent limit behavior\"\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={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Info,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Read and update the workspace limits and plan budgets for mode `,_jsx(_components.code,{children:`bring-your-own-keys`}),`. Amounts are US dollars.`]}),`\n`,_jsxs(_components.p,{children:[`The call uses the workspace API key’s `,_jsx(_components.code,{children:`BILLING_API`}),` scope. Writes run as the key’s service account owner.`]}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.langdock.com/billing/v1/bring-your-own-keys/settings`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Dedicated deployments`})}),_jsxs(_components.p,{children:[`Replace `,_jsx(_components.code,{children:`api.langdock.com`}),` with `,_jsx(_components.code,{children:`\u003cyour-deployment-url>/api/public`}),` in all requests.`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`API key`}),` with the `,_jsx(_components.code,{children:`BILLING_API`}),` scope`]}),`\n`,_jsx(_components.li,{children:`The key owner is a service account that has not been deleted and has an active Admin membership`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`read-settings`,children:`Read settings`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`GET /billing/v1/bring-your-own-keys/settings`}),` returns the current settings.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`27`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`27`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"USD\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"usageRequestsEnabled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"workspaceUsageLimit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"unlimited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"monthlyBudgetPerPlan\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"standard\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"limited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`36`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"power_user\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"limited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`120`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"weeklyBudgetPerPlan\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"standard\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"limited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`9`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"power_user\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"limited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`30`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sessionBudgetPerPlan\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"standard\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"limited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"power_user\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"limited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`10`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sessionLimitsEnabled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"agentLimitBehavior\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"forced\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"switch_model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"fallbackModelId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"44444444-4444-4444-8444-444444444444\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"usagePeriod\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"start\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-01T00:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"end\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-10-01T00:00:00.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"usagePeriodSpend\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1290.1`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`workspaceUsageLimit`}),` caps included and extra chat and agent usage in `,_jsx(_components.code,{children:`usagePeriod`}),`. Personal API usage counts toward that cap, and so do Agent API calls with a workspace key when the agent budget is `,_jsx(_components.code,{children:`always`}),` with a limited amount. Other workspace API usage, workflow runs, and usage of the workspace backbone model do not. `,_jsx(_components.code,{children:`usagePeriodSpend`}),` is the usage counted toward that cap.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`monthlyBudgetPerPlan`}),` is the included allowance for `,_jsx(_components.strong,{children:`Standard`}),` (`,_jsx(_components.code,{children:`standard`}),`) and `,_jsx(_components.strong,{children:`Power user`}),` (`,_jsx(_components.code,{children:`power_user`}),`). Weekly and session budgets are derived and you cannot write them. The weekly amount is the monthly amount divided by 4. The session amount is the weekly amount divided by 3. An unlimited monthly budget stays unlimited on those windows. `,_jsx(_components.code,{children:`sessionBudgetPerPlan`}),` is `,_jsx(_components.code,{children:`null`}),` when session limits are off.`]}),`\n`,_jsx(_components.p,{children:`The monthly amount sets those windows. Extra usage can start when the included weekly or session allowance is used up. It is not a promise that extra usage waits for a calendar month to end.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`usageRequestsEnabled`}),` lets members ask an admin for more usage.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`agentLimitBehavior.forced`}),` chooses what happens after a member or agent limit is reached:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`null`}),` leaves the choice to the agent owner (`,_jsx(_components.strong,{children:`Agent owner decides`}),`).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`switch_model`}),` switches to the fallback model (`,_jsx(_components.strong,{children:`Switch model`}),`). This requires a valid fallback.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`block_usage`}),` stops the agent (`,_jsx(_components.strong,{children:`Block usage`}),`).`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`fallbackModelId`}),` is the configured fallback. `,_jsx(_components.code,{children:`null`}),` uses the workspace backbone model. Forcing `,_jsx(_components.code,{children:`switch_model`}),` still requires that resulting model to be valid.`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on `,_jsx(_components.a,{href:`/en/admin/ai-adoption-and-rollout/best-practices/api-key-best-practices`,children:`API Key Best Practices`}),`.`]})})]})}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":"Get Workspace Settings","description":"Read workspace usage limits, plan budgets, usage requests, and agent limit behavior","openapi":"GET /billing/v1/bring-your-own-keys/settings","keywords":["api","billing","settings","workspace limit","plan budget"],"href":"/en/developer/billing-api/get-settings"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Read settings","slug":"read-settings","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Settings"],"operationId":"getByokBillingSettings","summary":"Read USD workspace settings","responses":{"200":"065124b4-5032-44db-bf4c-df80f12c1b10","400":"9bd5201f-1999-4e6e-bf01-a122268446f1","401":"d039081d-5004-4ed9-9263-1d5e082a89ac","403":"f18e6132-677d-40e9-9e44-71e56563f0c5","404":"d4b3ff5f-c70c-4703-9a55-12553292b833","405":"9675daf3-f64d-46fb-a5d5-85cc90c0d82f","409":"3c9b3247-e617-4f45-8c42-9b46042ef79a","429":"178155e3-8efa-470e-805c-288e076b3a45"},"method":"get","type":"path","servers":["1381f949-6199-4dbd-84cd-46b83b072e11"],"security":["88068dfa-de4c-437c-9267-927ebd6ad047"],"path":"/billing/v1/bring-your-own-keys/settings","baseUrlOptions":["https://api.langdock.com"],"title":"Read USD workspace settings","description":"Read workspace usage limits, plan budgets, usage requests, and agent limit behavior","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"065124b4-5032-44db-bf4c-df80f12c1b10":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["currency","usageRequestsEnabled","workspaceUsageLimit","monthlyBudgetPerPlan","sessionLimitsEnabled","agentLimitBehavior","weeklyBudgetPerPlan","sessionBudgetPerPlan","usagePeriod","usagePeriodSpend"],"properties":{"currency":{"type":"string","enum":["USD"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"usageRequestsEnabled":{"type":"boolean","isRequired":true,"uniqueKey":"usageRequestsEnabled","typeLabel":"boolean"},"workspaceUsageLimit":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["limited"],"isRequired":true,"uniqueKey":"workspaceUsageLimit.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"workspaceUsageLimit.oneOf.0.amount","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"workspaceUsageLimit.oneOf.0","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["unlimited"],"isRequired":true,"uniqueKey":"workspaceUsageLimit.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"workspaceUsageLimit.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"workspaceUsageLimit","typeLabel":"object"},"monthlyBudgetPerPlan":{"type":"object","additionalProperties":false,"required":["standard","power_user"],"properties":{"standard":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["limited"],"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.standard.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.standard.oneOf.0.amount","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.standard.oneOf.0","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["unlimited"],"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.standard.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.standard.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.standard","typeLabel":"object"},"power_user":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["limited"],"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.power_user.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.power_user.oneOf.0.amount","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.power_user.oneOf.0","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["unlimited"],"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.power_user.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.power_user.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan.power_user","typeLabel":"object"}},"isRequired":true,"uniqueKey":"monthlyBudgetPerPlan","typeLabel":"object"},"sessionLimitsEnabled":{"type":"boolean","isRequired":true,"uniqueKey":"sessionLimitsEnabled","typeLabel":"boolean"},"agentLimitBehavior":{"type":"object","additionalProperties":false,"required":["forced","fallbackModelId"],"properties":{"forced":{"oneOf":[{"type":"string","enum":["switch_model","block_usage",null],"isRequired":true,"uniqueKey":"agentLimitBehavior.forced.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["switch_model","block_usage",null],"isRequired":true,"uniqueKey":"agentLimitBehavior.forced.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agentLimitBehavior.forced","typeLabel":"enum\u003cstring> | null"},"fallbackModelId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"agentLimitBehavior.fallbackModelId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"agentLimitBehavior.fallbackModelId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agentLimitBehavior.fallbackModelId","typeLabel":"string\u003cuuid> | null"}},"description":"Forcing switch_model requires a valid fallback model. null forced uses each agent setting. fallbackModelId is the configured override; null uses the workspace backbone fallback.","isRequired":true,"uniqueKey":"agentLimitBehavior","typeLabel":"object"},"weeklyBudgetPerPlan":{"type":"object","additionalProperties":false,"required":["standard","power_user"],"properties":{"standard":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["limited"],"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.standard.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.standard.oneOf.0.amount","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.standard.oneOf.0","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["unlimited"],"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.standard.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.standard.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.standard","typeLabel":"object"},"power_user":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["limited"],"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.power_user.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.power_user.oneOf.0.amount","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.power_user.oneOf.0","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["unlimited"],"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.power_user.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.power_user.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan.power_user","typeLabel":"object"}},"isRequired":true,"uniqueKey":"weeklyBudgetPerPlan","typeLabel":"object"},"sessionBudgetPerPlan":{"oneOf":[{"type":"object","additionalProperties":false,"required":["standard","power_user"],"properties":{"standard":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["limited"],"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.standard.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.standard.oneOf.0.amount","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.standard.oneOf.0","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["unlimited"],"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.standard.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.standard.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.standard","typeLabel":"object"},"power_user":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["limited"],"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.power_user.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.power_user.oneOf.0.amount","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.power_user.oneOf.0","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["unlimited"],"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.power_user.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.power_user.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0.power_user","typeLabel":"object"}},"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["standard","power_user"],"properties":{"standard":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["limited"]},"amount":{"type":"number","minimum":0}},"additionalProperties":false},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["unlimited"]}},"additionalProperties":false}]},"power_user":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["limited"]},"amount":{"type":"number","minimum":0}},"additionalProperties":false},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["unlimited"]}},"additionalProperties":false}]}},"isRequired":true,"uniqueKey":"sessionBudgetPerPlan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sessionBudgetPerPlan","typeLabel":"object | null"},"usagePeriod":{"type":"object","additionalProperties":false,"required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"usagePeriod.start","typeLabel":"string\u003cdate-time>"},"end":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"usagePeriod.end","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"usagePeriod","typeLabel":"object"},"usagePeriodSpend":{"oneOf":[{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"usagePeriodSpend.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"isRequired":true,"uniqueKey":"usagePeriodSpend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"usagePeriodSpend","typeLabel":"number | null"}},"description":"USD included and extra chat/agent usage; excludes workflow, API, and backbone-model usage. Weekly budgets are monthly / 4; session budgets are weekly / 3 and null when disabled. PATCH returns null spending; GET retrieves spending.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"currency":"USD","usageRequestsEnabled":true,"workspaceUsageLimit":{"type":"limited","amount":1},"monthlyBudgetPerPlan":{"standard":{"type":"limited","amount":1},"power_user":{"type":"limited","amount":1}},"sessionLimitsEnabled":true,"agentLimitBehavior":{"forced":"switch_model","fallbackModelId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"weeklyBudgetPerPlan":{"standard":{"type":"limited","amount":1},"power_user":{"type":"limited","amount":1}},"sessionBudgetPerPlan":{"standard":{"type":"limited","amount":1},"power_user":{"type":"limited","amount":1}},"usagePeriod":{"start":"2023-11-07T05:31:56Z","end":"2023-11-07T05:31:56Z"},"usagePeriodSpend":1}}},"exampleType":"generated"}},"exampleType":"generated"},"9bd5201f-1999-4e6e-bf01-a122268446f1":{"description":"Invalid body/query, unknown fields, empty PATCH, invalid limit, invalid bulk member IDs, or a cursor outside this workspace (INVALID_CURSOR).","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional structured details specific to the error code, such as userIds for invalid bulk members.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"d039081d-5004-4ed9-9263-1d5e082a89ac":{"description":"Missing or invalid authentication.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional structured details specific to the error code, such as userIds for invalid bulk members.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"f18e6132-677d-40e9-9e44-71e56563f0c5":{"description":"Missing Billing scope, personal key, unavailable feature, missing active service-account Admin authority, or email filter without the USER_MANAGEMENT_API scope.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional structured details specific to the error code, such as userIds for invalid bulk members.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"d4b3ff5f-c70c-4703-9a55-12553292b833":{"description":"Resource not in this workspace, inactive/non-human user, privacy-hidden agent, usage request not found for that member, or endpoint unavailable in this mode.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional structured details specific to the error code, such as userIds for invalid bulk members.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"9675daf3-f64d-46fb-a5d5-85cc90c0d82f":{"description":"Unsupported HTTP method.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional structured details specific to the error code, such as userIds for invalid bulk members.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"3c9b3247-e617-4f45-8c42-9b46042ef79a":{"description":"Workspace mode differs from the requested mode. details.mode identifies the workspace mode.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message","code","details"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["BILLING_MODE_MISMATCH"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"details":{"type":"object","additionalProperties":false,"required":["mode"],"properties":{"mode":{"type":"string","enum":["ai-models-included","bring-your-own-keys"],"isRequired":true,"uniqueKey":"details.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"BILLING_MODE_MISMATCH","details":{"mode":"ai-models-included"}}}},"exampleType":"generated"}},"exampleType":"generated"},"178155e3-8efa-470e-805c-288e076b3a45":{"description":"API rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional structured details specific to the error code, such as userIds for invalid bulk members.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"88068dfa-de4c-437c-9267-927ebd6ad047":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"API key as Bearer token. Format \"Bearer YOUR_API_KEY\"","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"1381f949-6199-4dbd-84cd-46b83b072e11":{"url":"https://api.langdock.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"API key as Bearer token. Format \"Bearer YOUR_API_KEY\"","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key as Bearer token. Format \"Bearer YOUR_API_KEY\"","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"langdock-34","siteName":"Docs","title":"Get Workspace Settings - Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/developer/billing-api/get-settings","matchLevel":0},"de":{"href":"/de/developer/billing-api/get-settings","matchLevel":1}}},"lastModified":"2026-10-28T13:57:58.426Z","originalFileLocation":"en/developer/billing-api/get-settings.mdx","locale":"en"},"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=\"Read workspace usage limits, plan budgets, usage requests, and agent limit behavior\">\u003cmeta data-mint-head name=\"application-name\" content=\"Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/langdock-34/8EMNQyrrZlRONhj1/_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/langdock-34/8EMNQyrrZlRONhj1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/langdock-34/8EMNQyrrZlRONhj1/_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/langdock-34/8EMNQyrrZlRONhj1/_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/langdock-34/8EMNQyrrZlRONhj1/_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/langdock-34/8EMNQyrrZlRONhj1/_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/langdock-34/8EMNQyrrZlRONhj1/_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/langdock-34/8EMNQyrrZlRONhj1/_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/langdock-34/8EMNQyrrZlRONhj1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Workspace Settings - Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read workspace usage limits, plan budgets, usage requests, and agent limit behavior\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.langdock.com/en/developer/billing-api/get-settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://langdock-34.mintlify.app/_mintlify/api/og/v2?division=Billing+API\u0026amp;title=Get+Workspace+Settings\u0026amp;description=Read+workspace+usage+limits%2C+plan+budgets%2C+usage+requests%2C+and+agent+limit+behavior\u0026amp;theme=af251cb8027ba7e8fe3cc77e\u0026amp;signature=bde932f5fd6c931e0646520ffd61f803dc540f2196260bfe1fafccb2134121fd\">\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=\"Get Workspace Settings - Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read workspace usage limits, plan budgets, usage requests, and agent limit behavior\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://langdock-34.mintlify.app/_mintlify/api/og/v2?division=Billing+API\u0026amp;title=Get+Workspace+Settings\u0026amp;description=Read+workspace+usage+limits%2C+plan+budgets%2C+usage+requests%2C+and+agent+limit+behavior\u0026amp;theme=af251cb8027ba7e8fe3cc77e\u0026amp;signature=bde932f5fd6c931e0646520ffd61f803dc540f2196260bfe1fafccb2134121fd\">\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/langdock-34/8EMNQyrrZlRONhj1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4469FC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.langdock.com/en/developer/billing-api/get-settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/developer/billing-api/get-settings.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.langdock.com/en/developer/billing-api/get-settings\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.langdock.com/de/developer/billing-api/get-settings\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.langdock.com/en/developer/billing-api/get-settings\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.langdock.com/#organization\",\"name\":\"Docs\",\"url\":\"https://docs.langdock.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/langdock-34/URgvNwU7CYGZq8R7/logo/light.svg?fit=max\u0026auto=format\u0026n=URgvNwU7CYGZq8R7\u0026q=85\u0026s=594b4bd597e2629fb1a7dccfae6aa1c4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.langdock.com#website\",\"name\":\"Docs\",\"url\":\"https://docs.langdock.com\",\"publisher\":{\"@id\":\"https://docs.langdock.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.langdock.com/en/developer/billing-api/get-settings#webpage\",\"url\":\"https://docs.langdock.com/en/developer/billing-api/get-settings\",\"name\":\"Get Workspace Settings\",\"description\":\"Read workspace usage limits, plan budgets, usage requests, and agent limit behavior\",\"dateModified\":\"2026-10-28T13:57:58.426Z\",\"isPartOf\":{\"@id\":\"https://docs.langdock.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.langdock.com/en/developer/billing-api/get-settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.langdock.com/en/developer/billing-api/get-settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Billing API\",\"item\":\"https://docs.langdock.com/en/developer/billing-api/billing-api-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Workspace Settings\",\"item\":\"https://docs.langdock.com/en/developer/billing-api/get-settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.langdock.com/en/developer/billing-api/get-settings#apireference\",\"headline\":\"Get Workspace Settings\",\"name\":\"Get Workspace Settings\",\"description\":\"Read workspace usage limits, plan budgets, usage requests, and agent limit behavior\",\"url\":\"https://docs.langdock.com/en/developer/billing-api/get-settings\",\"mainEntityOfPage\":{\"@id\":\"https://docs.langdock.com/en/developer/billing-api/get-settings#webpage\"},\"dateModified\":\"2026-10-28T13:57:58.426Z\",\"keywords\":\"api, billing, settings, workspace limit, plan budget\",\"publisher\":{\"@id\":\"https://docs.langdock.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.langdock.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Docs","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"newspaper","href":"https://www.langdock.com/changelog"},{"anchor":"Status","icon":"signal-bars","href":"https://status.langdock.com/"},{"anchor":"Support","icon":"messages-question","href":"https://www.langdock.com/contact-us"}]},"languages":[{"language":"en","default":true,"tabs":[{"tab":"Using Langdock","pages":[{"title":"Using Langdock","href":"/en/using-langdock/get-started/introduction"}]},{"tab":"Developer","groups":[{"group":"Overview","pages":[{"title":"API Introduction","href":"/en/developer/overview/api-introduction"},{"title":"Cookbook","href":"/en/developer/overview/cookbook"}]},{"group":"Completion API","pages":[{"title":"Completion API Overview","href":"/en/developer/completion-api/completion-overview"},{"title":"OpenAI Chat completion","openapi":"POST /openai/{region}/v1/chat/completions","href":"/en/developer/completion-api/openai"},{"title":"OpenAI Responses API","openapi":"POST /openai/{region}/v1/responses","href":"/en/developer/completion-api/openai-responses"},{"title":"OpenAI Image Generations","openapi":"POST /openai/{region}/v1/images/generations","href":"/en/developer/completion-api/openai-images"},{"title":"Anthropic Messages","openapi":"POST /anthropic/{region}/v1/messages","href":"/en/developer/completion-api/anthropic"},{"title":"Google Completion API","openapi":"POST /google/{region}/v1beta/models/{model}:generateContent","href":"/en/developer/completion-api/google"},{"title":"Codestral","openapi":"POST /mistral/{region}/v1/fim/completions","href":"/en/developer/completion-api/mistral"}]},{"group":"Embedding API","pages":[{"title":"OpenAI Embeddings","openapi":"POST /openai/{region}/v1/embeddings","href":"/en/developer/embedding-api/openai-embedding"}]},{"group":"Agents API","pages":[{"title":"Agents API Overview","href":"/en/developer/agents-api/agents-overview"},{"title":"Sharing Agents with API Keys","href":"/en/developer/agents-api/agent-api-guide"},{"title":"Agents Completions API","openapi":"POST /agent/v1/chat/completions","href":"/en/developer/agents-api/agent"},{"title":"Agent Get API","openapi":"GET /agent/v1/get","href":"/en/developer/agents-api/agent-get"},{"title":"Agent Create API","openapi":"POST /agent/v1/create","href":"/en/developer/agents-api/agent-create"},{"title":"Agent Update API","openapi":"PATCH /agent/v1/update","href":"/en/developer/agents-api/agent-update"},{"title":"Agent Publish API","openapi":"POST /agent/v1/publish","href":"/en/developer/agents-api/agent-publish"},{"title":"Agent Disable API","openapi":"PATCH /agent/v1/disable","href":"/en/developer/agents-api/agent-disable"},{"title":"Models for Agent API","openapi":"GET /agent/v1/models","href":"/en/developer/agents-api/agent-models"},{"title":"Upload Attachment API","openapi":"POST /attachment/v1/upload","href":"/en/developer/agents-api/upload-attachments"},{"title":"Delete Attachment API","openapi":"DELETE /attachment/v1/delete","href":"/en/developer/agents-api/delete-attachments"},{"title":"Agent Migration Guide","href":"/en/developer/agents-api/agent-migration"},{"title":"Migrating from Assistants API to Agents API","href":"/en/developer/agents-api/assistant-to-agent-migration"}]},{"group":"Integrations API","pages":[{"title":"Integrations API Overview","href":"/en/developer/integrations-api/integrations-overview"},{"title":"List Integrations","openapi":"GET /integrations/v1/get","href":"/en/developer/integrations-api/list-integrations"},{"title":"Create Integration","openapi":"POST /integrations/v1/create","href":"/en/developer/integrations-api/create-integration"},{"title":"Get Integration","openapi":"GET /integrations/v1/{integrationId}","href":"/en/developer/integrations-api/get-integration"},{"title":"Update Integration","openapi":"PATCH /integrations/v1/{integrationId}","href":"/en/developer/integrations-api/update-integration"},{"title":"Get Integration Icon","openapi":"GET /integrations/v1/{integrationId}/icon","href":"/en/developer/integrations-api/get-icon"},{"title":"Replace Integration Icon","openapi":"PUT /integrations/v1/{integrationId}/icon","href":"/en/developer/integrations-api/replace-icon"},{"title":"Update Auth Configuration","openapi":"PATCH /integrations/v1/{integrationId}/auth","href":"/en/developer/integrations-api/update-auth"},{"title":"Create Action","openapi":"POST /integrations/v1/{integrationId}/actions/create","href":"/en/developer/integrations-api/create-action"},{"title":"Update Action","openapi":"PUT /integrations/v1/{integrationId}/actions/{actionId}","href":"/en/developer/integrations-api/update-action"},{"title":"Delete Action","openapi":"DELETE /integrations/v1/{integrationId}/actions/{actionId}","href":"/en/developer/integrations-api/delete-action"},{"title":"Create Trigger","openapi":"POST /integrations/v1/{integrationId}/triggers/create","href":"/en/developer/integrations-api/create-trigger"},{"title":"Update Trigger","openapi":"PUT /integrations/v1/{integrationId}/triggers/{triggerId}","href":"/en/developer/integrations-api/update-trigger"},{"title":"Delete Trigger","openapi":"DELETE /integrations/v1/{integrationId}/triggers/{triggerId}","href":"/en/developer/integrations-api/delete-trigger"}]},{"group":"Skills API","pages":[{"title":"Skills API Overview","href":"/api-endpoints/skills/skills-overview"},{"title":"List Skills","openapi":"GET /skills/v1","href":"/api-endpoints/skills/list-skills"},{"title":"Create Skill","openapi":"POST /skills/v1","href":"/api-endpoints/skills/create-skill"},{"title":"Get Skill","openapi":"GET /skills/v1/{skillId}","href":"/api-endpoints/skills/get-skill"},{"title":"Get Skill File","openapi":"GET /skills/v1/{skillId}/files","href":"/api-endpoints/skills/get-skill-file"},{"title":"Update Skill","openapi":"PATCH /skills/v1/{skillId}","href":"/api-endpoints/skills/update-skill"},{"title":"Delete Skill","openapi":"DELETE /skills/v1/{skillId}","href":"/api-endpoints/skills/delete-skill"},{"title":"Import Skill","openapi":"POST /skills/v1/import","href":"/api-endpoints/skills/import-skill"}]},{"group":"Knowledge Folder API","pages":[{"title":"Knowledge Folder API Overview","href":"/en/developer/knowledge-folder-api/knowledge-folder-overview"},{"title":"Share Knowledge bases with the API","href":"/en/developer/knowledge-folder-api/sharing"},{"title":"Share Knowledge base access","openapi":"post /knowledge/{folderId}/access","href":"/en/developer/knowledge-folder-api/share-access"},{"title":"List Knowledge bases","openapi":"get /knowledge","href":"/en/developer/knowledge-folder-api/list-knowledge-folders"},{"title":"Upload File to Knowledge Folder","openapi":"post /knowledge/{folderId}","href":"/en/developer/knowledge-folder-api/upload-file"},{"title":"Update Attachment in Knowledge Folder","openapi":"patch /knowledge/{folderId}","href":"/en/developer/knowledge-folder-api/update-attachment"},{"title":"Update Knowledge base","openapi":"patch /knowledge/{folderId}/folder","href":"/en/developer/knowledge-folder-api/update-folder"},{"title":"Retrieve Files from Knowledge Folder","openapi":"get /knowledge/{folderId}/list","href":"/en/developer/knowledge-folder-api/retrieve-files"},{"title":"Delete Attachment from Knowledge Folder","openapi":"delete /knowledge/{folderId}/{attachmentId}","href":"/en/developer/knowledge-folder-api/delete-attachment"},{"title":"Search Knowledge bases","openapi":"post /knowledge/search","href":"/en/developer/knowledge-folder-api/search-knowledge-folder"}]},{"group":"Prompt Library API","pages":[{"title":"Prompt Library API Overview","href":"/en/developer/prompts-api/prompts-overview"},{"title":"List Prompts","openapi":"GET /prompts/v1","href":"/en/developer/prompts-api/list-prompts"},{"title":"Create Prompt","openapi":"POST /prompts/v1","href":"/en/developer/prompts-api/create-prompt"},{"title":"Get Prompt","openapi":"GET /prompts/v1/{promptId}","href":"/en/developer/prompts-api/get-prompt"},{"title":"Update Prompt","openapi":"PATCH /prompts/v1/{promptId}","href":"/en/developer/prompts-api/update-prompt"},{"title":"Delete Prompt","openapi":"DELETE /prompts/v1/{promptId}","href":"/en/developer/prompts-api/delete-prompt"},{"title":"List Prompt Folders","openapi":"GET /prompts/v1/folders","href":"/en/developer/prompts-api/list-folders"},{"title":"Create Prompt Folder","openapi":"POST /prompts/v1/folders","href":"/en/developer/prompts-api/create-folder"},{"title":"Get Prompt Folder","openapi":"GET /prompts/v1/folders/{folderId}","href":"/en/developer/prompts-api/get-folder"},{"title":"Update Prompt Folder","openapi":"PATCH /prompts/v1/folders/{folderId}","href":"/en/developer/prompts-api/update-folder"},{"title":"Delete Prompt Folder","openapi":"DELETE /prompts/v1/folders/{folderId}","href":"/en/developer/prompts-api/delete-folder"}]},{"group":"Usage Export API","pages":[{"title":"Usage Export API Overview","href":"/en/developer/usage-export-api/intro-to-usage-export-api"},{"title":"Export User Usage","openapi":"POST /export/users","href":"/en/developer/usage-export-api/export-users"},{"title":"Export Agent Usage","openapi":"POST /export/agents","href":"/en/developer/usage-export-api/export-agents"},{"title":"Export API Key Usage","openapi":"POST /export/api-keys","href":"/en/developer/usage-export-api/export-api-keys"},{"title":"Export Project Usage","openapi":"POST /export/projects","href":"/en/developer/usage-export-api/export-projects"},{"title":"Export Model Usage","openapi":"POST /export/models","href":"/en/developer/usage-export-api/export-models"},{"title":"Export Workflow Usage","openapi":"POST /export/workflows","href":"/en/developer/usage-export-api/export-workflows"}]},{"group":"Workflow API","pages":[{"title":"Workflow API Overview","href":"/en/developer/workflow-api/workflows-overview"},{"title":"List Workflows","openapi":"GET /workflows/v1/list","href":"/en/developer/workflow-api/list-workflows"},{"title":"Create Workflow","openapi":"POST /workflows/v1/create","href":"/en/developer/workflow-api/create-workflow"},{"title":"Get Workflow","openapi":"GET /workflows/v1/get","href":"/en/developer/workflow-api/get-workflow"},{"title":"Update Workflow","openapi":"PATCH /workflows/v1/update","href":"/en/developer/workflow-api/update-workflow"},{"title":"Publish Workflow","openapi":"POST /workflows/v1/publish","href":"/en/developer/workflow-api/publish-workflow"},{"title":"Delete Workflow","openapi":"DELETE /workflows/v1/delete","href":"/en/developer/workflow-api/delete-workflow"},{"title":"List Workflow Runs","openapi":"GET /workflows/v1/runs","href":"/en/developer/workflow-api/list-workflow-runs"},{"title":"Workflow Run Export API","openapi":"GET /workflows/{workflowId}/runs","href":"/en/developer/workflow-api/intro-to-workflow-api"}]},{"group":"Scheduled Tasks API","pages":[{"title":"Scheduled Tasks API Overview","href":"/en/developer/scheduled-tasks-api/scheduled-tasks-overview"},{"title":"List Scheduled Tasks","openapi":"GET /automations/v1","href":"/en/developer/scheduled-tasks-api/list-scheduled-tasks"},{"title":"Create Scheduled Task","openapi":"POST /automations/v1","href":"/en/developer/scheduled-tasks-api/create-scheduled-task"},{"title":"Get Scheduled Task","openapi":"GET /automations/v1/{automationId}","href":"/en/developer/scheduled-tasks-api/get-scheduled-task"},{"title":"Update Scheduled Task","openapi":"PATCH /automations/v1/{automationId}","href":"/en/developer/scheduled-tasks-api/update-scheduled-task"},{"title":"Delete Scheduled Task","openapi":"DELETE /automations/v1/{automationId}","href":"/en/developer/scheduled-tasks-api/delete-scheduled-task"},{"title":"Pause Scheduled Task","openapi":"POST /automations/v1/{automationId}/pause","href":"/en/developer/scheduled-tasks-api/pause-scheduled-task"},{"title":"Resume Scheduled Task","openapi":"POST /automations/v1/{automationId}/resume","href":"/en/developer/scheduled-tasks-api/resume-scheduled-task"},{"title":"Run Scheduled Task","openapi":"POST /automations/v1/{automationId}/run","href":"/en/developer/scheduled-tasks-api/run-scheduled-task"}]},{"group":"User Management API","pages":[{"title":"User Management API Overview","href":"/en/developer/user-management-api/user-management-overview"},{"title":"Invite Users","openapi":"POST /user-management/v1/invite","href":"/en/developer/user-management-api/invite"},{"title":"Update User Role","openapi":"POST /user-management/v1/update-user-role","href":"/en/developer/user-management-api/update-user-role"},{"title":"List Roles","openapi":"GET /user-management/v1/roles","href":"/en/developer/user-management-api/roles"},{"title":"Deactivate User","openapi":"POST /user-management/v1/deactivate-user","href":"/en/developer/user-management-api/deactivate-user"}]},{"group":"Billing API","pages":[{"title":"Billing API Overview","href":"/en/developer/billing-api/billing-api-overview"},{"title":"Get Billing Mode","description":"Read the workspace billing mode and currency before you call other Billing API routes","openapi":"GET /billing/v1/mode","href":"/en/developer/billing-api/get-mode"},{"title":"Get Workspace Settings","openapi":"GET /billing/v1/bring-your-own-keys/settings","href":"/en/developer/billing-api/get-settings"},{"title":"Update Workspace Settings","description":"Change the workspace usage limit, plan budgets, usage requests, and agent limit behavior","openapi":"PATCH /billing/v1/bring-your-own-keys/settings","href":"/en/developer/billing-api/update-settings"},{"title":"Count Plan Members","openapi":"GET /billing/v1/bring-your-own-keys/plans","href":"/en/developer/billing-api/get-plans"},{"title":"List Users","openapi":"GET /billing/v1/bring-your-own-keys/users","href":"/en/developer/billing-api/list-users"},{"title":"Get User","openapi":"GET /billing/v1/bring-your-own-keys/users/{userId}","href":"/en/developer/billing-api/get-user"},{"title":"Set User Plan","openapi":"PUT /billing/v1/bring-your-own-keys/users/{userId}/plan","href":"/en/developer/billing-api/set-user-plan"},{"title":"Set User Extra Usage Budget","openapi":"PUT /billing/v1/bring-your-own-keys/users/{userId}/extra-usage-budget","href":"/en/developer/billing-api/set-user-extra-usage-budget"},{"title":"Bulk Set User Plans","openapi":"POST /billing/v1/bring-your-own-keys/users/plan/bulk","href":"/en/developer/billing-api/bulk-set-user-plans"},{"title":"List Usage Requests","openapi":"GET /billing/v1/bring-your-own-keys/usage-requests","href":"/en/developer/billing-api/list-usage-requests"},{"title":"Get Usage Request","openapi":"GET /billing/v1/bring-your-own-keys/usage-requests/{requestId}","href":"/en/developer/billing-api/get-usage-request"},{"title":"Decline Usage Request","openapi":"POST /billing/v1/bring-your-own-keys/usage-requests/{requestId}/dismiss","href":"/en/developer/billing-api/dismiss-usage-request"},{"title":"List Groups","openapi":"GET /billing/v1/bring-your-own-keys/groups","href":"/en/developer/billing-api/list-groups"},{"title":"Get Group","openapi":"GET /billing/v1/bring-your-own-keys/groups/{groupId}","href":"/en/developer/billing-api/get-group"},{"title":"Set Group Monthly Budget","openapi":"PUT /billing/v1/bring-your-own-keys/groups/{groupId}/monthly-budget","href":"/en/developer/billing-api/set-group-monthly-budget"},{"title":"List Agent Budgets","openapi":"GET /billing/v1/bring-your-own-keys/agents","href":"/en/developer/billing-api/list-agents"},{"title":"Get Agent Budget","openapi":"GET /billing/v1/bring-your-own-keys/agents/{agentId}","href":"/en/developer/billing-api/get-agent"},{"title":"Update Agent Budget","openapi":"PATCH /billing/v1/bring-your-own-keys/agents/{agentId}","href":"/en/developer/billing-api/update-agent-budget"}]},{"group":"Audit Logs API","pages":[{"title":"Audit Logs API Overview","href":"/en/developer/audit-logs-api/intro-to-audit-logs-api"},{"title":"List Audit Logs","openapi":"GET /audit-logs/{workspace_id}","href":"/en/developer/audit-logs-api/list-audit-logs"}]},{"group":"Compliance API","pages":[{"title":"Export tool parameters and outputs","href":"/en/developer/compliance-api/export-tool-results"}]}]},{"tab":"Admin","pages":[{"title":"Admin","href":"/en/admin/workspace/workspace"}]}]},{"language":"de","pages":[{"title":"de","href":"/de/developer/billing-api/get-settings"}]}]},"title":"Get Workspace Settings - Docs","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}