Key on the SERVERLESS preset, or any key whose permissions include the ones this API lists. Prefix it with "Key ", e.g. Authorization: Key YOUR_API_KEY
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"fal","colors":{"primary":"#5718C0","light":"#C0B1FF","dark":"#5718C0"},"logo":{"light":"https://mintcdn.com/fal-d8505a2e/0cIaYtN4gA36hPQJ/logo/light.svg?fit=max\u0026auto=format\u0026n=0cIaYtN4gA36hPQJ\u0026q=85\u0026s=4b6014d36569092b761c871db9df6a41","dark":"https://mintcdn.com/fal-d8505a2e/0cIaYtN4gA36hPQJ/logo/dark.svg?fit=max\u0026auto=format\u0026n=0cIaYtN4gA36hPQJ\u0026q=85\u0026s=c1760d019183048af07d008cd2377ca4","href":"https://fal.ai/docs"},"favicon":"https://mintcdn.com/fal-d8505a2e/8WsQEbl1OYp5vQ4g/favicon.svg?fit=max\u0026auto=format\u0026n=8WsQEbl1OYp5vQ4g\u0026q=85\u0026s=9b5e82f7c6b96d136d51bce8e2cdd0e2","api":{"params":{"expanded":"all"},"playground":{"display":"interactive","proxy":false},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://fal.ai/enterprise#contact-sales","label":"Contact Sales"}],"primary":{"type":"button","label":"Login","href":"https://fal.ai/login"}},"footer":{"socials":{"discord":"https://discord.gg/fal-ai","x":"https://twitter.com/fal","github":"https://github.com/fal-ai","linkedin":"https://www.linkedin.com/company/features-and-labels"}},"seo":{"metatags":{"og:image":"/logo/light.svg","google-site-verification":"kcN2RYfXHsfUeWlkX6-E32JdCXwUdHA5w5NIXr2xWTY"},"organization":{"id":"https://fal.ai/#organization","legalName":"Features \u0026 Labels Inc.","url":"https://fal.ai/","logo":"https://fal.ai/apple-touch-icon.png","sameAs":["https://discord.gg/fal-ai","https://github.com/fal-ai","https://www.reddit.com/r/fal/","https://twitter.com/fal","https://www.linkedin.com/company/features-and-labels/","https://www.youtube.com/@Fal.AI.Official","https://www.instagram.com/madeonfal","https://www.tiktok.com/@madeonfal"]}},"fonts":{"heading":{"family":"Focal","source":"https://mintlify-assets.b-cdn.net/fonts/Focal-Regular-Web.woff2","format":"woff2"},"body":{"family":"Public Sans"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"posthog":{"apiKey":"phc_BkrygUwvQjwRHnwDjFQtoY77ts2fse3HVTHQUJk5BNO","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"markdown":{"instructions":["fal has two developer products. Model APIs run hosted models through an API key. fal Serverless deploys your own Python apps and models on fal GPUs.","To call a hosted model, start with the [Quick Start](https://fal.ai/docs/documentation/quickstart.md) and the [Model APIs overview](https://fal.ai/docs/documentation/model-apis/overview.md).","To deploy your own model with fal Serverless, start with these pages:","- [Introduction to Serverless](https://fal.ai/docs/documentation/serverless/index.md): What fal Serverless is and the three ways to deploy on it.","- [Installation \u0026 Setup](https://fal.ai/docs/documentation/development/getting-started/installation.md): Install the fal CLI with `pip install fal` and authenticate.","- [Quick Start](https://fal.ai/docs/documentation/development/getting-started/quick-start.md): Build a Hello World app, test it with `fal run`, and ship it with `fal deploy`.","- [App Lifecycle](https://fal.ai/docs/documentation/development/app-lifecycle.md): How a `fal.App` goes from code to running runners.","- [Define Your Endpoints](https://fal.ai/docs/documentation/development/endpoints-overview.md): Structure the API endpoints that your app exposes.","- [Deploy to Production](https://fal.ai/docs/documentation/deployment/deploy-to-production.md): Persistent URLs, authentication modes, and automatic scaling.","- [Machine Types](https://fal.ai/docs/documentation/deployment/machine-types.md): Available GPU and CPU machine types and how to choose one.","- [Pricing](https://fal.ai/docs/documentation/serverless/pricing.md): Per-second billing and the runner states that are billed.","- [Scaling Parameter Reference](https://fal.ai/docs/documentation/deployment/scale-your-application.md): Parameters that control runners, concurrency, and scale to zero.","- [Optimizing Cold Starts](https://fal.ai/docs/documentation/serverless/optimizations/optimize-cold-starts.md): Causes of cold starts and ways to make them shorter.","- [Examples](https://fal.ai/docs/examples/index.md): Complete Serverless apps for image, video, audio, 3D, realtime, and multi-GPU workloads.","- [Migrating to fal](https://fal.ai/docs/documentation/development/migrating-to-fal.md): Guides to move an existing Docker server or an app from another platform to fal.","fal Serverless deploys need access that the fal team approves for each account. Request access at https://fal.ai/dashboard/serverless-get-started."]},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"signal","href":"https://status.fal.ai/"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/fal-ai"},{"anchor":"Blog","icon":"newspaper","href":"https://blog.fal.ai/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fal-d8505a2e","hasAudioNarration":false,"actualSubdomain":"fal-d8505a2e","customDomains":["fal.ai"],"gitSource":{"type":"github","owner":"fal-ai","repo":"fal-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebb7628d59422f14e1cbe9","collectionId":"acef6807-b12b-46b8-8a12-9387eb6d5051","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebb7628d59422f14e1cbe9"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aed13614a041c12b4b9b3da","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"Documentation","count":199},{"language":"default","tag":"Model API Reference","count":138},{"language":"default","tag":"Serverless","count":100},{"language":"default","tag":"Platform API","count":86},{"language":"default","tag":"API Endpoints","count":83},{"language":"default","tag":"Image Generation","count":60},{"language":"default","tag":"Video Generation","count":60},{"language":"default","tag":"SDK Reference","count":55},{"language":"default","tag":"fal Agent","count":45},{"language":"default","tag":"Development","count":37}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@fal.ai","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-bash","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"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":[{"filePath":"style.css","content":"@font-face{font-family:'Focal Medium';src:url('https://mintlify-assets.b-cdn.net/fonts/Focal-Medium-Web.woff2') format('woff2');font-weight:500;font-style:normal;font-display:swap}#content-area::after{content:'';position:fixed;top:80px;right:24px;width:85px;height:225px;background:url('/docs/images/page-decoration.svg') no-repeat center;background-size:contain;pointer-events:none;z-index:10;opacity:0.8}.dark #content-area::after{opacity:0.4}@media (max-width: 1325px){#content-area::after{display:none}}#content-area,#content-area>div,[class*=\"prose\"]{max-width:900px!important}#hero-section{position:relative}#hero-section>*{position:relative;z-index:1}ul#sidebar-group>li>a,ul#sidebar-group>li>button{font-weight:600!important}li[data-group-tag]>ul li>a,li[data-group-tag]>ul li>button{margin-left:2rem!important}#sidebar-content{padding-left:1rem;overflow-x:clip;width:350px!important;min-width:350px!important}@media (min-width: 1024px){#sidebar{width:350px!important}#content-container{margin-left:350px!important}#navbar-transition-maple{left:350px!important}}#sidebar-content{background-color:#f7f7f8!important}.dark #sidebar-content{background-color:#14151A!important}@media (min-width: 1024px){ul.w-\\[calc\\(19rem-1px\\)\\]{width:350px!important;background-color:#f7f7f8!important}.dark ul.w-\\[calc\\(19rem-1px\\)\\]{background-color:#14151A!important}}#sidebar-content::before{content:'';position:absolute;top:0;left:-100vw;width:100vw;height:100%;background-color:#f7f7f8;z-index:-1}.dark #sidebar-content::before{background-color:#14151A}.card-group img[data-component-part=\"card-image\"],.card img[data-component-part=\"card-image\"]{aspect-ratio:16 / 9;height:auto!important;object-fit:cover!important;width:100%!important}.code-group pre,pre[class*=\"language-\"]{max-height:600px;overflow-y:auto}@media (min-width: 1024px){div[id=\"content-container\"]{max-width:100%!important}.peer.is-not-center~.peer-\\[\\.is-not-center\\]\\:max-w-8xl,.peer.is-not-custom~.peer-\\[\\.is-not-custom\\]\\:max-w-8xl,.max-w-8xl{max-width:100%!important}}@media (max-width: 1440px){.peer.is-not-center~.peer-\\[\\.is-not-center\\]\\:max-w-8xl,.peer.is-not-custom~.peer-\\[\\.is-not-custom\\]\\:max-w-8xl,.max-w-8xl{max-width:100%!important}}@media (min-width: 1920px){.peer.is-not-center~.peer-\\[\\.is-not-center\\]\\:max-w-8xl,.peer.is-not-custom~.peer-\\[\\.is-not-custom\\]\\:max-w-8xl,.max-w-8xl{max-width:75%!important}}*:not(li.toc-item):not(li.toc-item *):not(.link):not(.flex-1):not(.flex-1 *){border-radius:4px!important}#navbar input,#navbar [id*=\"search\"],nav input,header input{border-radius:4px!important}#navbar button,#navbar a,#navbar a>*,nav button,nav a,nav a>*,header button,header a,header a>*{border-radius:4px!important}a[href*=\"login\"],a[href*=\"login\"]>*{border-radius:4px!important}#navbar a[href=\"https://fal.ai/\"],#navbar a[href=\"https://fal.ai/\"]>*,nav a[href=\"https://fal.ai/\"],nav a[href=\"https://fal.ai/\"]>*,header a[href=\"https://fal.ai/\"],header a[href=\"https://fal.ai/\"]>*{border-radius:0!important}body{font-feature-settings:'ss01' on!important}[data-tooltip],.tooltip-trigger,span[style*=\"border-bottom\"][style*=\"dotted\"],button[data-state]>span[style*=\"dotted\"],span[class*=\"tooltip\"],[data-radix-tooltip-trigger]{border-bottom-color:#5718C0!important;color:#5718C0!important;text-decoration-color:#5718C0!important}.dark [data-tooltip],.dark .tooltip-trigger,.dark span[style*=\"border-bottom\"][style*=\"dotted\"],.dark button[data-state]>span[style*=\"dotted\"],.dark span[class*=\"tooltip\"],.dark [data-radix-tooltip-trigger]{border-bottom-color:#C0B1FF!important;color:#C0B1FF!important;text-decoration-color:#C0B1FF!important}[data-radix-tooltip-content] a,[role=\"tooltip\"] a,[data-state=\"delayed-open\"]~[data-radix-tooltip-content] a,div[class*=\"tooltip\"] a[href]{color:#C0B1FF!important;text-decoration:underline!important;text-decoration-color:#C0B1FF!important}[data-radix-tooltip-content] a:hover,[role=\"tooltip\"] a:hover,div[class*=\"tooltip\"] a[href]:hover{color:#ddd0ff!important;text-decoration-color:#ddd0ff!important}.mcp-card:hover{border-color:#a78bfa!important;box-shadow:0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06)!important}.dark .mcp-card:hover{border-color:#8b5cf6!important}#serverless-access-popup{position:fixed;bottom:20px;right:20px;max-width:400px;background:white;border:1px solid #e5e7eb;border-radius:8px;box-shadow:0 10px 25px rgba(0, 0, 0, 0.1);padding:20px;z-index:9999;animation:slideInUp 0.3s ease-out;font-family:-apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', sans-serif}.dark #serverless-access-popup{background:#1f2937;border-color:#374151;box-shadow:0 10px 25px rgba(0, 0, 0, 0.3)}#serverless-access-popup.hidden{display:none}@keyframes slideInUp{from{transform:translateY(100px);opacity:0}to{transform:translateY(0);opacity:1}}#serverless-access-popup .popup-header{display:flex;justify-content:space-between;align-items:flex-start;margin-bottom:12px}#serverless-access-popup .popup-title{font-size:16px;font-weight:600;color:#111827;margin:0}.dark #serverless-access-popup .popup-title{color:#f9fafb}#serverless-access-popup .popup-close{background:none;border:none;font-size:20px;color:#6b7280;cursor:pointer;padding:0;width:24px;height:24px;display:flex;align-items:center;justify-content:center;border-radius:4px;transition:background-color 0.2s}#serverless-access-popup .popup-close:hover{background-color:#f3f4f6;color:#111827}.dark #serverless-access-popup .popup-close:hover{background-color:#374151;color:#f9fafb}#serverless-access-popup .popup-content{color:#4b5563;font-size:14px;line-height:1.6;margin-bottom:16px}.dark #serverless-access-popup .popup-content{color:#d1d5db}#serverless-access-popup .popup-action{display:inline-block;background-color:#5718C0;color:white;padding:10px 16px;border-radius:6px;text-decoration:none;font-size:14px;font-weight:500;transition:background-color 0.2s;border:none;cursor:pointer}#serverless-access-popup .popup-action:hover{background-color:#4612a0;color:white}@media (max-width: 640px){#serverless-access-popup{left:20px;right:20px;max-width:none}}button[aria-label=\"Try it\"],button[aria-label=\"Send\"],.tryit-button{background-color:rgb(var(--primary-dark) / var(--tw-bg-opacity))}html:has([content=\"Model search - fal\"]) #authorization-authorization [data-component-part=\"field-required-pill\"],html:has([content=\"Model search - fal\"]) [title=\"Authorization\"] [data-component-part=\"field-required-pill\"]{display:none!important}[data-tag=\"Breaking Change\"],.tag[data-tag=\"Breaking Change\"],span:has-text(\"Breaking Change\"){background-color:#fee2e2!important;color:#991b1b!important;border:1px solid #fca5a5!important;font-weight:600!important}.dark [data-tag=\"Breaking Change\"],.dark .tag[data-tag=\"Breaking Change\"],.dark span:has-text(\"Breaking Change\"){background-color:#7f1d1d!important;color:#fecaca!important;border:1px solid #991b1b!important}div:has(>[data-tag=\"Breaking Change\"]){border-left:4px solid #dc2626!important;padding-left:1rem!important}.dark div:has(>[data-tag=\"Breaking Change\"]){border-left-color:#ef4444!important}body:has(#docs-hero-page) #content-area>header,body:has(#docs-hero-page) article>header:first-child,body:has(#docs-hero-page) .prose>h1:first-child,body:has(#docs-hero-page) [class*=\"PageHeader\"],body:has(#docs-hero-page) [class*=\"page-header\"]{display:none!important}.fal-hero-badge{display:inline-flex;align-items:center;gap:0.5rem;padding:0.375rem 0.875rem;background:rgba(87, 24, 192, 0.1);border:1px solid rgba(87, 24, 192, 0.25);border-radius:4px;font-size:0.75rem;color:#5718C0;margin-bottom:1.25rem;font-family:'SF Mono', 'Monaco', 'Inconsolata', 'Fira Code', monospace;text-transform:uppercase;letter-spacing:0.08em;font-weight:500}.dark .fal-hero-badge{background:rgba(87, 24, 192, 0.15);border-color:rgba(87, 24, 192, 0.35);color:#c0b1ff}.fal-badge-dot{width:6px;height:6px;background:#00ffcc;border-radius:50%;animation:falPulse 2s ease-in-out infinite}@keyframes falPulse{0%,100%{opacity:1;transform:scale(1)}50%{opacity:0.4;transform:scale(0.8)}}.fal-hero-title{font-family:'Focal Medium', 'Focal', sans-serif!important;font-size:56px!important;font-weight:500!important;line-height:1!important;margin:16px 0 10px 0!important;padding:0!important;letter-spacing:-1.12px!important;color:#242426!important}.dark .fal-hero-title{color:#fafafa!important}.fal-hero-subtitle{font-family:'Focal Medium', 'Focal', sans-serif;font-size:20px;font-weight:500;line-height:1;letter-spacing:-0.4px;color:#242426;margin-bottom:10px}.dark .fal-hero-subtitle{color:#fafafa}.fal-hero-body{font-size:16px;line-height:1.4;margin-bottom:1rem;color:#787881;letter-spacing:-0.32px}.fal-hero-body strong{color:#242426}.dark .fal-hero-body strong{color:#fafafa}.fal-hero-search{display:flex;align-items:center;width:100%;max-width:360px;padding:8px 10px;font-size:13px;color:#9ca3af;background:white;border:1px solid rgba(18, 18, 22, 0.1);cursor:pointer;text-align:left;transition:border-color 0.2s;margin-bottom:1rem}.fal-hero-search:hover{border-color:rgba(18, 18, 22, 0.2)}.dark .fal-hero-search{background:#1f2937;border-color:rgba(255, 255, 255, 0.1);color:#6b7280}.fal-hero-search-icon{width:14px;height:14px;margin-right:8px;flex-shrink:0;color:#787881}.fal-hero-search-text{flex:1}.fal-hero-mcp-link{display:flex;align-items:center;gap:5px;margin-left:auto;padding:3px 8px;font-size:11px;font-weight:600;color:#5718C0!important;background:rgba(133, 83, 255, 0.08);text-decoration:none!important;white-space:nowrap;transition:background 0.2s}.fal-hero-mcp-link:hover{background:rgba(133, 83, 255, 0.15)}.dark .fal-hero-mcp-link{color:#C0B1FF!important;background:rgba(133, 83, 255, 0.15)}.dark .fal-hero-mcp-link:hover{background:rgba(133, 83, 255, 0.25)}.fal-stats-row{display:flex;gap:0.5rem;flex-wrap:wrap;margin-top:1.5rem}.fal-stat-item{position:relative;display:flex;flex-direction:column;gap:8px;min-width:99px}.fal-stat-value{font-family:'Focal Medium', 'Focal', sans-serif;font-size:24px;font-weight:500;line-height:1;letter-spacing:-0.4px;color:#242426;cursor:default}.dark .fal-stat-value{color:#fafafa}.fal-stat-label{font-size:14px;font-weight:500;line-height:1.4;letter-spacing:-0.28px;color:#787881}.fal-hero-section{display:flex;gap:2rem;align-items:flex-start;margin-bottom:1.5rem}.fal-hero-text{flex:1;min-width:0}.fal-hero-image{flex:1;min-width:0}.fal-hero-image img{width:100%;height:auto;display:block}.fal-hero-img-dark{display:none!important}.dark .fal-hero-img-light{display:none!important}.dark .fal-hero-img-dark{display:block!important}.dark .fal-hero-img-dark{display:block!important}.fal-feature-card{transition:all 0.3s ease!important;position:relative;overflow:hidden}.fal-feature-card:hover{transform:translateY(-2px)}@media (max-width: 768px){.fal-hero-section{flex-direction:column;align-items:center}.fal-hero-text{width:100%}.fal-stats-row{gap:1rem}.fal-stat-value{font-size:18px}.fal-hero-image{display:flex;justify-content:center;width:100%}.fal-hero-image img{width:auto;max-width:100%;max-height:260px}}.fal-lifecycle-step{position:relative;margin-bottom:1rem;border-radius:8px;overflow:hidden}.fal-lifecycle-step.serverless{background:linear-gradient(135deg, rgba(51, 134, 254, 0.1) 0%, rgba(51, 134, 254, 0.02) 100%);border-left:3px solid #3386FE}.dark .fal-lifecycle-step.serverless{background:linear-gradient(135deg, rgba(51, 134, 254, 0.15) 0%, rgba(51, 134, 254, 0.05) 100%)}.fal-lifecycle-step.modelapis{background:linear-gradient(135deg, rgba(133, 83, 255, 0.1) 0%, rgba(133, 83, 255, 0.02) 100%);border-left:3px solid #8553FF}.dark .fal-lifecycle-step.modelapis{background:linear-gradient(135deg, rgba(133, 83, 255, 0.2) 0%, rgba(133, 83, 255, 0.05) 100%)}.fal-step-header{display:flex;align-items:center;gap:0.75rem;padding:1rem 1.25rem 0.5rem}.fal-step-number{display:flex;align-items:center;justify-content:center;width:28px;height:28px;border-radius:50%;font-size:0.875rem;font-weight:600;flex-shrink:0}.fal-lifecycle-step.serverless .fal-step-number{background:rgba(51, 134, 254, 0.15);color:#1841B5}.dark .fal-lifecycle-step.serverless .fal-step-number{background:rgba(51, 134, 254, 0.25);color:#8EC8FF}.fal-lifecycle-step.modelapis .fal-step-number{background:rgba(133, 83, 255, 0.15);color:#5718C0}.dark .fal-lifecycle-step.modelapis .fal-step-number{background:rgba(133, 83, 255, 0.25);color:#C0B1FF}.fal-step-title{font-size:1.125rem;font-weight:600;flex-grow:1}.fal-step-logo{height:18px;opacity:0.9}.fal-lifecycle-step .fal-step-logo{filter:none}.fal-step-content{padding:0 1.25rem 1rem}.fal-step-content p:first-child{margin-top:0}.fal-step-content ul{margin-bottom:0}@media (max-width: 640px){.fal-step-header{flex-wrap:wrap}.fal-step-logo{order:-1;width:100%;margin-bottom:0.5rem;height:16px}}"}],"page":{"pagePath":"platform-apis/v1/workflows/create","slug":"/platform-apis/v1/workflows/create","pageMetadata":{"title":"Create a workflow","description":"\nCreate a new workflow owned by the authenticated user.\n\n**Authentication:** Required.\n\n**Common Use Cases:**\n- Save a newly built workflow\n- Programmatically provision workflows\n\n**Note:** Workflow names must be unique within your namespace. Creating a\nworkflow with a name you already use returns a 400 validation error.\n \n\n**Required permissions:** `workflows:write`. Key presets that include them: `SERVERLESS`, `FULL`. See [key permissions](https://fal.ai/docs/documentation/model-apis/authentication/key-based#permissions).","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/platform-apis/openapi/v1.json post /workflows","href":"/platform-apis/v1/workflows/create","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Create a new workflow owned by the authenticated user.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Authentication:\"\n }), \" Required.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Common Use Cases:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Save a newly built workflow\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Programmatically provision workflows\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Note:\"\n }), \" Workflow names must be unique within your namespace. Creating a\\nworkflow with a name you already use returns a 400 validation error.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Required permissions:\"\n }), \" \", _jsx(_components.code, {\n children: \"workflows:write\"\n }), \". Key presets that include them: \", _jsx(_components.code, {\n children: \"SERVERLESS\"\n }), \", \", _jsx(_components.code, {\n children: \"FULL\"\n }), \". See \", _jsx(_components.a, {\n href: \"https://fal.ai/docs/documentation/model-apis/authentication/key-based#permissions\",\n children: \"key permissions\"\n }), \".\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"config":{},"pageMetadata":{"title":"Create a workflow","description":"\nCreate a new workflow owned by the authenticated user.\n\n**Authentication:** Required.\n\n**Common Use Cases:**\n- Save a newly built workflow\n- Programmatically provision workflows\n\n**Note:** Workflow names must be unique within your namespace. Creating a\nworkflow with a name you already use returns a 400 validation error.\n \n\n**Required permissions:** `workflows:write`. Key presets that include them: `SERVERLESS`, `FULL`. See [key permissions](https://fal.ai/docs/documentation/model-apis/authentication/key-based#permissions).","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/platform-apis/openapi/v1.json post /workflows","href":"/platform-apis/v1/workflows/create","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/fal-d8505a2e/fbe6cc384b7bbd12/serverless-popup.js","/docs/_mintlify/custom/fal-d8505a2e/9fa06cdd91073ccf/content/playground-hardening.js","/docs/_mintlify/custom/fal-d8505a2e/c80ff4b00a7410c4/content/api-key-formatter.js"],"openApiReferenceData":{"operation":{"operationId":"createWorkflow","summary":"Create a workflow","x-mint":{"href":"/platform-apis/v1/workflows/create"},"description":"\nCreate a new workflow owned by the authenticated user.\n\n**Authentication:** Required.\n\n**Common Use Cases:**\n- Save a newly built workflow\n- Programmatically provision workflows\n\n**Note:** Workflow names must be unique within your namespace. Creating a\nworkflow with a name you already use returns a 400 validation error.\n \n\n**Required permissions:** `workflows:write`. Key presets that include them: `SERVERLESS`, `FULL`. See [key permissions](https://fal.ai/docs/documentation/model-apis/authentication/key-based#permissions).","tags":["Workflows"],"requestBody":"85e19a2f-b313-4fc1-a36f-98cbe039c624","responses":{"201":"706a172c-ad91-4f09-8387-5c2fdf49b410","400":"864a2276-edae-48f1-b615-a75faeea1ce1","401":"ad554b3c-5986-431c-8aed-b64f8e2422f8","403":"1199cef5-baf7-4a8d-86ad-1a3fdb65ade4","429":"87f754a5-ec61-4604-8e1e-3ac7a73ed689","500":"55821304-bad8-4859-85c1-f5a73648a11d"},"x-fal-permissions":{"requires_auth":true,"all_of":["workflows:write"]},"security":["f88c56b7-c2ae-4be0-8423-0e29f334cede"],"method":"post","type":"path","servers":["25a8d5d0-fddf-4164-bca5-9e0e15449f64"],"path":"/workflows","baseUrlOptions":["https://api.fal.ai/v1"],"title":"Create a workflow","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.name":"my-image-workflow","body.title":"My Image Generation Workflow","body.contents.name":"my-image-workflow","body.contents.version":"1.0.0","body.contents.nodes.node_a1b2c3.id":"node_a1b2c3","body.contents.nodes.node_a1b2c3.type":"run","body.contents.nodes.node_a1b2c3.app":"fal-ai/flux/dev","body.contents.nodes.node_a1b2c3.depends":[],"body.contents.nodes.node_a1b2c3.input":{"prompt":"$input.prompt"},"body.contents.nodes.node_a1b2c3.metadata":{"position":{"x":300,"y":100}},"body.contents.output.image":"$node_a1b2c3.images.0.url","body.contents.schema.input.prompt":{"type":"string"},"body.contents.schema.output.image":{"type":"string"},"body.is_public":false}],"disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[a-zA-Z0-9_-]+$","description":"Unique workflow name/slug within the user's namespace","example":"my-image-workflow","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"title":{"type":"string","minLength":1,"maxLength":256,"description":"Human-readable workflow title","example":"My Image Generation Workflow","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"contents":{"type":"object","properties":{"name":{"type":"string","description":"Internal name of the workflow definition","example":"my-image-workflow","isRequired":true,"uniqueKey":"contents.name","typeLabel":"string"},"version":{"type":"string","description":"Workflow definition format version","example":"1.0.0","isRequired":true,"uniqueKey":"contents.version","typeLabel":"string"},"nodes":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"contents.nodes.additionalProperties.additionalProperties","typeLabel":"any"},"uniqueKey":"contents.nodes.additionalProperties","typeLabel":"object"},"description":"Workflow nodes keyed by node id","isRequired":true,"uniqueKey":"contents.nodes","typeLabel":"object"},"output":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"contents.output.additionalProperties","typeLabel":"string"},"description":"Output field mappings keyed by output name","isRequired":true,"uniqueKey":"contents.output","typeLabel":"object"},"schema":{"type":"object","properties":{"input":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"contents.schema.input.additionalProperties","typeLabel":"any"},"description":"Input fields schema","isRequired":true,"uniqueKey":"contents.schema.input","typeLabel":"object"},"output":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"contents.schema.output.additionalProperties","typeLabel":"any"},"description":"Output fields schema","isRequired":true,"uniqueKey":"contents.schema.output","typeLabel":"object"}},"required":["input","output"],"description":"Input/output schema for the workflow","isRequired":true,"uniqueKey":"contents.schema","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"contents.metadata.additionalProperties","typeLabel":"any"},"description":"Optional workflow metadata","uniqueKey":"contents.metadata","typeLabel":"object"}},"required":["name","version","nodes","output","schema"],"description":"The workflow definition/configuration object","example":{"name":"my-image-workflow","version":"1.0.0","nodes":{"node_a1b2c3":{"id":"node_a1b2c3","type":"run","app":"fal-ai/flux/dev","depends":[],"input":{"prompt":"$input.prompt"},"metadata":{"position":{"x":300,"y":100}}}},"output":{"image":"$node_a1b2c3.images.0.url"},"schema":{"input":{"prompt":{"type":"string"}},"output":{"image":{"type":"string"}}}},"isRequired":true,"uniqueKey":"contents","typeLabel":"object"},"is_public":{"type":"boolean","default":false,"description":"Whether the workflow is publicly visible","example":false,"uniqueKey":"is_public","typeLabel":"boolean"}},"required":["name","title","contents"],"description":"Request body for creating a new workflow","uniqueKey":"","typeLabel":"object"},"example":{"name":"my-image-workflow","title":"My Image Generation Workflow","is_public":false,"contents":{"name":"my-image-workflow","version":"1.0.0","nodes":{"node_a1b2c3":{"id":"node_a1b2c3","type":"run","app":"fal-ai/flux/dev","depends":[],"input":{"prompt":"$input.prompt"},"metadata":{"position":{"x":300,"y":100}}}},"output":{"image":"$node_a1b2c3.images.0.url"},"schema":{"input":{"prompt":{"type":"string"}},"output":{"image":{"type":"string"}}}}},"examples":{"Example":{"title":"Example","value":{"name":"my-image-workflow","title":"My Image Generation Workflow","is_public":false,"contents":{"name":"my-image-workflow","version":"1.0.0","nodes":{"node_a1b2c3":{"id":"node_a1b2c3","type":"run","app":"fal-ai/flux/dev","depends":[],"input":{"prompt":"$input.prompt"},"metadata":{"position":{"x":300,"y":100}}}},"output":{"image":"$node_a1b2c3.images.0.url"},"schema":{"input":{"prompt":{"type":"string"}},"output":{"image":{"type":"string"}}}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"706a172c-ad91-4f09-8387-5c2fdf49b410":{"description":"Successfully created workflow","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{"type":"object","properties":{"name":{"type":"string","description":"Unique workflow name/slug within the user's namespace","example":"my-image-workflow","isRequired":true,"uniqueKey":"workflow.name","typeLabel":"string"},"title":{"type":"string","description":"Human-readable workflow title","example":"My Image Generation Workflow","isRequired":true,"uniqueKey":"workflow.title","typeLabel":"string"},"user_nickname":{"type":"string","description":"Display name/username of the owner","example":"johndoe","isRequired":true,"uniqueKey":"workflow.user_nickname","typeLabel":"string"},"created_at":{"type":"string","description":"ISO8601 timestamp of workflow creation","example":"2024-01-15T10:30:00Z","isRequired":true,"uniqueKey":"workflow.created_at","typeLabel":"string"},"is_public":{"type":"boolean","description":"Whether the workflow is publicly visible","example":true,"isRequired":true,"uniqueKey":"workflow.is_public","typeLabel":"boolean"},"contents":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"workflow.contents.additionalProperties","typeLabel":"any"},"description":"The workflow definition/configuration object","example":{"nodes":{"node_a1b2c3":{"id":"node_a1b2c3","type":"model","app":"fal-ai/flux/dev","depends":[],"input":{"prompt":"$input.prompt"},"metadata":{"position":{"x":300,"y":100}}},"output":{"id":"output","type":"output","depends":["node_a1b2c3"],"fields":{"image":"$node_a1b2c3.images.0.url"},"metadata":{"position":{"x":600,"y":100}}}}},"isRequired":true,"uniqueKey":"workflow.contents","typeLabel":"object"}},"required":["name","title","user_nickname","created_at","is_public","contents"],"description":"The workflow details","example":{"name":"my-image-workflow","title":"My Image Generation Workflow","user_nickname":"johndoe","created_at":"2024-01-15T10:30:00Z","is_public":true,"contents":{"nodes":{"node_a1b2c3":{"id":"node_a1b2c3","type":"model","app":"fal-ai/flux/dev","depends":[],"input":{"prompt":"$input.prompt"},"metadata":{"position":{"x":300,"y":100}}},"output":{"id":"output","type":"output","depends":["node_a1b2c3"],"fields":{"image":"$node_a1b2c3.images.0.url"},"metadata":{"position":{"x":600,"y":100}}}}}},"isRequired":true,"uniqueKey":"workflow","typeLabel":"object"}},"required":["workflow"],"description":"Response containing a single workflow's details","uniqueKey":"","typeLabel":"object"},"example":{"workflow":{"name":"my-image-workflow","title":"My Image Generation Workflow","user_nickname":"johndoe","created_at":"2025-01-15T12:00:00Z","is_public":false,"contents":{"name":"my-image-workflow","version":"1.0.0","nodes":{"node_a1b2c3":{"id":"node_a1b2c3","type":"run","app":"fal-ai/flux/dev","depends":[],"input":{"prompt":"$input.prompt"},"metadata":{"position":{"x":300,"y":100}}}},"output":{"image":"$node_a1b2c3.images.0.url"},"schema":{"input":{"prompt":{"type":"string"}},"output":{"image":{"type":"string"}}}}}},"examples":{"Example":{"title":"Example","value":{"workflow":{"name":"my-image-workflow","title":"My Image Generation Workflow","user_nickname":"johndoe","created_at":"2025-01-15T12:00:00Z","is_public":false,"contents":{"name":"my-image-workflow","version":"1.0.0","nodes":{"node_a1b2c3":{"id":"node_a1b2c3","type":"run","app":"fal-ai/flux/dev","depends":[],"input":{"prompt":"$input.prompt"},"metadata":{"position":{"x":300,"y":100}}}},"output":{"image":"$node_a1b2c3.images.0.url"},"schema":{"input":{"prompt":{"type":"string"}},"output":{"image":{"type":"string"}}}}}}}},"exampleType":"examples"}},"exampleType":"examples"},"864a2276-edae-48f1-b615-a75faeea1ce1":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["authorization_error","validation_error","not_found","rate_limited","server_error","not_implemented"],"description":"The category of error that occurred","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs_url":{"type":"string","format":"uri","description":"Link to relevant documentation","uniqueKey":"error.docs_url","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier for debugging","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","message"],"description":"Error details","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"validation_error","message":"Invalid request parameters"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"validation_error","message":"Invalid request parameters"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ad554b3c-5986-431c-8aed-b64f8e2422f8":{"description":"Authentication required","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["authorization_error","validation_error","not_found","rate_limited","server_error","not_implemented"],"description":"The category of error that occurred","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs_url":{"type":"string","format":"uri","description":"Link to relevant documentation","uniqueKey":"error.docs_url","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier for debugging","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","message"],"description":"Error details","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"authorization_error","message":"Authentication required"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"authorization_error","message":"Authentication required"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1199cef5-baf7-4a8d-86ad-1a3fdb65ade4":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["authorization_error","validation_error","not_found","rate_limited","server_error","not_implemented"],"description":"The category of error that occurred","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs_url":{"type":"string","format":"uri","description":"Link to relevant documentation","uniqueKey":"error.docs_url","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier for debugging","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","message"],"description":"Error details","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"authorization_error","message":"Access denied"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"authorization_error","message":"Access denied"}}}},"exampleType":"examples"}},"exampleType":"examples"},"87f754a5-ec61-4604-8e1e-3ac7a73ed689":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["authorization_error","validation_error","not_found","rate_limited","server_error","not_implemented"],"description":"The category of error that occurred","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs_url":{"type":"string","format":"uri","description":"Link to relevant documentation","uniqueKey":"error.docs_url","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier for debugging","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","message"],"description":"Error details","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"rate_limited","message":"Rate limit exceeded"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"rate_limited","message":"Rate limit exceeded"}}}},"exampleType":"examples"}},"exampleType":"examples"},"55821304-bad8-4859-85c1-f5a73648a11d":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["authorization_error","validation_error","not_found","rate_limited","server_error","not_implemented"],"description":"The category of error that occurred","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs_url":{"type":"string","format":"uri","description":"Link to relevant documentation","uniqueKey":"error.docs_url","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier for debugging","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","message"],"description":"Error details","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"server_error","message":"An unexpected error occurred"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"server_error","message":"An unexpected error occurred"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"f88c56b7-c2ae-4be0-8423-0e29f334cede":{"serverlessApiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Key on the `SERVERLESS` preset, or any key whose permissions include the ones this API lists. Prefix it with \"Key \", e.g. Authorization: Key YOUR_API_KEY","scopes":[],"schemeName":"serverlessApiKey"}}},"servers":{"25a8d5d0-fddf-4164-bca5-9e0e15449f64":{"url":"https://api.fal.ai/v1","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Key on the `SERVERLESS` preset, or any key whose permissions include the ones this API lists. Prefix it with \"Key \", e.g. Authorization: Key YOUR_API_KEY","scopes":[],"schemeName":"serverlessApiKey"},"schema":{"title":"Authorization","type":"string","description":"Key on the `SERVERLESS` preset, or any key whose permissions include the ones this API lists. Prefix it with \"Key \", e.g. Authorization: Key YOUR_API_KEY","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"serverlessApiKey","name":"Authorization"}],"title":"serverlessApiKey"}]},"originalFileLocation":"api-reference/platform-apis/openapi/v1.json"},"subdomain":"fal-d8505a2e","siteName":"fal","title":"Create a workflow - fal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T19:12:41.109Z","originalFileLocation":"platform-apis/v1/workflows/create.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=\"light\"}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=\"Create a new workflow owned by the authenticated user. Authentication: Required. Common Use Cases: - Save a newly built workflow - Programmatically provision workflows Note: Workflow names must be unique within your namespace. Creating a workflow with a name you already use returns a 400 validation error. Required permissions: workflows:write. Key presets that include them: SERVERLESS, FULL. See key permissions.\">\u003cmeta data-mint-head name=\"application-name\" content=\"fal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_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=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a workflow - fal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new workflow owned by the authenticated user. Authentication: Required. Common Use Cases: - Save a newly built workflow - Programmatically provision workflows Note: Workflow names must be unique within your namespace. Creating a workflow with a name you already use returns a 400 validation error. Required permissions: workflows:write. Key presets that include them: SERVERLESS, FULL. See key permissions.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"fal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://fal.ai/docs/platform-apis/v1/workflows/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fal-d8505a2e.mintlify.site/docs/logo/light.svg\">\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=\"Create a workflow - fal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new workflow owned by the authenticated user. Authentication: Required. Common Use Cases: - Save a newly built workflow - Programmatically provision workflows Note: Workflow names must be unique within your namespace. Creating a workflow with a name you already use returns a 400 validation error. Required permissions: workflows:write. Key presets that include them: SERVERLESS, FULL. See key permissions.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fal-d8505a2e.mintlify.site/docs/logo/light.svg\">\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=\"/docs/mintlify-assets/_mintlify/favicons/fal-d8505a2e/cUEBujT4zfUs0Rxq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"fal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5718C0\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"kcN2RYfXHsfUeWlkX6-E32JdCXwUdHA5w5NIXr2xWTY\">\u003clink data-mint-head rel=\"canonical\" href=\"https://fal.ai/docs/platform-apis/v1/workflows/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/platform-apis/v1/workflows/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://fal.ai/#organization\",\"name\":\"fal\",\"legalName\":\"Features \u0026 Labels Inc.\",\"url\":\"https://fal.ai/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://fal.ai/apple-touch-icon.png\"},\"sameAs\":[\"https://discord.gg/fal-ai\",\"https://github.com/fal-ai\",\"https://www.reddit.com/r/fal/\",\"https://twitter.com/fal\",\"https://www.linkedin.com/company/features-and-labels/\",\"https://www.youtube.com/@Fal.AI.Official\",\"https://www.instagram.com/madeonfal\",\"https://www.tiktok.com/@madeonfal\"]},{\"@type\":\"WebSite\",\"@id\":\"https://fal.ai/docs#website\",\"name\":\"fal\",\"url\":\"https://fal.ai/docs\",\"publisher\":{\"@id\":\"https://fal.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://fal.ai/docs/platform-apis/v1/workflows/create#webpage\",\"url\":\"https://fal.ai/docs/platform-apis/v1/workflows/create\",\"name\":\"Create a workflow\",\"description\":\"Create a new workflow owned by the authenticated user. Authentication: Required. Common Use Cases: - Save a newly built workflow - Programmatically provision workflows Note: Workflow names must be unique within your namespace. Creating a workflow with a name you already use returns a 400 validation error. Required permissions: workflows:write. Key presets that include them: SERVERLESS, FULL. See key permissions.\",\"dateModified\":\"2026-10-13T19:12:41.109Z\",\"isPartOf\":{\"@id\":\"https://fal.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://fal.ai/docs/platform-apis/v1/workflows/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://fal.ai/docs/platform-apis/v1/workflows/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Endpoints\",\"item\":\"https://fal.ai/docs/api-reference/platform-apis/meta\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a workflow\",\"item\":\"https://fal.ai/docs/platform-apis/v1/workflows/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://fal.ai/docs/platform-apis/v1/workflows/create#apireference\",\"headline\":\"Create a workflow\",\"name\":\"Create a workflow\",\"description\":\"Create a new workflow owned by the authenticated user. Authentication: Required. Common Use Cases: - Save a newly built workflow - Programmatically provision workflows Note: Workflow names must be unique within your namespace. Creating a workflow with a name you already use returns a 400 validation error. Required permissions: workflows:write. Key presets that include them: SERVERLESS, FULL. See key permissions.\",\"url\":\"https://fal.ai/docs/platform-apis/v1/workflows/create\",\"mainEntityOfPage\":{\"@id\":\"https://fal.ai/docs/platform-apis/v1/workflows/create#webpage\"},\"image\":\"https://fal.ai/logo/light.svg\",\"dateModified\":\"2026-10-13T19:12:41.109Z\",\"publisher\":{\"@id\":\"https://fal.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://fal.ai/docs#website\"}}]}\u003c/script>","siteName":"fal","nav":{"global":{"anchors":[{"anchor":"Status","icon":"signal","href":"https://status.fal.ai/"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/fal-ai"},{"anchor":"Blog","icon":"newspaper","href":"https://blog.fal.ai/"}]},"tabs":[{"tab":"Documentation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fal-d8505a2e/images/icons/docs.svg","pages":[{"title":"Documentation","href":"/documentation"}]},{"tab":"Examples","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fal-d8505a2e/images/icons/grid-9.svg","pages":[{"title":"Examples","href":"/examples"}]},{"tab":"Model API Reference","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fal-d8505a2e/images/icons/ar-cube-1.svg","pages":[{"title":"Model API Reference","href":"/model-api-reference"}]},{"tab":"SDK Reference","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fal-d8505a2e/images/icons/code-brackets.svg","pages":[{"title":"SDK Reference","href":"/api-reference"}]},{"tab":"Inference API","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fal-d8505a2e/images/icons/file-json.svg","pages":[{"title":"Inference API","href":"/api-reference/inference-api"}]},{"tab":"Platform API","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fal-d8505a2e/images/icons/layers-three.svg","pages":[{"title":"Introduction to Platform APIs","sidebarTitle":"Introduction","href":"/api-reference/platform-apis"},{"title":"Authentication","href":"/api-reference/platform-apis/authentication"},{"title":"OpenAPI Schema","href":"/api-reference/platform-apis/openapi-schema"},{"group":"API Endpoints","pages":[{"title":"Platform Metadata","openapi":"GET /meta","href":"/api-reference/platform-apis/meta"},{"title":"Platform APIs for Models","href":"/api-reference/platform-apis/for-models"},{"title":"Model search","deprecated":null,"version":null,"sidebarTitle":"Model Search","openapi":"/api-reference/platform-apis/openapi/v1.json get /models","href":"/platform-apis/v1/models"},{"title":"Pricing","deprecated":null,"version":null,"sidebarTitle":"Pricing","openapi":"/api-reference/platform-apis/openapi/v1.json get /models/pricing","href":"/platform-apis/v1/models/pricing"},{"title":"Estimate cost","deprecated":null,"version":null,"sidebarTitle":"Estimate Cost","openapi":"/api-reference/platform-apis/openapi/v1.json post /models/pricing/estimate","href":"/platform-apis/v1/models/pricing/estimate"},{"title":"Usage","deprecated":null,"version":null,"sidebarTitle":"Usage","openapi":"/api-reference/platform-apis/openapi/v1.json get /models/usage","href":"/platform-apis/v1/models/usage"},{"title":"Billing Events","deprecated":null,"version":null,"sidebarTitle":"Billing Events","openapi":"/api-reference/platform-apis/openapi/v1.json get /models/billing-events","href":"/platform-apis/v1/models/billing-events"},{"title":"Analytics","deprecated":null,"version":null,"sidebarTitle":"Analytics","openapi":"/api-reference/platform-apis/openapi/v1.json get /models/analytics","href":"/platform-apis/v1/models/analytics"},{"title":"List requests by endpoint(s)","deprecated":null,"version":null,"sidebarTitle":"List Requests by Endpoint","openapi":"/api-reference/platform-apis/openapi/v1.json get /models/requests/by-endpoint","href":"/platform-apis/v1/models/requests/by-endpoint"},{"title":"Delete request payloads","deprecated":null,"version":null,"sidebarTitle":"Delete Request Payloads","openapi":"/api-reference/platform-apis/openapi/v1.json delete /models/requests/{request_id}/payloads","href":"/platform-apis/v1/models/requests/payloads"},{"title":"Platform APIs for Assets","href":"/api-reference/platform-apis/for-assets"},{"title":"Browse assets","deprecated":null,"version":null,"sidebarTitle":"Browse Assets","openapi":"/api-reference/platform-apis/openapi/v1.json get /assets","href":"/platform-apis/v1/assets"},{"title":"Upload asset","deprecated":null,"version":null,"sidebarTitle":"Upload Asset","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/uploads","href":"/platform-apis/v1/assets/uploads"},{"title":"Get asset","deprecated":null,"version":null,"sidebarTitle":"Get Asset","openapi":"/api-reference/platform-apis/openapi/v1.json get /assets/{asset_id}","href":"/platform-apis/v1/assets/get"},{"title":"Favorite asset","deprecated":null,"version":null,"sidebarTitle":"Favorite Asset","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/favorite","href":"/platform-apis/v1/assets/favorite"},{"title":"Unfavorite asset","deprecated":null,"version":null,"sidebarTitle":"Unfavorite Asset","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/unfavorite","href":"/platform-apis/v1/assets/unfavorite"},{"title":"List asset collections","deprecated":null,"version":null,"sidebarTitle":"List Asset Collections","openapi":"/api-reference/platform-apis/openapi/v1.json get /assets/collections","href":"/platform-apis/v1/assets/collections"},{"title":"Create asset collection","deprecated":null,"version":null,"sidebarTitle":"Create Asset Collection","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/collections","href":"/platform-apis/v1/assets/collections/create"},{"title":"Get asset collection","deprecated":null,"version":null,"sidebarTitle":"Get Asset Collection","openapi":"/api-reference/platform-apis/openapi/v1.json get /assets/collections/{collection_id}","href":"/platform-apis/v1/assets/collections/get"},{"title":"Update asset collection","deprecated":null,"version":null,"sidebarTitle":"Update Asset Collection","openapi":"/api-reference/platform-apis/openapi/v1.json patch /assets/collections/{collection_id}","href":"/platform-apis/v1/assets/collections/update"},{"title":"Delete asset collection","deprecated":null,"version":null,"sidebarTitle":"Delete Asset Collection","openapi":"/api-reference/platform-apis/openapi/v1.json delete /assets/collections/{collection_id}","href":"/platform-apis/v1/assets/collections/delete"},{"title":"Favorite asset collection","deprecated":null,"version":null,"sidebarTitle":"Favorite Asset Collection","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/collections/{collection_id}/favorite","href":"/platform-apis/v1/assets/collections/favorite"},{"title":"Unfavorite asset collection","deprecated":null,"version":null,"sidebarTitle":"Unfavorite Asset Collection","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/collections/{collection_id}/unfavorite","href":"/platform-apis/v1/assets/collections/unfavorite"},{"title":"Browse assets in a collection","deprecated":null,"version":null,"sidebarTitle":"Browse Collection Assets","openapi":"/api-reference/platform-apis/openapi/v1.json get /assets/collections/{collection_id}/assets","href":"/platform-apis/v1/assets/collections/assets"},{"title":"Add asset to collection","deprecated":null,"version":null,"sidebarTitle":"Add Asset to Collection","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/collections/{collection_id}/assets","href":"/platform-apis/v1/assets/collections/assets/add"},{"title":"Remove asset from collection","deprecated":null,"version":null,"sidebarTitle":"Remove Asset from Collection","openapi":"/api-reference/platform-apis/openapi/v1.json delete /assets/collections/{collection_id}/assets","href":"/platform-apis/v1/assets/collections/assets/remove"},{"title":"List asset characters","deprecated":null,"version":null,"sidebarTitle":"List Asset Characters","openapi":"/api-reference/platform-apis/openapi/v1.json get /assets/characters","href":"/platform-apis/v1/assets/characters"},{"title":"Create asset character","deprecated":null,"version":null,"sidebarTitle":"Create Asset Character","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/characters","href":"/platform-apis/v1/assets/characters/create"},{"title":"Get asset character","deprecated":null,"version":null,"sidebarTitle":"Get Asset Character","openapi":"/api-reference/platform-apis/openapi/v1.json get /assets/characters/{character_id}","href":"/platform-apis/v1/assets/characters/get"},{"title":"Update asset character","deprecated":null,"version":null,"sidebarTitle":"Update Asset Character","openapi":"/api-reference/platform-apis/openapi/v1.json patch /assets/characters/{character_id}","href":"/platform-apis/v1/assets/characters/update"},{"title":"Delete asset character","deprecated":null,"version":null,"sidebarTitle":"Delete Asset Character","openapi":"/api-reference/platform-apis/openapi/v1.json delete /assets/characters/{character_id}","href":"/platform-apis/v1/assets/characters/delete"},{"title":"Favorite asset character","deprecated":null,"version":null,"sidebarTitle":"Favorite Asset Character","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/characters/{character_id}/favorite","href":"/platform-apis/v1/assets/characters/favorite"},{"title":"Unfavorite asset character","deprecated":null,"version":null,"sidebarTitle":"Unfavorite Asset Character","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/characters/{character_id}/unfavorite","href":"/platform-apis/v1/assets/characters/unfavorite"},{"title":"List asset tags","deprecated":null,"version":null,"sidebarTitle":"List Asset Tags","openapi":"/api-reference/platform-apis/openapi/v1.json get /assets/tags","href":"/platform-apis/v1/assets/tags"},{"title":"Create asset tag","deprecated":null,"version":null,"sidebarTitle":"Create Asset Tag","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/tags","href":"/platform-apis/v1/assets/tags/create"},{"title":"Set tags for an asset","deprecated":null,"version":null,"sidebarTitle":"Set Asset Tags","openapi":"/api-reference/platform-apis/openapi/v1.json put /assets/tags","href":"/platform-apis/v1/assets/tags/set-for-asset"},{"title":"Update asset tag","deprecated":null,"version":null,"sidebarTitle":"Update Asset Tag","openapi":"/api-reference/platform-apis/openapi/v1.json patch /assets/tags/{tag_id}","href":"/platform-apis/v1/assets/tags/update"},{"title":"Delete asset tag","deprecated":null,"version":null,"sidebarTitle":"Delete Asset Tag","openapi":"/api-reference/platform-apis/openapi/v1.json delete /assets/tags/{tag_id}","href":"/platform-apis/v1/assets/tags/delete"},{"title":"List tags for an asset","deprecated":null,"version":null,"sidebarTitle":"List Asset Tags","openapi":"/api-reference/platform-apis/openapi/v1.json get /assets/{asset_id}/tags","href":"/platform-apis/v1/assets/tags/list-for-asset"},{"title":"Assign tag to asset","deprecated":null,"version":null,"sidebarTitle":"Assign Asset Tag","openapi":"/api-reference/platform-apis/openapi/v1.json post /assets/tags/{tag_id}/assign","href":"/platform-apis/v1/assets/tags/assign"},{"title":"Unassign tag from asset","deprecated":null,"version":null,"sidebarTitle":"Unassign Asset Tag","openapi":"/api-reference/platform-apis/openapi/v1.json delete /assets/tags/{tag_id}/assign","href":"/platform-apis/v1/assets/tags/unassign"},{"title":"Platform APIs for Storage","href":"/api-reference/platform-apis/for-storage"},{"title":"Get file ACL","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/platform-apis/openapi/v1.json get /storage/files/acl","href":"/platform-apis/v1/storage/files/acl/get"},{"title":"Set file ACL","deprecated":null,"version":null,"sidebarTitle":"Set","openapi":"/api-reference/platform-apis/openapi/v1.json put /storage/files/acl","href":"/platform-apis/v1/storage/files/acl/set"},{"title":"Sign file URL","deprecated":null,"version":null,"sidebarTitle":"Sign","openapi":"/api-reference/platform-apis/openapi/v1.json post /storage/files/sign","href":"/platform-apis/v1/storage/files/sign"},{"title":"Get storage settings","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/platform-apis/openapi/v1.json get /storage/settings","href":"/platform-apis/v1/storage/settings/get"},{"title":"Update storage settings","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/platform-apis/openapi/v1.json put /storage/settings","href":"/platform-apis/v1/storage/settings/update"},{"title":"Platform APIs for Workflows","href":"/api-reference/platform-apis/for-workflows"},{"title":"List user workflows","description":"\nList workflows for the authenticated user with optional search and filtering.\n\n**Features:**\n- Paginated results with cursor-based pagination\n- Search by workflow name or title\n- Filter by model endpoints used in the workflow\n\n**Authentication:** Required. Returns only workflows owned by the authenticated user.\n\n**Common Use Cases:**\n- Display user's workflow library\n- Search for specific workflows\n- Find workflows using particular models\n \n\n**Required permissions:** `workflows:read`. Key presets that include them: `API`, `SERVERLESS`, `READONLY`, `FULL`. See [key permissions](https://fal.ai/docs/documentation/model-apis/authentication/key-based#permissions).","deprecated":null,"version":null,"sidebarTitle":"List User Workflows","openapi":"/api-reference/platform-apis/openapi/v1.json get /workflows","href":"/platform-apis/v1/workflows"},{"title":"Create a workflow","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/platform-apis/openapi/v1.json post /workflows","href":"/platform-apis/v1/workflows/create"},{"title":"Get workflow details","description":"\nGet detailed information about a specific workflow, including its full contents/definition.\n\n**Authentication:** Required.\n\n**Common Use Cases:**\n- Load a workflow for editing\n- View workflow configuration\n- Export workflow definition\n \n\n**Required permissions:** `workflows:read`. Key presets that include them: `API`, `SERVERLESS`, `READONLY`, `FULL`. See [key permissions](https://fal.ai/docs/documentation/model-apis/authentication/key-based#permissions).","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/platform-apis/openapi/v1.json get /workflows/{username}/{workflow_name}","href":"/platform-apis/v1/workflows/get"},{"title":"Platform APIs for Serverless","href":"/api-reference/platform-apis/for-serverless"},{"title":"Queue Size","deprecated":null,"version":null,"sidebarTitle":"Queue Size","openapi":"/api-reference/platform-apis/openapi/v1.json get /serverless/apps/{owner}/{name}/queue","href":"/platform-apis/v1/serverless/apps/queue"},{"title":"Flush Application Queue","deprecated":null,"version":null,"sidebarTitle":"Flush queue","openapi":"/api-reference/platform-apis/openapi/v1.json delete /serverless/apps/{owner}/{name}/queue","href":"/platform-apis/v1/serverless/apps/flush-queue"},{"title":"Application Revisions","deprecated":null,"version":null,"sidebarTitle":"Application Revisions","openapi":"/api-reference/platform-apis/openapi/v1.json get /serverless/apps/{owner}/{name}/revisions","href":"/platform-apis/v1/serverless/apps/revisions"},{"title":"Metrics","deprecated":null,"version":null,"sidebarTitle":"Prometheus Metrics","openapi":"/api-reference/platform-apis/openapi/v1.json get /serverless/metrics","href":"/platform-apis/v1/serverless/metrics"},{"title":"Analytics","deprecated":null,"version":null,"sidebarTitle":"Analytics","openapi":"/api-reference/platform-apis/openapi/v1.json get /serverless/analytics","href":"/platform-apis/v1/serverless/analytics"},{"title":"Usage","deprecated":null,"version":null,"sidebarTitle":"Usage","openapi":"/api-reference/platform-apis/openapi/v1.json get /serverless/usage","href":"/platform-apis/v1/serverless/usage"},{"title":"List requests by endpoint(s)","deprecated":null,"version":null,"sidebarTitle":"List Requests by Endpoint","openapi":"/api-reference/platform-apis/openapi/v1.json get /serverless/requests/by-endpoint","href":"/platform-apis/v1/serverless/requests/by-endpoint"},{"title":"List files (root)","deprecated":null,"version":null,"sidebarTitle":"List Files (Root)","openapi":"/api-reference/platform-apis/openapi/v1.json get /serverless/files/list","href":"/platform-apis/v1/serverless/files/list"},{"title":"List files (directory)","deprecated":null,"version":null,"sidebarTitle":"Directory","openapi":"/api-reference/platform-apis/openapi/v1.json get /serverless/files/list/{dir}","href":"/platform-apis/v1/serverless/files/list/directory"},{"title":"Download file","deprecated":null,"version":null,"sidebarTitle":"Download","openapi":"/api-reference/platform-apis/openapi/v1.json get /serverless/files/file/{file}","href":"/platform-apis/v1/serverless/files/file/download"},{"title":"Upload file from URL","deprecated":null,"version":null,"sidebarTitle":"Upload from url","openapi":"/api-reference/platform-apis/openapi/v1.json post /serverless/files/file/url/{file}","href":"/platform-apis/v1/serverless/files/file/upload-from-url"},{"title":"Upload local file (multipart/form-data)","deprecated":null,"version":null,"sidebarTitle":"Upload local","openapi":"/api-reference/platform-apis/openapi/v1.json post /serverless/files/file/local/{target_path}","href":"/platform-apis/v1/serverless/files/file/upload-local"},{"title":"Logs history (paginated)","deprecated":null,"version":null,"sidebarTitle":"Logs History","openapi":"/api-reference/platform-apis/openapi/v1.json post /serverless/logs/history","href":"/platform-apis/v1/serverless/logs/history"},{"title":"Logs stream (SSE)","deprecated":null,"version":null,"sidebarTitle":"Logs Stream (SSE)","openapi":"/api-reference/platform-apis/openapi/v1.json post /serverless/logs/stream","href":"/platform-apis/v1/serverless/logs/stream"},{"title":"Platform APIs for Compute","href":"/api-reference/platform-apis/for-compute"},{"title":"List Compute Instances","deprecated":null,"version":null,"sidebarTitle":"List Compute Instances","openapi":"/api-reference/platform-apis/openapi/v1.json get /compute/instances","href":"/platform-apis/v1/compute/instances/list"},{"title":"Get Compute Instance","deprecated":null,"version":null,"sidebarTitle":"Get Compute Instance","openapi":"/api-reference/platform-apis/openapi/v1.json get /compute/instances/{id}","href":"/platform-apis/v1/compute/instances/get"},{"title":"Delete Compute Instance","deprecated":null,"version":null,"sidebarTitle":"Delete Compute Instance","openapi":"/api-reference/platform-apis/openapi/v1.json delete /compute/instances/{id}","href":"/platform-apis/v1/compute/instances/delete"},{"title":"Platform APIs for Keys","href":"/api-reference/platform-apis/for-keys"},{"title":"List API Keys","deprecated":null,"version":null,"sidebarTitle":"List API Keys","openapi":"/api-reference/platform-apis/openapi/v1.json get /keys","href":"/platform-apis/v1/keys/list"},{"title":"Create API Key","deprecated":null,"version":null,"sidebarTitle":"Create API Key","openapi":"/api-reference/platform-apis/openapi/v1.json post /keys","href":"/platform-apis/v1/keys/create"},{"title":"Revoke API Key","deprecated":null,"version":null,"sidebarTitle":"Revoke API Key","openapi":"/api-reference/platform-apis/openapi/v1.json post /keys/{key_id}/revoke","href":"/platform-apis/v1/keys/revoke"},{"title":"Platform APIs for Accounts","href":"/api-reference/platform-apis/for-accounts"},{"title":"Account Billing","deprecated":null,"version":null,"sidebarTitle":"Account Billing","openapi":"/api-reference/platform-apis/openapi/v1.json get /account/billing","href":"/platform-apis/v1/account/billing"},{"title":"FOCUS Report","deprecated":null,"version":null,"sidebarTitle":"FOCUS Report","openapi":"/api-reference/platform-apis/openapi/v1.json get /account/focus","href":"/platform-apis/v1/account/focus"},{"title":"Model Access Controls Report","deprecated":null,"version":null,"sidebarTitle":"Model Access Controls","openapi":"/api-reference/platform-apis/openapi/v1.json get /account/model-access-controls","href":"/platform-apis/v1/account/model-access-controls"},{"title":"Platform APIs for Organizations","href":"/api-reference/platform-apis/for-organization"},{"title":"Organization Teams","deprecated":null,"version":null,"sidebarTitle":"Organization Teams","openapi":"/api-reference/platform-apis/openapi/v1.json get /organization/teams","href":"/platform-apis/v1/organization/teams"},{"title":"Organization Usage","deprecated":null,"version":null,"sidebarTitle":"Organization Usage","openapi":"/api-reference/platform-apis/openapi/v1.json get /organization/usage","href":"/platform-apis/v1/organization/usage"},{"title":"Organization FOCUS Report","deprecated":null,"version":null,"sidebarTitle":"Organization FOCUS Report","openapi":"/api-reference/platform-apis/openapi/v1.json get /organization/focus","href":"/platform-apis/v1/organization/focus"},{"title":"Organization Billing Events","deprecated":null,"version":null,"sidebarTitle":"Organization Billing Events","openapi":"/api-reference/platform-apis/openapi/v1.json get /organization/billing-events","href":"/platform-apis/v1/organization/billing-events"}]}]},{"tab":"Changelog","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fal-d8505a2e/images/icons/clock.svg","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Create a workflow - fal","buildId":"dpl_CEsowfH15TDzsBT2BFbX312Be4Ct","deploymentId":"dpl_CEsowfH15TDzsBT2BFbX312Be4Ct","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CqF8gK93.js","utils-Cfy66YIG.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-cadwlSiW.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BOSHrB55.js","snippetPresets-DuIJ6Tui.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CGry0O4L.js","ApiExamples-BByZ-4eP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DWD4BnjW.js","shallow-Bo7p10ck.js","getApiPlaygroundDisplay-C7mFZ2Cg.js","CodeSnippet-DrT8v8gt.js","CodeSnippets-DGLmtlSm.js","getPastedJson-DXZGgv-T.js","icon-DMjuBky8.js","MethodPill-C_c9VvF7.js","DuplicateIcon-D8Zrb3hW.js","createIcon-eYWxX-Sl.js","DynamicMarkdown-DORtg_Te.js","SectionHeading-DE1W9Ett.js","axios-vUo_bRtp.js","Markdown-BvSqw8zR.js","clsx-B-KWekQe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CTE3eEYy.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ba-QebqG.js"]}