{
"error": "this API key lacks the runs:write scope"
}
{
"error": "this API key lacks the runs:write scope"
}
{
"error": "this API key lacks the runs:write scope"
}
Defaults to the key’s own wallet (for account-bound keys, your account wallet). Pass workspace_id to read the balance of any workspace you can manage: ids come from List workspaces.
A workspace API key. Secret keys (flowy_…) are server-side — keep them private. Publishable keys (flowy_pk_…) are browser-safe but only work from their allowlisted domains.
{
"error": "this API key lacks the runs:write scope"
}
{
"error": "this API key lacks the runs:write scope"
}
{
"error": "this API key lacks the runs:write scope"
}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Flowy","description":"Documentation for Flowy — the node-based AI creative platform. Generate images, video, audio, 3D and vector on an infinite canvas, edit on the Studio timeline, collaborate in real time, and ship over the API, MCP server or CLI.","colors":{"primary":"#5c4a00","light":"#ffdd00","dark":"#5c4a00"},"logo":{"light":"https://mintcdn.com/flamapp/F3HzOSEZ0flnKi-X/logo/flowy-wordmark-dark.svg?fit=max\u0026auto=format\u0026n=F3HzOSEZ0flnKi-X\u0026q=85\u0026s=f82bb9ceea55e05eb2adaccc84567bb3","dark":"https://mintcdn.com/flamapp/F3HzOSEZ0flnKi-X/logo/flowy-wordmark-white.svg?fit=max\u0026auto=format\u0026n=F3HzOSEZ0flnKi-X\u0026q=85\u0026s=ff73d4d6f64cfdebf6c87382d3238682","href":"https://tryflowy.ai"},"favicon":"https://mintcdn.com/flamapp/d-IQVAHPd1A_gxXA/favicon.svg?fit=max\u0026auto=format\u0026n=d-IQVAHPd1A_gxXA\u0026q=85\u0026s=9850a281bea94ddad3a66dec30f8e231","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript","php","go","java","ruby"]}},"appearance":{"default":"system"},"background":{"decoration":"grid","color":{"light":"#ffffff","dark":"#0f0f0f"}},"navbar":{"links":[{"href":"https://docs.tryflowy.ai/help/overview","label":"Help Center"},{"href":"https://tryflowy.ai/community","label":"Community"},{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Open Flowy","href":"https://tryflowy.ai/auth/sign-in"}},"footer":{"socials":{"x":"https://x.com/TryFlowyAI","instagram":"https://www.instagram.com/tryflowyai","linkedin":"https://www.linkedin.com/in/flowy-ai-756474412","youtube":"https://www.youtube.com/@tryflowyai","reddit":"https://www.reddit.com/r/FlowyAI","discord":"https://discord.gg/nTeVdHpZ"},"links":[{"header":"Product","items":[{"label":"Canvas","href":"https://docs.tryflowy.ai/canvas/overview"},{"label":"Studio","href":"https://docs.tryflowy.ai/studio/overview"},{"label":"Pricing","href":"https://tryflowy.ai/pricing"},{"label":"Community","href":"https://tryflowy.ai/community"}]},{"header":"Developers","items":[{"label":"API reference","href":"https://docs.tryflowy.ai/api/introduction"},{"label":"MCP server","href":"https://tryflowy.ai/mcp"},{"label":"CLI","href":"https://tryflowy.ai/cli"},{"label":"Skills","href":"https://tryflowy.ai/skills"}]},{"header":"Resources","items":[{"label":"Help Center","href":"https://docs.tryflowy.ai/help/overview"},{"label":"What's new","href":"https://tryflowy.ai/updates"},{"label":"Brand assets","href":"https://tryflowy.ai/brand"},{"label":"Contact support","href":"mailto:[email protected]"}]}]},"search":{"prompt":"Search the Flowy docs…"},"seo":{"metatags":{"og:site_name":"Flowy Docs","og:type":"website","twitter:card":"summary_large_image","twitter:site":"@TryFlowyAI"},"organization":{"name":"Flowy","url":"https://tryflowy.ai","logo":"https://tryflowy.ai/brand/flowy-lockup.svg","sameAs":["https://x.com/TryFlowyAI","https://www.linkedin.com/in/flowy-ai-756474412/","https://www.youtube.com/@tryflowyai","https://www.instagram.com/tryflowyai/","https://www.reddit.com/r/FlowyAI/"]},"indexing":"navigable"},"fonts":{"heading":{"family":"ClashDisplay","weight":600,"source":"fonts/ClashDisplay-600.woff2","format":"woff2"},"body":{"family":"Geist","weight":400}},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"vesper"}},"latex":true},"integrations":{"posthog":{"apiKey":"phc_zS4jWzBsK9uPebPsFVri9PUNrh4i5Nq9EzNQrP7ZM7oK","apiHost":"https://t.tryflowy.studio","sessionRecording":false}},"errors":{"404":{"redirect":false,"title":"This page drifted off the canvas","description":"We couldn't find that page. Try [search](/), start from the [quickstart](/getting-started/quickstart), or head to the [Help Center](/help/overview)."}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity","cursor","vscode","mcp","add-mcp"],"display":"header"},"thumbnails":{"appearance":"dark"},"metadata":{"timestamp":true},"markdown":{"instructions":["Flowy is a node-based AI creative platform: you generate images, video, audio, 3D and vector on an infinite Canvas, refine on the Studio timeline, and export or publish from the same project.","Prefer the Flowy MCP server (https://mcp.tryflowy.ai/mcp) or the REST API at https://apis.tryflowy.ai/v1 for programmatic work. Install with `flowy mcp install` from the @tryflowy/cli package.","Credits are workspace-scoped. Generations reserve credits on start and only deduct on success, so failed runs refund automatically."]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flamapp","hasAudioNarration":false,"actualSubdomain":"flamapp","customDomains":["docs.tryflowy.ai"],"gitSource":{"type":"github","owner":"homingos","repo":"fe-flowy","deployBranch":"production","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"790885bc-c594-4904-b778-fba1e8be8605","liveDeploymentHistoryId":"6acbeae6c34d60a683e20ede","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acbeae6c34d60a683e20ede"},"feedback":{"thumbs":true,"edits":false,"agentFeedback":true,"issues":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adb64d8adb57cc3ba90206d","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Documentation","count":118},{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Canvas","count":38},{"language":"default","tag":"Endpoints","count":28},{"language":"default","tag":"Help Center","count":27},{"language":"default","tag":"Nodes","count":17},{"language":"default","tag":"Settings","count":16},{"language":"default","tag":"Tools","count":16},{"language":"default","tag":"Flows","count":11},{"language":"default","tag":"Studio","count":10}]},"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":"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":true},"customCss":[{"filePath":"style.css","content":":root{--flowy-bone:#fcf0d6;--flowy-bone-deep:#f7e7c4;--flowy-signal:#ffdd00;--flowy-signal-deep:#e8c800;--flowy-umber:#3d2c0c;--flowy-umber-deep:#2a2418;--flowy-brand:var(--flowy-signal);--flowy-brand-pressed:var(--flowy-signal-deep);--flowy-on-brand:#1a1400;--flowy-current:var(--flowy-bone);--flowy-wash:#fff8d1;--flowy-wash-hover:#ffef9e;--flowy-ink:#5c4a00;--flowy-content-default:rgba(20, 20, 26, 0.66);--flowy-content-subtle:rgba(20, 20, 26, 0.42);--flowy-edge:var(--flowy-ink);--flowy-bg:#ffffff;--flowy-bg-subtle:#efeff2;--flowy-border-subtle:rgba(0, 0, 0, 0.06);--flowy-border-default:rgba(0, 0, 0, 0.1);--flowy-radius:0.625rem;--flowy-radius-lg:1rem;--flowy-ease:cubic-bezier(0.2, 0, 0, 1)}.dark{--flowy-wash:var(--flowy-umber);--flowy-wash-hover:#5c4212;--flowy-ink:var(--flowy-signal);--flowy-content-default:rgba(244, 242, 246, 0.66);--flowy-content-subtle:rgba(244, 242, 246, 0.42);--flowy-edge:var(--flowy-bone);--flowy-bg:#0f0f0f;--flowy-bg-subtle:#1c1c1c;--flowy-border-subtle:rgba(255, 255, 255, 0.06);--flowy-border-default:rgba(255, 255, 255, 0.1)}#content h1,#content h2,#content h3{letter-spacing:-.02em}#page-title{letter-spacing:-.03em}breadcrumb-list,eyebrow{font-size:.8125rem;letter-spacing:.01em}img.nav-logo{height:1.5rem!important;width:auto!important}#sidebar a[aria-current=page],#sidebar li>a[data-active=true]{background-color:var(--flowy-wash);color:var(--flowy-ink)}sidebar-group-header{letter-spacing:.02em;text-transform:none}card,frame{border-radius:var(--flowy-radius-lg)}card{transition:border-color 200ms var(--flowy-ease),background-color 200ms var(--flowy-ease)}card:hover{border-color:var(--flowy-edge);background-color:var(--flowy-wash)}.dark card:hover{background-color:rgba(255,221,0,.06)}accordion,callout,code-block,code-group,expandable,mermaid,steps{border-radius:var(--flowy-radius)}frame{overflow:hidden}frame img{border-radius:0}frame figcaption{margin-top:.5rem;font-size:.8125rem;color:var(--flowy-content-subtle)}#content table{font-variant-numeric:tabular-nums}#content table th{font-weight:550;letter-spacing:.01em}#content table td,#content table th,card{border-color:var(--flowy-border-subtle)}#content kbd,.credits{display:inline-block;white-space:nowrap}#content kbd{min-width:1.5rem;padding:.125rem .375rem;border:1px solid var(--flowy-border-default);border-bottom-width:2px;border-radius:.375rem;font-family:var(--font-mono, ui-monospace, SFMono-Regular, Menlo, monospace);font-size:.75rem;line-height:1.4;text-align:center}.credits{padding:.0625rem .5rem;border-radius:999px;background-color:var(--flowy-wash);color:var(--flowy-ink);font-size:.8125rem;font-variant-numeric:tabular-nums;font-weight:550}#content kbd,.flowy-media-frame{background-color:var(--flowy-bg-subtle)}.flowy-media-frame{border:1px solid var(--flowy-border-subtle);border-radius:var(--flowy-radius-lg)}.flowy-media-caption{font-size:.8125rem;line-height:1.5;color:var(--flowy-content-subtle)}.flowy-play-button{background-color:var(--flowy-brand)}.flowy-play-button:hover{background-color:var(--flowy-brand-pressed)}"}],"page":{"pagePath":"api/get-credits","slug":"/api/get-credits","pageMetadata":{"title":"Get the credit balance","description":"Read a wallet's credits: total, blocked, and available.","openapi":"api-reference/openapi.json GET /v1/credits","href":"/api/get-credits"},"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 a wallet’s credits: total, blocked, and available.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Defaults to the key’s own wallet (for account-bound keys, your account wallet). Pass `,_jsx(_components.code,{children:`workspace_id`}),` to read the balance of any workspace you can manage: ids come from `,_jsx(_components.a,{href:`/api/list-workspaces`,children:`List workspaces`}),`.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"vesper"}},"config":{},"pageMetadata":{"title":"Get the credit balance","description":"Read a wallet's credits: total, blocked, and available.","openapi":"api-reference/openapi.json GET /v1/credits","href":"/api/get-credits"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Credits"],"summary":"Get the credit balance","description":"Read a wallet's credits: total, blocked, and available.","operationId":"getCredits","responses":{"200":"82f56a94-9a20-4aaf-bf7c-dd7285b64669","401":"085ac05f-4e78-4960-85ce-965604174d36","403":"6631eeae-ec66-463f-ba5b-650d72c66df1","429":"ce89a9f1-7eed-45b1-a9ee-5e1d0c0e461a"},"parameters":["8dc1350f-3198-44a2-b219-b6b4fc905639"],"method":"get","type":"path","servers":["1a7ea0fa-7b34-4667-a7b6-198ed09d9523","181c068a-c621-4c4f-8b64-e1dbe897feb2","0aebcbfd-17af-4ce7-8c2d-1127571dc810","f77bf05b-5d03-4a21-b7f1-b94744090971","bf74296e-4b8e-4b90-ba26-6fa6ddedbebf","baa1a561-19e0-45e5-b935-c9f64193112c","e1c13e3b-c677-499d-a92b-a139a7968a88","7fc816de-d46b-4cb6-bb18-55f5f90b8d73","4da86709-430c-476b-b50d-48ec655f576b","8e229b97-165d-47df-bd67-1d36958e92d9","25e3cafc-bf42-4ec0-affc-7349d2c743ee","bb8c68bd-fa0c-4fd2-a1b6-754aae2786a1","6191495a-551d-4815-af93-836d23221bc9"],"security":["75818091-806b-4a5f-904d-609229bd4a9a"],"path":"/v1/credits","baseUrlOptions":["https://apis.tryflowy.ai/genstudio-svc-v2/api","https://fi.development.flamapis.com/genstudio-svc-v2/api","http://localhost:8000/genstudio-svc-v2/api","https://fi.development.flamapis.com/genstudio-svc-v2/api","http://localhost:8000/genstudio-svc-v2/api","https://fi.development.flamapis.com/genstudio-svc-v2/api","http://localhost:8000/genstudio-svc-v2/api","https://fi.development.flamapis.com/genstudio-svc-v2/api","http://localhost:8000/genstudio-svc-v2/api","https://fi.development.flamapis.com/genstudio-svc-v2/api","http://localhost:8000/genstudio-svc-v2/api","https://fi.development.flamapis.com/genstudio-svc-v2/api","http://localhost:8000/genstudio-svc-v2/api"],"title":"Get the credit balance","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","php","go","java","ruby"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8dc1350f-3198-44a2-b219-b6b4fc905639":{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Optional workspace id (from GET /v1/workspaces). Default: the key's own wallet.","uniqueKey":"","typeLabel":"string"},"description":"Optional workspace id (from GET /v1/workspaces). Default: the key's own wallet."}},"responses":{"82f56a94-9a20-4aaf-bf7c-dd7285b64669":{"description":"The workspace credit balance.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window (per minute).","schema":{"type":"integer","example":60}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","example":59}},"X-RateLimit-Reset":{"description":"Unix epoch second at which the current window resets.","schema":{"type":"integer","example":1893456000}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"workspaceId":{"type":"string","example":"507f1f77bcf86cd799439011","uniqueKey":"data.workspaceId","typeLabel":"string"},"credits":{"type":"number","description":"Total credits on the workspace wallet.","example":5000,"uniqueKey":"data.credits","typeLabel":"number"},"blockedCredits":{"type":"number","description":"Credits reserved by in-flight generations/runs.","example":120,"uniqueKey":"data.blockedCredits","typeLabel":"number"},"available":{"type":"number","description":"credits - blockedCredits.","example":4880,"uniqueKey":"data.available","typeLabel":"number"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"workspaceId":"507f1f77bcf86cd799439011","credits":5000,"blockedCredits":120,"available":4880}}}},"exampleType":"generated"}},"exampleType":"generated"},"085ac05f-4e78-4960-85ce-965604174d36":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"this API key lacks the runs:write scope","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"this API key lacks the runs:write scope"}}},"exampleType":"generated"}},"exampleType":"generated"},"6631eeae-ec66-463f-ba5b-650d72c66df1":{"description":"The key lacks the credits:read scope","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"this API key lacks the runs:write scope","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"this API key lacks the runs:write scope"}}},"exampleType":"generated"}},"exampleType":"generated"},"ce89a9f1-7eed-45b1-a9ee-5e1d0c0e461a":{"description":"Rate limit exceeded","headers":{"Retry-After":{"description":"Seconds to wait before retrying (sent on 429).","schema":{"type":"integer","example":12}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"this API key lacks the runs:write scope","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"this API key lacks the runs:write scope"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"75818091-806b-4a5f-904d-609229bd4a9a":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"flowy_*","description":"A workspace API key. Secret keys (`flowy_…`) are server-side — keep them private. Publishable keys (`flowy_pk_…`) are browser-safe but only work from their allowlisted domains.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"1a7ea0fa-7b34-4667-a7b6-198ed09d9523":{"url":"https://apis.tryflowy.ai/genstudio-svc-v2/api","description":"Flowy API"},"181c068a-c621-4c4f-8b64-e1dbe897feb2":{"url":"https://fi.development.flamapis.com/genstudio-svc-v2/api","description":"Development"},"0aebcbfd-17af-4ce7-8c2d-1127571dc810":{"url":"http://localhost:8000/genstudio-svc-v2/api","description":"Local"},"f77bf05b-5d03-4a21-b7f1-b94744090971":{"url":"https://fi.development.flamapis.com/genstudio-svc-v2/api","description":"Development"},"bf74296e-4b8e-4b90-ba26-6fa6ddedbebf":{"url":"http://localhost:8000/genstudio-svc-v2/api","description":"Local"},"baa1a561-19e0-45e5-b935-c9f64193112c":{"url":"https://fi.development.flamapis.com/genstudio-svc-v2/api","description":"Development"},"e1c13e3b-c677-499d-a92b-a139a7968a88":{"url":"http://localhost:8000/genstudio-svc-v2/api","description":"Local"},"7fc816de-d46b-4cb6-bb18-55f5f90b8d73":{"url":"https://fi.development.flamapis.com/genstudio-svc-v2/api","description":"Development"},"4da86709-430c-476b-b50d-48ec655f576b":{"url":"http://localhost:8000/genstudio-svc-v2/api","description":"Local"},"8e229b97-165d-47df-bd67-1d36958e92d9":{"url":"https://fi.development.flamapis.com/genstudio-svc-v2/api","description":"Development"},"25e3cafc-bf42-4ec0-affc-7349d2c743ee":{"url":"http://localhost:8000/genstudio-svc-v2/api","description":"Local"},"bb8c68bd-fa0c-4fd2-a1b6-754aae2786a1":{"url":"https://fi.development.flamapis.com/genstudio-svc-v2/api","description":"Development"},"6191495a-551d-4815-af93-836d23221bc9":{"url":"http://localhost:8000/genstudio-svc-v2/api","description":"Local"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"flowy_*","description":"A workspace API key. Secret keys (`flowy_…`) are server-side — keep them private. Publishable keys (`flowy_pk_…`) are browser-safe but only work from their allowlisted domains.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A workspace API key. Secret keys (`flowy_…`) are server-side — keep them private. Publishable keys (`flowy_pk_…`) are browser-safe but only work from their allowlisted domains.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"flamapp","siteName":"Flowy","title":"Get the credit balance - Flowy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-31T13:23:05.392Z","gitLastModified":"2026-08-29T10:49:29.000Z","originalFileLocation":"api/get-credits.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=\"Read a wallet\u0026#x27;s credits: total, blocked, and available.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flowy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flamapp/JgZWkxORrHqxm8c9/_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/flamapp/JgZWkxORrHqxm8c9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flamapp/JgZWkxORrHqxm8c9/_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/flamapp/JgZWkxORrHqxm8c9/_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/flamapp/JgZWkxORrHqxm8c9/_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/flamapp/JgZWkxORrHqxm8c9/_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/flamapp/JgZWkxORrHqxm8c9/_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/flamapp/JgZWkxORrHqxm8c9/_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/flamapp/JgZWkxORrHqxm8c9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the credit balance - Flowy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read a wallet\u0026#x27;s credits: total, blocked, and available.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flowy Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tryflowy.ai/api/get-credits\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flamapp.mintlify.app/_mintlify/api/og/v2?division=Account+%26+credits\u0026amp;title=Get+the+credit+balance\u0026amp;description=Read+a+wallet%27s+credits%3A+total%2C+blocked%2C+and+available.\u0026amp;theme=a13da42bc121a2f7f3023159\u0026amp;signature=3a3941c2824bf04768478a32e55e250bdf3289b844936739dd28ef5539772ff2\">\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 the credit balance - Flowy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read a wallet\u0026#x27;s credits: total, blocked, and available.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flamapp.mintlify.app/_mintlify/api/og/v2?division=Account+%26+credits\u0026amp;title=Get+the+credit+balance\u0026amp;description=Read+a+wallet%27s+credits%3A+total%2C+blocked%2C+and+available.\u0026amp;theme=a13da42bc121a2f7f3023159\u0026amp;signature=3a3941c2824bf04768478a32e55e250bdf3289b844936739dd28ef5539772ff2\">\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/flamapp/JgZWkxORrHqxm8c9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flowy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5c4a00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tryflowy.ai/api/get-credits\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/get-credits.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://tryflowy.ai/#organization\",\"name\":\"Flowy\",\"url\":\"https://tryflowy.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://tryflowy.ai/brand/flowy-lockup.svg\"},\"sameAs\":[\"https://x.com/TryFlowyAI\",\"https://www.linkedin.com/in/flowy-ai-756474412/\",\"https://www.youtube.com/@tryflowyai\",\"https://www.instagram.com/tryflowyai/\",\"https://www.reddit.com/r/FlowyAI/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tryflowy.ai#website\",\"name\":\"Flowy\",\"url\":\"https://docs.tryflowy.ai\",\"publisher\":{\"@id\":\"https://tryflowy.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tryflowy.ai/api/get-credits#webpage\",\"url\":\"https://docs.tryflowy.ai/api/get-credits\",\"name\":\"Get the credit balance\",\"description\":\"Read a wallet's credits: total, blocked, and available.\",\"dateModified\":\"2026-08-29T10:49:29.000Z\",\"isPartOf\":{\"@id\":\"https://docs.tryflowy.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tryflowy.ai/api/get-credits#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tryflowy.ai/api/get-credits#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.tryflowy.ai/api/list-apps\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Account \u0026 credits\",\"item\":\"https://docs.tryflowy.ai/api/get-account\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get the credit balance\",\"item\":\"https://docs.tryflowy.ai/api/get-credits\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tryflowy.ai/api/get-credits#apireference\",\"headline\":\"Get the credit balance\",\"name\":\"Get the credit balance\",\"description\":\"Read a wallet's credits: total, blocked, and available.\",\"url\":\"https://docs.tryflowy.ai/api/get-credits\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tryflowy.ai/api/get-credits#webpage\"},\"dateModified\":\"2026-08-29T10:49:29.000Z\",\"publisher\":{\"@id\":\"https://tryflowy.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tryflowy.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flowy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Flowy","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"Help Center","icon":"life-ring","pages":[{"title":"Help Center","href":"/help/overview"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Get started","expanded":true,"pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Authentication","href":"/api/authentication"},{"title":"Create a session","href":"/api/create-session"},{"title":"Permissions","href":"/api/permissions"},{"title":"OAuth apps","href":"/api/oauth"},{"title":"MCP server","href":"/api/mcp"},{"title":"CLI","href":"/api/cli"},{"title":"Skills","href":"/api/skills"},{"title":"Run a flow","href":"/api/running-apps"}]},{"group":"Endpoints","pages":[{"group":"Flows","pages":[{"title":"List flows","openapi":"api-reference/openapi.json GET /v1/apps","href":"/api/list-apps"},{"title":"Get a flow","openapi":"api-reference/openapi.json GET /v1/apps/{appId}","href":"/api/get-app"},{"title":"Create a flow","href":"/api/create-flow"},{"title":"Start a run","openapi":"api-reference/openapi.json POST /v1/apps/{appId}/runs","href":"/api/start-run"},{"title":"Get a run","openapi":"api-reference/openapi.json GET /v1/runs/{runId}","href":"/api/get-run"}]},{"group":"Generations","pages":[{"title":"Start a generation","openapi":"api-reference/openapi.json POST /v1/generations","href":"/api/start-generation"},{"title":"Get a generation","openapi":"api-reference/openapi.json GET /v1/generations/{generationId}","href":"/api/get-generation"}]},{"group":"Assets","pages":[{"title":"List assets","openapi":"api-reference/openapi.json GET /v1/assets","href":"/api/list-assets"},{"title":"Get an asset","openapi":"api-reference/openapi.json GET /v1/assets/{assetId}","href":"/api/get-asset"}]},{"group":"Elements","pages":[{"title":"List elements","openapi":"api-reference/openapi.json GET /v1/elements","href":"/api/list-elements"},{"title":"Create an element","openapi":"api-reference/openapi.json POST /v1/elements","href":"/api/create-element"},{"title":"Get an element","openapi":"api-reference/openapi.json GET /v1/elements/{elementId}","href":"/api/get-element"}]},{"group":"Projects \u0026 nodes","pages":[{"title":"List projects","openapi":"api-reference/openapi.json GET /v1/projects","href":"/api/list-projects"},{"title":"Create a node generation","openapi":"api-reference/openapi.json POST /v1/projects/{projectId}/nodes","href":"/api/create-node"}]},{"group":"Brand kits","pages":[{"title":"List brand kits","openapi":"api-reference/openapi.json GET /v1/brandkits","href":"/api/list-brandkits"},{"title":"Get a brand kit","openapi":"api-reference/openapi.json GET /v1/brandkits/{id}","href":"/api/get-brandkit"},{"title":"Create a brand kit","openapi":"api-reference/openapi.json POST /v1/brandkits","href":"/api/create-brandkit"},{"title":"Update a brand kit","openapi":"api-reference/openapi.json PATCH /v1/brandkits/{id}","href":"/api/update-brandkit"},{"title":"Poll a brand kit extraction","openapi":"api-reference/openapi.json GET /v1/brandkits/extract/{jobId}","href":"/api/poll-brandkit-extract"},{"title":"Delete a brand kit","openapi":"api-reference/openapi.json DELETE /v1/brandkits/{id}","href":"/api/delete-brandkit"}]},{"group":"Renders","pages":[{"title":"Render a composition","openapi":"api-reference/openapi.json POST /v1/renders","href":"/api/start-render"},{"title":"Get a render","openapi":"api-reference/openapi.json GET /v1/renders/{workflowId}","href":"/api/get-render"},{"title":"List renders","openapi":"api-reference/openapi.json GET /v1/renders","href":"/api/list-renders"}]},{"group":"Account \u0026 credits","pages":[{"title":"Get the account","openapi":"api-reference/openapi.json GET /v1/account","href":"/api/get-account"},{"title":"List workspaces","description":"Every workspace the account can act in.","openapi":"api-reference/openapi.json GET /v1/workspaces","href":"/api/list-workspaces"},{"title":"Get the credit balance","openapi":"api-reference/openapi.json GET /v1/credits","href":"/api/get-credits"},{"title":"List account transactions","description":"The account's credit ledger, newest first.","openapi":"api-reference/openapi.json GET /v1/account/transactions","href":"/api/list-account-transactions"}]},{"group":"OpenAPI","pages":[{"title":"Get the OpenAPI spec","openapi":"api-reference/openapi.json GET /v1/openapi.json","href":"/api/get-openapi"}]}]},{"group":"Reference","pages":[{"title":"Rate limits","href":"/api/rate-limits"},{"title":"Errors","href":"/api/errors"},{"title":"Identity Handoff","href":"/api/identity-handoff"}]}]}]},"title":"Get the credit balance - Flowy","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-D5fEM6aW.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}