API key requests are subject to plan-based rate limits. If you exceed your limit, the API returns 429 Too Many Requests.Check your current usage and limits:
On 429, wait for reset_in_seconds before retrying. The SDK handles this automatically with exponential backoff.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"FlexOrch","colors":{"primary":"#ecab1c","light":"#f7e8bf","dark":"#c49010"},"favicon":"https://mintcdn.com/flexorch/jnaEqEWpDTFdyoTH/images/favicon.svg?fit=max\u0026auto=format\u0026n=jnaEqEWpDTFdyoTH\u0026q=85\u0026s=cda0a2aee607bbc3358e58047e39061a","logo":{"light":"https://mintcdn.com/flexorch/jnaEqEWpDTFdyoTH/images/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=jnaEqEWpDTFdyoTH\u0026q=85\u0026s=76b4dd6778570765cf21857ac62b4b71","dark":"https://mintcdn.com/flexorch/jnaEqEWpDTFdyoTH/images/logo/wordmark-dark.svg?fit=max\u0026auto=format\u0026n=jnaEqEWpDTFdyoTH\u0026q=85\u0026s=8b83e148538543875853113e4a04cfba","href":"https://flexorch.com"},"api":{"openapi":"https://api.flexorch.com/openapi.json"},"background":{"decoration":null,"color":{"light":null,"dark":"#18202d"}},"navbar":{"links":[{"label":"Platform","href":"https://app.flexorch.com"},{"label":"GitHub","href":"https://github.com/flexorch"}],"primary":{"type":"button","label":"Get Started Free","href":"https://app.flexorch.com/signup"}},"footer":{"socials":{"github":"https://github.com/flexorch","youtube":"https://www.youtube.com/@FlexOrch"}},"fonts":{"heading":{"family":"Lora"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"PyPI","href":"https://pypi.org/project/flexorch-audit","icon":"python"},{"anchor":"npm","href":"https://www.npmjs.com/package/@flexorch/audit","icon":"npm"},{"anchor":"GitHub","href":"https://github.com/flexorch","icon":"github"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flexorch","hasAudioNarration":false,"actualSubdomain":"flexorch","customDomains":["docs.flexorch.com"],"gitSource":{"type":"github","owner":"flexorch","repo":"flexorch-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a8bf0a47cfae28be11a78b8","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Documentation","count":57},{"language":"default","tag":"Guides","count":10},{"language":"default","tag":"Open Source (flexorch-audit)","count":9},{"language":"default","tag":"Python SDK","count":6},{"language":"default","tag":"TypeScript SDK","count":6},{"language":"default","tag":"Compliance","count":5},{"language":"default","tag":"Connectors","count":4},{"language":"default","tag":"Scheduler","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"MCP Server","count":3}]},"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"authentication/api-keys","slug":"/authentication/api-keys","pageMetadata":{"title":"API Keys","description":"Generate, use, and rotate your FlexOrch API keys.","href":"/authentication/api-keys"},"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: \"Generate, use, and rotate your FlexOrch API keys.\"\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`,hr:`hr`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`FlexOrch uses API keys for authentication. Every request must include a valid key.`}),`\n`,_jsx(_components.p,{children:`API keys follow the format:`}),`\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:`dfx_\u003crandom_string>`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`Keys are tied to your account. All requests made with a key are scoped to your workspace.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`generating-a-key`,children:`Generating a key`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Sign in to `,_jsx(_components.a,{href:`https://app.flexorch.com`,children:`app.flexorch.com`})]}),`\n`,_jsxs(_components.li,{children:[`Go to `,_jsx(_components.strong,{children:`Settings → API Keys`})]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Generate New Key`})]}),`\n`,_jsx(_components.li,{children:`Copy the key immediately — it is shown only once`}),`\n`]}),`\n`,_jsx(_components.p,{children:`You can generate multiple keys (e.g., one per environment or integration).`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`using-a-key`,children:`Using a key`}),`\n`,_jsxs(_components.p,{children:[`Pass the key in the `,_jsx(_components.code,{children:`X-API-KEY`}),` header:`]}),`\n`,_jsx(CodeBlock,{filename:``,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://api.flexorch.com/v1/usage`}),_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:` \"X-API-KEY: dfx_your_key_here\"`})]}),`\n`]})})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Never expose API keys in client-side code, public repositories, or logs.`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`revoking-a-key`,children:`Revoking a key`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Go to `,_jsx(_components.strong,{children:`Settings → API Keys`})]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Revoke`}),` next to the key you want to remove`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Revoked keys stop working immediately.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`security-best-practices`,children:`Security best practices`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Store keys in environment variables, never in source code`}),`\n`,_jsx(_components.li,{children:`Use separate keys per environment (development, staging, production)`}),`\n`,_jsx(_components.li,{children:`Rotate keys periodically — revoke old ones after issuing new ones`}),`\n`,_jsxs(_components.li,{children:[`Set up a `,_jsx(_components.code,{children:`.env`}),` file and add it to `,_jsx(_components.code,{children:`.gitignore`})]}),`\n`]}),`\n`,_jsx(CodeBlock,{filename:``,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:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# .env`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`FLEXORCH_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`dfx_your_key_here`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,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:`4`,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:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` flexorch_sdk `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` FlexOrch`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` FlexOrch(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`api_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:`\"FLEXORCH_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`]})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`rate-limits`,children:`Rate limits`}),`\n`,_jsxs(_components.p,{children:[`API key requests are subject to plan-based rate limits. If you exceed your limit, the API returns `,_jsx(_components.code,{children:`429 Too Many Requests`}),`.`]}),`\n`,_jsx(_components.p,{children:`Check your current usage and limits:`}),`\n`,_jsx(CodeBlock,{filename:``,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://api.flexorch.com/v1/usage/rate-limits`}),_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:` \"X-API-KEY: dfx_your_key_here\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`11`,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:`11`,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:` \"data\"`}),_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:` \"plan\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"starter\"`}),_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:` \"rate_limit\"`}),_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:` \"rpm\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`60`}),_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:` \"used\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`12`}),_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:` \"remaining\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`48`}),_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:` \"reset_in_seconds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`34`})]}),`\n`,_jsx(_components.span,{className:`line`,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(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`On `,_jsx(_components.code,{children:`429`}),`, wait for `,_jsx(_components.code,{children:`reset_in_seconds`}),` before retrying. The SDK handles this automatically with exponential backoff.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API Keys","description":"Generate, use, and rotate your FlexOrch API keys.","href":"/authentication/api-keys"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"Generating a key","slug":"generating-a-key","depth":2,"children":[]},{"title":"Using a key","slug":"using-a-key","depth":2,"children":[]},{"title":"Revoking a key","slug":"revoking-a-key","depth":2,"children":[]},{"title":"Security best practices","slug":"security-best-practices","depth":2,"children":[]},{"title":"Rate limits","slug":"rate-limits","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"flexorch","siteName":"FlexOrch","title":"API Keys - FlexOrch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-23T11:28:25.662Z","originalFileLocation":"authentication/api-keys.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=\"Generate, use, and rotate your FlexOrch API keys.\">\u003cmeta data-mint-head name=\"application-name\" content=\"FlexOrch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexorch/zLD2elDLDrUSLOkL/_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/flexorch/zLD2elDLDrUSLOkL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexorch/zLD2elDLDrUSLOkL/_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/flexorch/zLD2elDLDrUSLOkL/_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/flexorch/zLD2elDLDrUSLOkL/_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/flexorch/zLD2elDLDrUSLOkL/_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/flexorch/zLD2elDLDrUSLOkL/_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/flexorch/zLD2elDLDrUSLOkL/_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/flexorch/zLD2elDLDrUSLOkL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Keys - FlexOrch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate, use, and rotate your FlexOrch API keys.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FlexOrch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flexorch.com/authentication/api-keys\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flexorch.mintlify.site/_mintlify/api/og/v2?division=Authentication\u0026amp;title=API+Keys\u0026amp;description=Generate%2C+use%2C+and+rotate+your+FlexOrch+API+keys.\u0026amp;theme=ce7a06b8c8469b0aded2d3eb\u0026amp;signature=c23d0f0bad8cf6d8d3e0d88f7f97ecff76d8162d9762d87edf63d2378443cfb5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API Keys - FlexOrch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate, use, and rotate your FlexOrch API keys.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flexorch.mintlify.site/_mintlify/api/og/v2?division=Authentication\u0026amp;title=API+Keys\u0026amp;description=Generate%2C+use%2C+and+rotate+your+FlexOrch+API+keys.\u0026amp;theme=ce7a06b8c8469b0aded2d3eb\u0026amp;signature=c23d0f0bad8cf6d8d3e0d88f7f97ecff76d8162d9762d87edf63d2378443cfb5\">\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/flexorch/zLD2elDLDrUSLOkL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FlexOrch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ecab1c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flexorch.com/authentication/api-keys\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/authentication/api-keys.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.flexorch.com/#organization\",\"name\":\"FlexOrch\",\"url\":\"https://docs.flexorch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flexorch/jnaEqEWpDTFdyoTH/images/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=jnaEqEWpDTFdyoTH\u0026q=85\u0026s=76b4dd6778570765cf21857ac62b4b71\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flexorch.com#website\",\"name\":\"FlexOrch\",\"url\":\"https://docs.flexorch.com\",\"publisher\":{\"@id\":\"https://docs.flexorch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flexorch.com/authentication/api-keys#webpage\",\"url\":\"https://docs.flexorch.com/authentication/api-keys\",\"name\":\"API Keys\",\"description\":\"Generate, use, and rotate your FlexOrch API keys.\",\"dateModified\":\"2026-06-23T11:28:25.662Z\",\"isPartOf\":{\"@id\":\"https://docs.flexorch.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flexorch.com/authentication/api-keys#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flexorch.com/authentication/api-keys#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"FlexOrch\",\"item\":\"https://docs.flexorch.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Keys\",\"item\":\"https://docs.flexorch.com/authentication/api-keys\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.flexorch.com/authentication/api-keys#article\",\"headline\":\"API Keys\",\"name\":\"API Keys\",\"description\":\"Generate, use, and rotate your FlexOrch API keys.\",\"url\":\"https://docs.flexorch.com/authentication/api-keys\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flexorch.com/authentication/api-keys#webpage\"},\"dateModified\":\"2026-06-23T11:28:25.662Z\",\"publisher\":{\"@id\":\"https://docs.flexorch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flexorch.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FlexOrch\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"FlexOrch","nav":{"global":{"anchors":[{"anchor":"PyPI","href":"https://pypi.org/project/flexorch-audit","icon":"python"},{"anchor":"npm","href":"https://www.npmjs.com/package/@flexorch/audit","icon":"npm"},{"anchor":"GitHub","href":"https://github.com/flexorch","icon":"github"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Core Concepts","href":"/concepts"},{"title":"Quickstart","description":"Process your first document and export a dataset in under 5 minutes.","href":"/quickstart"}]},{"group":"Authentication","pages":[{"title":"API Keys","href":"/authentication/api-keys"},{"title":"JWT Authentication","description":"Authenticate using email and password with JWT tokens.","href":"/authentication/jwt"}]},{"group":"Guides","pages":[{"title":"Uploading Documents","href":"/guides/upload"},{"title":"Pipeline","href":"/guides/pipeline"},{"title":"Datasets \u0026 Export","href":"/guides/datasets"},{"title":"PII Detection \u0026 Privacy","href":"/guides/pii-privacy"},{"title":"Quality Scores","href":"/guides/quality-scores"},{"title":"Webhooks","href":"/guides/webhooks"},{"title":"RAG Pipeline","href":"/guides/rag-pipeline"},{"title":"LangChain Integration","href":"/guides/langchain"},{"title":"LlamaIndex Integration","href":"/guides/llamaindex"},{"title":"Chunk Quality","href":"/guides/chunk-quality"}]},{"group":"Python SDK","pages":[{"title":"Installation","href":"/sdk/python/installation"},{"title":"Quickstart","href":"/sdk/python/quickstart"},{"title":"Upload","href":"/sdk/python/upload"},{"title":"Jobs","href":"/sdk/python/jobs"},{"title":"Datasets","href":"/sdk/python/datasets"},{"title":"SDK Reference","href":"/sdk/python/reference"}]},{"group":"TypeScript SDK","pages":[{"title":"Installation","href":"/sdk/typescript/installation"},{"title":"Quickstart","href":"/sdk/typescript/quickstart"},{"title":"Upload","href":"/sdk/typescript/upload"},{"title":"Jobs","href":"/sdk/typescript/jobs"},{"title":"Datasets","href":"/sdk/typescript/datasets"},{"title":"SDK Reference","href":"/sdk/typescript/reference"}]},{"group":"Open Source (flexorch-audit)","pages":[{"title":"flexorch-audit","href":"/open-source/overview"},{"title":"Installation","href":"/open-source/installation"},{"title":"PII Detection","href":"/open-source/pii-detection"},{"title":"Masking","href":"/open-source/masking"},{"title":"Quality Metrics","href":"/open-source/quality"},{"title":"Compliance Report","href":"/open-source/compliance-report"},{"title":"redact_for_llm","href":"/open-source/redact-for-llm"},{"title":"LangChain Integration (OSS)","href":"/open-source/langchain"},{"title":"LlamaIndex Integration (OSS)","href":"/open-source/llamaindex"}]},{"group":"Connectors","pages":[{"title":"Connectors","href":"/connectors/overview"},{"title":"Amazon S3","href":"/connectors/amazon-s3"},{"title":"Google Cloud Storage","href":"/connectors/google-cloud-storage"},{"title":"Azure Blob Storage","href":"/connectors/azure-blob"}]},{"group":"Scheduler","pages":[{"title":"Scheduled Sync","href":"/scheduler/overview"},{"title":"Create a Schedule","href":"/scheduler/create-schedule"},{"title":"Sync Logs","href":"/scheduler/sync-logs"},{"title":"Plan Limits","href":"/scheduler/plan-limits"}]},{"group":"Team","pages":[{"title":"Team Management","href":"/team/overview"},{"title":"Invite Members","href":"/team/invite-members"},{"title":"Roles \u0026 Permissions","href":"/team/roles"}]},{"group":"Compliance","pages":[{"title":"Compliance Overview","href":"/compliance/overview"},{"title":"GDPR Article 30 (ROPA)","href":"/compliance/gdpr-article-30"},{"title":"KVKK Compliance","href":"/compliance/kvkk"},{"title":"NIS2 Audit Export","href":"/compliance/nis2-audit-export"},{"title":"eIDAS — Electronic Signatures","href":"/compliance/eidas"}]},{"group":"MCP Server","pages":[{"title":"MCP Server Overview","href":"/mcp/overview"},{"title":"Quickstart","href":"/mcp/quickstart"},{"title":"Tool Reference","href":"/mcp/tools"}]},{"group":"Advanced","pages":[{"title":"BYO LLM","href":"/advanced/byo-llm"},{"title":"Fine-Tuning","href":"/advanced/fine-tuning"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"API Keys - FlexOrch","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":[],"chunks":[]}