Create a new flow execution and start workflow processing.
This endpoint creates a flow execution record and attempts to start the associated
workflow processing. The execution is created with status ‘queued’ and atomically
promoted to ‘running’ if the organization’s concurrency limit allows.
When the organization’s credits are exhausted, the execution is still created
(201) but held with status ‘pending_payment’ instead of being processed: no
workflow starts, and the execution is released back to ‘queued’ automatically
once credits are restored. Check the response’s status field to detect this.
Context:
Flow executions represent runtime instances of flow definitions
Each execution is isolated and maintains its own state
Input data must conform to the flow’s input schema
Executions are scoped to the user’s organization
WebSocket notifications are sent on creation for real-time updates
Input Validation:
Input data is validated against the flow’s input task schema
Validation occurs before database record creation or workflow start
Invalid input returns 400 Bad Request with detailed error messages
Validation errors include field location, type, and specific issue
No flow execution record is created if validation fails
Idempotency:
The optional Idempotency-Key header must be a ULID; a malformed key returns 422
and nothing is created
The key in effect (sent, or generated when omitted) is returned as idempotency_key
Repeating a request on the same flow with the same key returns 201 with the original
execution in its current state (its status may have changed since it was created, and
is deleted if it was deleted), even if input differs; no new execution is created,
started or queued
Keys are scoped per flow and never expire
Execution Flow:
Validates flow exists and user has access
Validates input data against flow’s input schema
Creates execution record in database
Starts workflow processing asynchronously
Sends WebSocket notification to connected clients
Returns immediately (does not wait for completion)
Optional key that makes this request safe to retry. Must be a ULID: 26 upper-case Crockford base32 characters, e.g. 01ARZ3NDEKTSV4RRFFQ69G5FAV. Keys are scoped to the flow: if an execution of this flow with this key already exists, that execution is returned with 201 in its current state (its status may have changed since it was created, and is deleted if it was deleted) and no new execution is created, started or queued, whatever input the repeat carries. The same key on a different flow creates a separate execution. Keys never expire. If omitted, super.AI generates one. The key in effect is returned as idempotency_key. A malformed key returns 422 and creates nothing.
Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:
"01ARZ3NDEKTSV4RRFFQ69G5FAV"
Body
application/json
Request payload for creating a new flow execution.
This model defines the required data to start a new flow execution.
The input schema must match the flow definition's expected input structure.
UUID of the flow definition to execute. Must be a valid, active flow accessible to your organization. The flow defines the workflow structure and task sequence.
Input data for the flow execution. Schema is flow-specific. Common patterns: - Document processing: {'file_key': 'path/to/file.pdf'} - Data processing: {'document_url': 'gs://bucket/file.csv'} - Email processing: {'message_id': 'msg_123', 'attachments': []} Refer to flow definition for exact schema requirements.
The task name of the input task that is firing this execution. Required when the flow has multiple input trigger tasks — omitting it will result in a validation error. For single-input-task flows this field is optional, but if provided it must exactly match the flow's only input task name; a mismatch returns a 400 error.
Example:
"receive_email"
Response
Flow execution created and started successfully
Response model for flow execution operations.
Represents a single flow execution instance with its current state and metadata.
Flow executions are runtime instances of flow definitions that process input data
through a series of tasks defined in the flow's workflow.
Version number of the flow definition used for this execution. Execution continues on the same version even if flow is updated. Ensures consistency throughout execution lifecycle.
Input data provided when execution was created. Schema is defined by the flow definition. Commonly includes: file_key, document_url, or custom parameters. Structure varies by flow type.
Current execution status. Possible values: 'queued', 'running', 'completed', 'failed', 'deleted', 'stale', 'edited', 'awaiting_input', 'cancel_requested', 'cancelled', 'pending_payment'. Status transitions: queued → running → completed/failed. 'pending_payment' means the execution is held until the organization's credits are restored, then released back to 'queued' automatically.
Idempotency key this execution was created with: the Idempotency-Key request header when the caller sent one, otherwise a ULID generated by super.AI. Sending a create request for the same flow with this key again returns this execution with 201, in its current state, instead of creating or starting a new one. Null only for executions created before idempotency keys existed.
UUID of the pricing config active when this execution was created or re-executed. References the default config if no org-specific config existed at that time. None for executions created before pricing config tracking was introduced.
Executor name of the trigger that fired this execution (e.g., 'receive_file'). Set for multi-input flows; None for single-input-task flows.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SuperAI Flows","description":"Build reliable, scalable workflows that orchestrate AI models, data processing, and business logic through a simple API.","colors":{"primary":"#7443ff","light":"#9775f7","dark":"#6c40f5"},"logo":{"light":"https://mintcdn.com/superai-flows-docs/mOFmLJuUNWWCPrgW/logo/light.svg?fit=max\u0026auto=format\u0026n=mOFmLJuUNWWCPrgW\u0026q=85\u0026s=763a91d73e6886f99fbebba85459ee15","dark":"https://mintcdn.com/superai-flows-docs/mOFmLJuUNWWCPrgW/logo/dark.svg?fit=max\u0026auto=format\u0026n=mOFmLJuUNWWCPrgW\u0026q=85\u0026s=5e03ccaedeb7b9890d260cd5f28ba690","href":"https://flows.super.ai"},"favicon":"https://mintcdn.com/superai-flows-docs/mOFmLJuUNWWCPrgW/favicon.png?fit=max\u0026auto=format\u0026n=mOFmLJuUNWWCPrgW\u0026q=85\u0026s=a54a72f5610b7af45f895302bd9fec95","navbar":{"links":[{"href":"mailto:support@super.ai","label":"Support"},{"href":"https://status.super.ai","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://flows.super.ai"}},"footer":{"socials":{"website":"https://super.ai","x":"https://x.com/mysuperai","linkedin":"https://www.linkedin.com/company/mysuperai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"superai-flows-docs","hasAudioNarration":false,"actualSubdomain":"superai-flows-docs","customDomains":["docs.flows.super.ai"],"gitSource":{"type":"github","owner":"mysuperai","repo":"superai-flows-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"4c020797-e5c5-4927-8e18-f9ead2828ae7","liveDeploymentHistoryId":"6adb511a124faf20fe6181b8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb511a124faf20fe6181b8"},"entitlements":{},"buildId":"6adb511a124faf20fe6181b8","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":159},{"language":"default","tag":"Endpoints","count":155},{"language":"default","tag":"integrations","count":37},{"language":"default","tag":"flows","count":31},{"language":"default","tag":"organizations","count":15},{"language":"default","tag":"plugins","count":11},{"language":"default","tag":"auth","count":9},{"language":"default","tag":"service-accounts","count":9},{"language":"default","tag":"flow-executions","count":8},{"language":"default","tag":"human-review-tasks","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/flow-executions/create-and-start-a-flow-execution","slug":"/api-reference/flow-executions/create-and-start-a-flow-execution","pageMetadata":{"title":"Create and start a flow execution","description":"Create a new flow execution and start workflow processing.\n\nThis endpoint creates a flow execution record and attempts to start the associated\nworkflow processing. The execution is created with status 'queued' and atomically\npromoted to 'running' if the organization's concurrency limit allows.\n\nWhen the organization's credits are exhausted, the execution is still created\n(201) but held with status 'pending_payment' instead of being processed: no\nworkflow starts, and the execution is released back to 'queued' automatically\nonce credits are restored. Check the response's `status` field to detect this.\n\nContext:\n - Flow executions represent runtime instances of flow definitions\n - Each execution is isolated and maintains its own state\n - Input data must conform to the flow's input schema\n - Executions are scoped to the user's organization\n - WebSocket notifications are sent on creation for real-time updates\n\nInput Validation:\n - Input data is validated against the flow's input task schema\n - Validation occurs before database record creation or workflow start\n - Invalid input returns 400 Bad Request with detailed error messages\n - Validation errors include field location, type, and specific issue\n - No flow execution record is created if validation fails\n\nIdempotency:\n - The optional `Idempotency-Key` header must be a ULID; a malformed key returns 422\n and nothing is created\n - The key in effect (sent, or generated when omitted) is returned as `idempotency_key`\n - Repeating a request on the same flow with the same key returns 201 with the original\n execution in its current state (its `status` may have changed since it was created, and\n is `deleted` if it was deleted), even if `input` differs; no new execution is created,\n started or queued\n - Keys are scoped per flow and never expire\n\nExecution Flow:\n 1. Validates flow exists and user has access\n 2. Validates input data against flow's input schema\n 3. Creates execution record in database\n 4. Starts workflow processing asynchronously\n 5. Sends WebSocket notification to connected clients\n 6. Returns immediately (does not wait for completion)\n\nPerformance Notes:\n - Response time: \u003c 200ms (workflow starts asynchronously)\n - Does not block on workflow completion\n - WebSocket notifications sent in background task\n\nUse Cases:\n - Trigger flow execution from UI dashboard\n - Automated flow execution via API integration\n - Batch processing of multiple documents\n - Event-driven workflow automation\n\nRelated Endpoints:\n - GET /flow-executions/{id} - Check execution status\n - GET /flow-executions - List all executions for a flow\n - POST /flow-executions/{id}/execute - Re-execute failed execution","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flow-executions","href":"/api-reference/flow-executions/create-and-start-a-flow-execution","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 code: \"code\",\n li: \"li\",\n ol: \"ol\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Create a new flow execution and start workflow processing.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint creates a flow execution record and attempts to start the associated\\nworkflow processing. The execution is created with status ‘queued’ and atomically\\npromoted to ‘running’ if the organization’s concurrency limit allows.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"When the organization’s credits are exhausted, the execution is still created\\n(201) but held with status ‘pending_payment’ instead of being processed: no\\nworkflow starts, and the execution is released back to ‘queued’ automatically\\nonce credits are restored. Check the response’s \", _jsx(_components.code, {\n children: \"status\"\n }), \" field to detect this.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Context:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Flow executions represent runtime instances of flow definitions\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Each execution is isolated and maintains its own state\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Input data must conform to the flow’s input schema\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Executions are scoped to the user’s organization\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"WebSocket notifications are sent on creation for real-time updates\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Input Validation:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Input data is validated against the flow’s input task schema\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Validation occurs before database record creation or workflow start\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Invalid input returns 400 Bad Request with detailed error messages\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Validation errors include field location, type, and specific issue\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"No flow execution record is created if validation fails\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Idempotency:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"The optional \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \" header must be a ULID; a malformed key returns 422\\nand nothing is created\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"The key in effect (sent, or generated when omitted) is returned as \", _jsx(_components.code, {\n children: \"idempotency_key\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Repeating a request on the same flow with the same key returns 201 with the original\\nexecution in its current state (its \", _jsx(_components.code, {\n children: \"status\"\n }), \" may have changed since it was created, and\\nis \", _jsx(_components.code, {\n children: \"deleted\"\n }), \" if it was deleted), even if \", _jsx(_components.code, {\n children: \"input\"\n }), \" differs; no new execution is created,\\nstarted or queued\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Keys are scoped per flow and never expire\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Execution Flow:\"\n }), \"\\n\", _jsxs(_components.ol, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Validates flow exists and user has access\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Validates input data against flow’s input schema\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Creates execution record in database\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Starts workflow processing asynchronously\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Sends WebSocket notification to connected clients\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Returns immediately (does not wait for completion)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Performance Notes:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Response time: \u003c 200ms (workflow starts asynchronously)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Does not block on workflow completion\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"WebSocket notifications sent in background task\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Use Cases:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Trigger flow execution from UI dashboard\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Automated flow execution via API integration\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Batch processing of multiple documents\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Event-driven workflow automation\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Related Endpoints:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"GET /flow-executions/\", \" - Check execution status\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"GET /flow-executions - List all executions for a flow\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"POST /flow-executions/\", \"/execute - Re-execute failed execution\"]\n }), \"\\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 and start a flow execution","description":"Create a new flow execution and start workflow processing.\n\nThis endpoint creates a flow execution record and attempts to start the associated\nworkflow processing. The execution is created with status 'queued' and atomically\npromoted to 'running' if the organization's concurrency limit allows.\n\nWhen the organization's credits are exhausted, the execution is still created\n(201) but held with status 'pending_payment' instead of being processed: no\nworkflow starts, and the execution is released back to 'queued' automatically\nonce credits are restored. Check the response's `status` field to detect this.\n\nContext:\n - Flow executions represent runtime instances of flow definitions\n - Each execution is isolated and maintains its own state\n - Input data must conform to the flow's input schema\n - Executions are scoped to the user's organization\n - WebSocket notifications are sent on creation for real-time updates\n\nInput Validation:\n - Input data is validated against the flow's input task schema\n - Validation occurs before database record creation or workflow start\n - Invalid input returns 400 Bad Request with detailed error messages\n - Validation errors include field location, type, and specific issue\n - No flow execution record is created if validation fails\n\nIdempotency:\n - The optional `Idempotency-Key` header must be a ULID; a malformed key returns 422\n and nothing is created\n - The key in effect (sent, or generated when omitted) is returned as `idempotency_key`\n - Repeating a request on the same flow with the same key returns 201 with the original\n execution in its current state (its `status` may have changed since it was created, and\n is `deleted` if it was deleted), even if `input` differs; no new execution is created,\n started or queued\n - Keys are scoped per flow and never expire\n\nExecution Flow:\n 1. Validates flow exists and user has access\n 2. Validates input data against flow's input schema\n 3. Creates execution record in database\n 4. Starts workflow processing asynchronously\n 5. Sends WebSocket notification to connected clients\n 6. Returns immediately (does not wait for completion)\n\nPerformance Notes:\n - Response time: \u003c 200ms (workflow starts asynchronously)\n - Does not block on workflow completion\n - WebSocket notifications sent in background task\n\nUse Cases:\n - Trigger flow execution from UI dashboard\n - Automated flow execution via API integration\n - Batch processing of multiple documents\n - Event-driven workflow automation\n\nRelated Endpoints:\n - GET /flow-executions/{id} - Check execution status\n - GET /flow-executions - List all executions for a flow\n - POST /flow-executions/{id}/execute - Re-execute failed execution","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flow-executions","href":"/api-reference/flow-executions/create-and-start-a-flow-execution","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create a new flow execution and start workflow processing.\n\nThis endpoint creates a flow execution record and attempts to start the associated\nworkflow processing. The execution is created with status 'queued' and atomically\npromoted to 'running' if the organization's concurrency limit allows.\n\nWhen the organization's credits are exhausted, the execution is still created\n(201) but held with status 'pending_payment' instead of being processed: no\nworkflow starts, and the execution is released back to 'queued' automatically\nonce credits are restored. Check the response's `status` field to detect this.\n\nContext:\n - Flow executions represent runtime instances of flow definitions\n - Each execution is isolated and maintains its own state\n - Input data must conform to the flow's input schema\n - Executions are scoped to the user's organization\n - WebSocket notifications are sent on creation for real-time updates\n\nInput Validation:\n - Input data is validated against the flow's input task schema\n - Validation occurs before database record creation or workflow start\n - Invalid input returns 400 Bad Request with detailed error messages\n - Validation errors include field location, type, and specific issue\n - No flow execution record is created if validation fails\n\nIdempotency:\n - The optional `Idempotency-Key` header must be a ULID; a malformed key returns 422\n and nothing is created\n - The key in effect (sent, or generated when omitted) is returned as `idempotency_key`\n - Repeating a request on the same flow with the same key returns 201 with the original\n execution in its current state (its `status` may have changed since it was created, and\n is `deleted` if it was deleted), even if `input` differs; no new execution is created,\n started or queued\n - Keys are scoped per flow and never expire\n\nExecution Flow:\n 1. Validates flow exists and user has access\n 2. Validates input data against flow's input schema\n 3. Creates execution record in database\n 4. Starts workflow processing asynchronously\n 5. Sends WebSocket notification to connected clients\n 6. Returns immediately (does not wait for completion)\n\nPerformance Notes:\n - Response time: \u003c 200ms (workflow starts asynchronously)\n - Does not block on workflow completion\n - WebSocket notifications sent in background task\n\nUse Cases:\n - Trigger flow execution from UI dashboard\n - Automated flow execution via API integration\n - Batch processing of multiple documents\n - Event-driven workflow automation\n\nRelated Endpoints:\n - GET /flow-executions/{id} - Check execution status\n - GET /flow-executions - List all executions for a flow\n - POST /flow-executions/{id}/execute - Re-execute failed execution","operationId":"create_flow_execution_api_flow_executions_post","parameters":["878015b9-47b9-4f20-b65f-b7c3486371dc"],"requestBody":"93522855-6ffe-458e-9cfb-b02896f18684","responses":{"201":"615b5a49-adea-44f6-b612-983178ac5d94","400":"ad03f8a3-da43-4b41-a70a-56a267359e2b","401":"1d533393-24a6-47c5-8d24-45123b886f24","403":"98f20b8f-4956-440f-a526-7dc2ed313268","404":"68397d5c-3e06-44c8-80f8-984c00a12ccb","409":"5bc10eea-6a22-46db-b8be-479a8eeb6918","422":"a22377cc-0154-438f-bd84-b59331d33955","500":"e5d67d73-27aa-4393-92d2-5db366e63c29"},"security":["952a9679-5c76-43c4-bfcc-af4627b4d402","dd127868-46ce-4336-bd12-123054282d47"],"summary":"Create and start a flow execution","tags":["flow-executions"],"method":"post","type":"path","servers":["4d0b7ba2-10f8-42a9-8f2d-c56b9c660af5"],"path":"/api/flow-executions","baseUrlOptions":["https://flows.super.ai"],"title":"Create and start a flow execution","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"878015b9-47b9-4f20-b65f-b7c3486371dc":{"description":"Optional key that makes this request safe to retry. Must be a ULID: 26 upper-case Crockford base32 characters, e.g. 01ARZ3NDEKTSV4RRFFQ69G5FAV. Keys are scoped to the flow: if an execution of this flow with this key already exists, that execution is returned with 201 in its current state (its `status` may have changed since it was created, and is `deleted` if it was deleted) and no new execution is created, started or queued, whatever `input` the repeat carries. The same key on a different flow creates a separate execution. Keys never expire. If omitted, super.AI generates one. The key in effect is returned as `idempotency_key`. A malformed key returns 422 and creates nothing.","in":"header","name":"Idempotency-Key","required":false,"schema":{"oneOf":[{"type":"string","title":"Idempotency-Key","description":"Optional key that makes this request safe to retry. Must be a ULID: 26 upper-case Crockford base32 characters, e.g. 01ARZ3NDEKTSV4RRFFQ69G5FAV. Keys are scoped to the flow: if an execution of this flow with this key already exists, that execution is returned with 201 in its current state (its `status` may have changed since it was created, and is `deleted` if it was deleted) and no new execution is created, started or queued, whatever `input` the repeat carries. The same key on a different flow creates a separate execution. Keys never expire. If omitted, super.AI generates one. The key in effect is returned as `idempotency_key`. A malformed key returns 422 and creates nothing.","maxLength":26,"minLength":26,"pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Idempotency-Key","description":"Optional key that makes this request safe to retry. Must be a ULID: 26 upper-case Crockford base32 characters, e.g. 01ARZ3NDEKTSV4RRFFQ69G5FAV. Keys are scoped to the flow: if an execution of this flow with this key already exists, that execution is returned with 201 in its current state (its `status` may have changed since it was created, and is `deleted` if it was deleted) and no new execution is created, started or queued, whatever `input` the repeat carries. The same key on a different flow creates a separate execution. Keys never expire. If omitted, super.AI generates one. The key in effect is returned as `idempotency_key`. A malformed key returns 422 and creates nothing.","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Request payload for creating a new flow execution.\n\nThis model defines the required data to start a new flow execution.\nThe input schema must match the flow definition's expected input structure.","properties":{"flow_id":{"description":"UUID of the flow definition to execute. Must be a valid, active flow accessible to your organization. The flow defines the workflow structure and task sequence.","examples":["550e8400-e29b-41d4-a716-446655440000"],"format":"uuid","title":"Flow Id","type":"string","isRequired":true,"uniqueKey":"flow_id","typeLabel":"string\u003cuuid>"},"input":{"additionalProperties":true,"description":"Input data for the flow execution. Schema is flow-specific. Common patterns: - Document processing: {'file_key': 'path/to/file.pdf'} - Data processing: {'document_url': 'gs://bucket/file.csv'} - Email processing: {'message_id': 'msg_123', 'attachments': []} Refer to flow definition for exact schema requirements.","examples":[{"file_key":"documents/report.pdf","options":{"language":"en"}}],"title":"Input","type":"object","isRequired":true,"uniqueKey":"input","typeLabel":"Input · object"},"input_task_name":{"oneOf":[{"type":"string","title":"Input Task Name","description":"The task name of the input task that is firing this execution. Required when the flow has multiple input trigger tasks — omitting it will result in a validation error. For single-input-task flows this field is optional, but if provided it must exactly match the flow's only input task name; a mismatch returns a 400 error.","example":"receive_email","uniqueKey":"input_task_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Input Task Name","description":"The task name of the input task that is firing this execution. Required when the flow has multiple input trigger tasks — omitting it will result in a validation error. For single-input-task flows this field is optional, but if provided it must exactly match the flow's only input task name; a mismatch returns a 400 error.","example":"receive_email","uniqueKey":"input_task_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"input_task_name","typeLabel":"string | null"}},"required":["flow_id","input"],"title":"FlowExecutionCreateRequest","type":"object","uniqueKey":"","typeLabel":"FlowExecutionCreateRequest · object"},"examples":{"Example":{"title":"Example","value":{"flow_id":"550e8400-e29b-41d4-a716-446655440000","input":{"file_key":"documents/report.pdf","options":{"language":"en"}},"input_task_name":"receive_email"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"615b5a49-adea-44f6-b612-983178ac5d94":{"content":{"application/json":{"schema":{"description":"Response model for flow execution operations.\n\nRepresents a single flow execution instance with its current state and metadata.\nFlow executions are runtime instances of flow definitions that process input data\nthrough a series of tasks defined in the flow's workflow.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"flow_id":{"description":"UUID of the flow definition being executed. References the parent flow that defines the workflow structure.","examples":["550e8400-e29b-41d4-a716-446655440000"],"format":"uuid","title":"Flow Id","type":"string","isRequired":true,"uniqueKey":"flow_id","typeLabel":"string\u003cuuid>"},"flow_version":{"description":"Version number of the flow definition used for this execution. Execution continues on the same version even if flow is updated. Ensures consistency throughout execution lifecycle.","examples":[3],"minimum":1,"title":"Flow Version","type":"integer","isRequired":true,"uniqueKey":"flow_version","typeLabel":"integer"},"id":{"format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"input":{"additionalProperties":true,"description":"Input data provided when execution was created. Schema is defined by the flow definition. Commonly includes: file_key, document_url, or custom parameters. Structure varies by flow type.","examples":[{"file_key":"documents/abc123.pdf","metadata":{"priority":"high"}}],"title":"Input","type":"object","isRequired":true,"uniqueKey":"input","typeLabel":"Input · object"},"modified_by":{"title":"Modified By","type":"string","isRequired":true,"uniqueKey":"modified_by","typeLabel":"string"},"organization_id":{"description":"UUID of the organization that owns this execution. Used for access control and data isolation. All executions are scoped to an organization.","examples":["660e8400-e29b-41d4-a716-446655440001"],"format":"uuid","title":"Organization Id","type":"string","isRequired":true,"uniqueKey":"organization_id","typeLabel":"string\u003cuuid>"},"status":{"description":"Current execution status. Possible values: 'queued', 'running', 'completed', 'failed', 'deleted', 'stale', 'edited', 'awaiting_input', 'cancel_requested', 'cancelled', 'pending_payment'. Status transitions: queued → running → completed/failed. 'pending_payment' means the execution is held until the organization's credits are restored, then released back to 'queued' automatically.","enum":["queued","running","completed","failed","deleted","stale","edited","awaiting_input","cancel_requested","cancelled","pending_payment"],"title":"ExecutionStatus","type":"string","examples":["running"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"updated_at":{"format":"date-time","title":"Updated At","type":"string","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"idempotency_key":{"oneOf":[{"type":"string","title":"Idempotency Key","description":"Idempotency key this execution was created with: the `Idempotency-Key` request header when the caller sent one, otherwise a ULID generated by super.AI. Sending a create request for the same flow with this key again returns this execution with 201, in its current state, instead of creating or starting a new one. Null only for executions created before idempotency keys existed.","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","uniqueKey":"idempotency_key.oneOf.0","typeLabel":"string"},{"type":"null","title":"Idempotency Key","description":"Idempotency key this execution was created with: the `Idempotency-Key` request header when the caller sent one, otherwise a ULID generated by super.AI. Sending a create request for the same flow with this key again returns this execution with 201, in its current state, instead of creating or starting a new one. Null only for executions created before idempotency keys existed.","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","uniqueKey":"idempotency_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"idempotency_key","typeLabel":"string | null"},"pricing_config_id":{"oneOf":[{"type":"string","title":"Pricing Config Id","description":"UUID of the pricing config active when this execution was created or re-executed. References the default config if no org-specific config existed at that time. None for executions created before pricing config tracking was introduced.","format":"uuid","uniqueKey":"pricing_config_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Pricing Config Id","description":"UUID of the pricing config active when this execution was created or re-executed. References the default config if no org-specific config existed at that time. None for executions created before pricing config tracking was introduced.","uniqueKey":"pricing_config_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_config_id","typeLabel":"string\u003cuuid> | null"},"status_data":{"oneOf":[{"type":"object","title":"AwaitingInputStatusData","description":"`status_data` of a flow execution whose status is `awaiting_input`.","required":["task_name"],"example":{"task_name":"review_invoice"},"properties":{"task_name":{"description":"Name of the task the execution is waiting for.","title":"Task Name","type":"string","isRequired":true,"uniqueKey":"status_data.oneOf.0.task_name","typeLabel":"string"}},"uniqueKey":"status_data.oneOf.0","typeLabel":"AwaitingInputStatusData · object"},{"type":"object","title":"FailedStatusData","description":"`status_data` of a flow execution whose status is `failed`.","required":["code","message"],"properties":{"code":{"description":"Cause of the failure. New values may be added.","enum":["task_execution_failed","task_executions_limit_exceeded","internal_error","execution_start_failed","reexecution_failed","execution_stalled"],"title":"ExecutionFailureCode","type":"string","isRequired":true,"uniqueKey":"status_data.oneOf.1.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Fixed, human-readable text for the code.","title":"Message","type":"string","isRequired":true,"uniqueKey":"status_data.oneOf.1.message","typeLabel":"string"},"details":{"additionalProperties":true,"description":"Code-specific data. `task_execution_failed`: `task_name` and `task_execution_idxs` (the failed task executions that have a task execution record; left out when there are none). `task_executions_limit_exceeded`: `task_name` and `limit`. Empty for the other codes.","title":"Details","type":"object","uniqueKey":"status_data.oneOf.1.details","typeLabel":"Details · object"}},"uniqueKey":"status_data.oneOf.1","typeLabel":"FailedStatusData · object"},{"type":"null","title":"Status Data","description":"Status-specific payload for the current `status`. While the status is 'awaiting_input' it names the task the execution is waiting for: {\"task_name\": \"\u003ctask name>\"}. When the status is 'failed' it says why: {\"code\", \"message\", \"details\"}, where `message` is fixed per `code` and `details` holds code-specific data. Null for every other status, and for executions that failed before this field was introduced.","example":{"task_name":"review_invoice"},"uniqueKey":"status_data.oneOf.2","typeLabel":"null"}],"uniqueKey":"status_data","typeLabel":"AwaitingInputStatusData · object | FailedStatusData · object | null"},"total_credits":{"oneOf":[{"type":"integer","title":"Total Credits","description":"Total credits consumed by this flow execution across all tasks. None when no usage records exist yet.","example":42,"uniqueKey":"total_credits.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Total Credits","description":"Total credits consumed by this flow execution across all tasks. None when no usage records exist yet.","example":42,"uniqueKey":"total_credits.oneOf.1","typeLabel":"null"}],"uniqueKey":"total_credits","typeLabel":"integer | null"},"triggered_task_executor_name":{"oneOf":[{"type":"string","title":"Triggered Task Executor Name","description":"Executor name of the trigger that fired this execution (e.g., 'receive_file'). Set for multi-input flows; None for single-input-task flows.","uniqueKey":"triggered_task_executor_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Triggered Task Executor Name","description":"Executor name of the trigger that fired this execution (e.g., 'receive_file'). Set for multi-input flows; None for single-input-task flows.","uniqueKey":"triggered_task_executor_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"triggered_task_executor_name","typeLabel":"string | null"}},"required":["id","created_at","updated_at","modified_by","flow_id","flow_version","status","input","organization_id"],"title":"FlowExecutionResponse","type":"object","uniqueKey":"","typeLabel":"FlowExecutionResponse · object"},"examples":{"Example":{"title":"Example","value":{"created_at":"2023-11-07T05:31:56Z","flow_id":"550e8400-e29b-41d4-a716-446655440000","flow_version":3,"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","input":{"file_key":"documents/abc123.pdf","metadata":{"priority":"high"}},"modified_by":"\u003cstring>","organization_id":"660e8400-e29b-41d4-a716-446655440001","status":"running","updated_at":"2023-11-07T05:31:56Z","idempotency_key":"01ARZ3NDEKTSV4RRFFQ69G5FAV","pricing_config_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status_data":{"task_name":"review_invoice"},"total_credits":42,"triggered_task_executor_name":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Flow execution created and started successfully","exampleType":"generated"},"ad03f8a3-da43-4b41-a70a-56a267359e2b":{"content":{"application/json":{"schema":{"description":"Standard API error response structure.\n\nAll error responses from the API follow this format, ensuring\nconsistent error handling for API consumers.\n\nExample:\n {\n \"error\": {\n \"message\": \"Flow not found\",\n \"code\": \"not_found\"\n },\n \"request_id\": \"01K8KABR6S16YETA2SZPVBS9SP\"\n }","examples":[{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}],"properties":{"error":{"description":"Standard error detail structure.\n\nThis model matches the error format returned by the centralized\nexception handlers in app/api/errors/handlers.py.","properties":{"message":{"description":"Human-readable error message","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"details":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"error.details.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.1","typeLabel":"Details · object[]"},{"type":"object","title":"Details","description":"Additional error context, validation errors, or debugging information","additionalProperties":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.3","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"string[] | Details · object[] | Details · object | null"}},"required":["message"],"title":"ErrorDetail","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorDetail · object"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_id","typeLabel":"string | null"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}}},"exampleType":"generated"}},"description":"Bad Request - Invalid input data or missing required fields","exampleType":"generated"},"1d533393-24a6-47c5-8d24-45123b886f24":{"content":{"application/json":{"examples":{"invalid_token":{"title":"invalid_token","value":{"error":{"code":"unauthorized","message":"Invalid authentication token"},"request_id":"01K8KACP7D2XFGHJ9KLM4NPQR8"}},"missing_token":{"title":"missing_token","value":{"error":{"code":"unauthorized","message":"Authentication required"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}}},"schema":{"description":"Standard API error response structure.\n\nAll error responses from the API follow this format, ensuring\nconsistent error handling for API consumers.\n\nExample:\n {\n \"error\": {\n \"message\": \"Flow not found\",\n \"code\": \"not_found\"\n },\n \"request_id\": \"01K8KABR6S16YETA2SZPVBS9SP\"\n }","examples":[{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}],"properties":{"error":{"description":"Standard error detail structure.\n\nThis model matches the error format returned by the centralized\nexception handlers in app/api/errors/handlers.py.","properties":{"message":{"description":"Human-readable error message","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"details":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"error.details.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.1","typeLabel":"Details · object[]"},{"type":"object","title":"Details","description":"Additional error context, validation errors, or debugging information","additionalProperties":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.3","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"string[] | Details · object[] | Details · object | null"}},"required":["message"],"title":"ErrorDetail","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorDetail · object"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_id","typeLabel":"string | null"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"description":"Unauthorized - Missing or invalid authentication credentials","exampleType":"examples"},"98f20b8f-4956-440f-a526-7dc2ed313268":{"content":{"application/json":{"schema":{"description":"Standard API error response structure.\n\nAll error responses from the API follow this format, ensuring\nconsistent error handling for API consumers.\n\nExample:\n {\n \"error\": {\n \"message\": \"Flow not found\",\n \"code\": \"not_found\"\n },\n \"request_id\": \"01K8KABR6S16YETA2SZPVBS9SP\"\n }","examples":[{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}],"properties":{"error":{"description":"Standard error detail structure.\n\nThis model matches the error format returned by the centralized\nexception handlers in app/api/errors/handlers.py.","properties":{"message":{"description":"Human-readable error message","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"details":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"error.details.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.1","typeLabel":"Details · object[]"},{"type":"object","title":"Details","description":"Additional error context, validation errors, or debugging information","additionalProperties":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.3","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"string[] | Details · object[] | Details · object | null"}},"required":["message"],"title":"ErrorDetail","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorDetail · object"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_id","typeLabel":"string | null"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}}},"exampleType":"generated"}},"description":"Forbidden - User lacks permission to execute this flow","exampleType":"generated"},"68397d5c-3e06-44c8-80f8-984c00a12ccb":{"content":{"application/json":{"examples":{"flow_not_found":{"title":"flow_not_found","value":{"error":{"code":"not_found","message":"Flow not found"},"request_id":"01K8KACP7D2XFGHJ9KLM4NPQR8"}},"resource_not_found":{"title":"resource_not_found","value":{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}}},"schema":{"description":"Standard API error response structure.\n\nAll error responses from the API follow this format, ensuring\nconsistent error handling for API consumers.\n\nExample:\n {\n \"error\": {\n \"message\": \"Flow not found\",\n \"code\": \"not_found\"\n },\n \"request_id\": \"01K8KABR6S16YETA2SZPVBS9SP\"\n }","examples":[{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}],"properties":{"error":{"description":"Standard error detail structure.\n\nThis model matches the error format returned by the centralized\nexception handlers in app/api/errors/handlers.py.","properties":{"message":{"description":"Human-readable error message","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"details":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"error.details.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.1","typeLabel":"Details · object[]"},{"type":"object","title":"Details","description":"Additional error context, validation errors, or debugging information","additionalProperties":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.3","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"string[] | Details · object[] | Details · object | null"}},"required":["message"],"title":"ErrorDetail","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorDetail · object"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_id","typeLabel":"string | null"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"description":"Not Found - The requested resource does not exist","exampleType":"examples"},"5bc10eea-6a22-46db-b8be-479a8eeb6918":{"content":{"application/json":{"schema":{"description":"Standard API error response structure.\n\nAll error responses from the API follow this format, ensuring\nconsistent error handling for API consumers.\n\nExample:\n {\n \"error\": {\n \"message\": \"Flow not found\",\n \"code\": \"not_found\"\n },\n \"request_id\": \"01K8KABR6S16YETA2SZPVBS9SP\"\n }","examples":[{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}],"properties":{"error":{"description":"Standard error detail structure.\n\nThis model matches the error format returned by the centralized\nexception handlers in app/api/errors/handlers.py.","properties":{"message":{"description":"Human-readable error message","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"details":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"error.details.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.1","typeLabel":"Details · object[]"},{"type":"object","title":"Details","description":"Additional error context, validation errors, or debugging information","additionalProperties":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.3","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"string[] | Details · object[] | Details · object | null"}},"required":["message"],"title":"ErrorDetail","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorDetail · object"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_id","typeLabel":"string | null"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}}},"exampleType":"generated"}},"description":"Conflict - An execution with this Idempotency-Key exists on this flow but is not accessible to the caller","exampleType":"generated"},"a22377cc-0154-438f-bd84-b59331d33955":{"content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"title":"Location","type":"array","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"title":"Error Type","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"title":"Detail","type":"array","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"title":"HTTPValidationError","type":"object","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Validation Error","exampleType":"generated"},"e5d67d73-27aa-4393-92d2-5db366e63c29":{"content":{"application/json":{"examples":{"internal_error":{"title":"internal_error","value":{"error":{"code":"internal_error","message":"Internal server error"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}},"repository_error":{"title":"repository_error","value":{"error":{"code":"repository_error","message":"Database operation failed"},"request_id":"01K8KACP7D2XFGHJ9KLM4NPQR8"}}},"schema":{"description":"Standard API error response structure.\n\nAll error responses from the API follow this format, ensuring\nconsistent error handling for API consumers.\n\nExample:\n {\n \"error\": {\n \"message\": \"Flow not found\",\n \"code\": \"not_found\"\n },\n \"request_id\": \"01K8KABR6S16YETA2SZPVBS9SP\"\n }","examples":[{"error":{"code":"not_found","message":"Resource not found"},"request_id":"01K8KABR6S16YETA2SZPVBS9SP"}],"properties":{"error":{"description":"Standard error detail structure.\n\nThis model matches the error format returned by the centralized\nexception handlers in app/api/errors/handlers.py.","properties":{"message":{"description":"Human-readable error message","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Machine-readable error code for programmatic handling","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"details":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"error.details.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.1","typeLabel":"Details · object[]"},{"type":"object","title":"Details","description":"Additional error context, validation errors, or debugging information","additionalProperties":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Additional error context, validation errors, or debugging information","uniqueKey":"error.details.oneOf.3","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"string[] | Details · object[] | Details · object | null"}},"required":["message"],"title":"ErrorDetail","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorDetail · object"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP","uniqueKey":"request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_id","typeLabel":"string | null"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"description":"Internal Server Error - An unexpected error occurred","exampleType":"examples"}},"security":{"952a9679-5c76-43c4-bfcc-af4627b4d402":{"BearerAuth":{"bearerFormat":"JWT","description":"JWT Bearer token authentication. Include your access token in the Authorization header as: `Bearer YOUR_ACCESS_TOKEN`\n\nExample:\n```\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\n```","scheme":"bearer","type":"http","scopes":[],"schemeName":"BearerAuth"}},"dd127868-46ce-4336-bd12-123054282d47":{"APIKeyAuth":{"description":"API key authentication. Include your API key in the X-API-Key header as: `X-API-Key YOUR_API_KEY`\n\nExample:\n```\nX-API-Key: saf_1234567890\n```","in":"header","name":"X-API-Key","type":"apiKey","scopes":[],"schemeName":"APIKeyAuth"}}},"servers":{"4d0b7ba2-10f8-42a9-8f2d-c56b9c660af5":{"description":"Production server","url":"https://flows.super.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"JWT","description":"JWT Bearer token authentication. Include your access token in the Authorization header as: `Bearer YOUR_ACCESS_TOKEN`\n\nExample:\n```\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\n```","scheme":"bearer","type":"http","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT Bearer token authentication. Include your access token in the Authorization header as: `Bearer YOUR_ACCESS_TOKEN`\n\nExample:\n```\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\n```","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"},{"schemes":[{"scheme":{"description":"API key authentication. Include your API key in the X-API-Key header as: `X-API-Key YOUR_API_KEY`\n\nExample:\n```\nX-API-Key: saf_1234567890\n```","in":"header","name":"X-API-Key","type":"apiKey","scopes":[],"schemeName":"APIKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key authentication. Include your API key in the X-API-Key header as: `X-API-Key YOUR_API_KEY`\n\nExample:\n```\nX-API-Key: saf_1234567890\n```","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyAuth","name":"X-API-Key"}],"title":"APIKeyAuth"}]},"originalFileLocation":"openapi/superai-flows-openapi.json"},"subdomain":"superai-flows-docs","siteName":"SuperAI Flows","title":"Create and start a flow execution - SuperAI Flows","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T12:20:51.436Z","originalFileLocation":"api-reference/flow-executions/create-and-start-a-flow-execution.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=\"Create a new flow execution and start workflow processing. This endpoint creates a flow execution record and attempts to start the associated workflow processing. The execution is created with status \u0026#x27;queued\u0026#x27; and atomically promoted to \u0026#x27;running\u0026#x27; if the organization\u0026#x27;s concurrency limit allows. When the organization\u0026#x27;s credits are exhausted, the execution is still created (201) but held with status \u0026#x27;pending_payment\u0026#x27; instead of being processed: no workflow starts, and the execution is released back to \u0026#x27;queued\u0026#x27; automatically once credits are restored. Check the response\u0026#x27;s status field to detect this. Context: - Flow executions represent runtime instances of flow definitions - Each execution is isolated and maintains its own state - Input data must conform to the flow\u0026#x27;s input schema - Executions are scoped to the user\u0026#x27;s organization - WebSocket notifications are sent on creation for real-time updates Input Validation: - Input data is validated against the flow\u0026#x27;s input task schema - Validation occurs before database record creation or workflow start - Invalid input returns 400 Bad Request with detailed error messages - Validation errors include field location, type, and specific issue - No flow execution record is created if validation fails Idempotency: - The optional Idempotency-Key header must be a ULID; a malformed key returns 422 and nothing is created - The key in effect (sent, or generated when omitted) is returned as idempotency_key - Repeating a request on the same flow with the same key returns 201 with the original execution in its current state (its status may have changed since it was created, and is deleted if it was deleted), even if input differs; no new execution is created, started or queued - Keys are scoped per flow and never expire Execution Flow: 1. Validates flow exists and user has access 2. Validates input data against flow\u0026#x27;s input schema 3. Creates execution record in database 4. Starts workflow processing asynchronously 5. Sends WebSocket notification to connected clients 6. Returns immediately (does not wait for completion) Performance Notes: - Response time: \u0026lt; 200ms (workflow starts asynchronously) - Does not block on workflow completion - WebSocket notifications sent in background task Use Cases: - Trigger flow execution from UI dashboard - Automated flow execution via API integration - Batch processing of multiple documents - Event-driven workflow automation Related Endpoints: - GET /flow-executions/{id} - Check execution status - GET /flow-executions - List all executions for a flow - POST /flow-executions/{id}/execute - Re-execute failed execution\">\u003cmeta data-mint-head name=\"application-name\" content=\"SuperAI Flows\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/superai-flows-docs/qpT9WA2q8_qrkdpL/_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/superai-flows-docs/qpT9WA2q8_qrkdpL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/superai-flows-docs/qpT9WA2q8_qrkdpL/_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/superai-flows-docs/qpT9WA2q8_qrkdpL/_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/superai-flows-docs/qpT9WA2q8_qrkdpL/_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/superai-flows-docs/qpT9WA2q8_qrkdpL/_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/superai-flows-docs/qpT9WA2q8_qrkdpL/_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/superai-flows-docs/qpT9WA2q8_qrkdpL/_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/superai-flows-docs/qpT9WA2q8_qrkdpL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create and start a flow execution - SuperAI Flows\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new flow execution and start workflow processing. This endpoint creates a flow execution record and attempts to start the associated workflow processing. The execution is created with status \u0026#x27;queued\u0026#x27; and atomically promoted to \u0026#x27;running\u0026#x27; if the organization\u0026#x27;s concurrency limit allows. When the organization\u0026#x27;s credits are exhausted, the execution is still created (201) but held with status \u0026#x27;pending_payment\u0026#x27; instead of being processed: no workflow starts, and the execution is released back to \u0026#x27;queued\u0026#x27; automatically once credits are restored. Check the response\u0026#x27;s status field to detect this. Context: - Flow executions represent runtime instances of flow definitions - Each execution is isolated and maintains its own state - Input data must conform to the flow\u0026#x27;s input schema - Executions are scoped to the user\u0026#x27;s organization - WebSocket notifications are sent on creation for real-time updates Input Validation: - Input data is validated against the flow\u0026#x27;s input task schema - Validation occurs before database record creation or workflow start - Invalid input returns 400 Bad Request with detailed error messages - Validation errors include field location, type, and specific issue - No flow execution record is created if validation fails Idempotency: - The optional Idempotency-Key header must be a ULID; a malformed key returns 422 and nothing is created - The key in effect (sent, or generated when omitted) is returned as idempotency_key - Repeating a request on the same flow with the same key returns 201 with the original execution in its current state (its status may have changed since it was created, and is deleted if it was deleted), even if input differs; no new execution is created, started or queued - Keys are scoped per flow and never expire Execution Flow: 1. Validates flow exists and user has access 2. Validates input data against flow\u0026#x27;s input schema 3. Creates execution record in database 4. Starts workflow processing asynchronously 5. Sends WebSocket notification to connected clients 6. Returns immediately (does not wait for completion) Performance Notes: - Response time: \u0026lt; 200ms (workflow starts asynchronously) - Does not block on workflow completion - WebSocket notifications sent in background task Use Cases: - Trigger flow execution from UI dashboard - Automated flow execution via API integration - Batch processing of multiple documents - Event-driven workflow automation Related Endpoints: - GET /flow-executions/{id} - Check execution status - GET /flow-executions - List all executions for a flow - POST /flow-executions/{id}/execute - Re-execute failed execution\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SuperAI Flows\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://superai-flows-docs.mintlify.app/_mintlify/api/og/v2?division=flow-executions\u0026amp;title=Create+and+start+a+flow+execution\u0026amp;description=Create+a+new+flow+execution+and+start+workflow+processing.%0A%0AThis+endpoint+creates+a+flow+execution+record+and+attempts+to+start+the+associated%0Aworkflow+processi\u0026amp;theme=ab5065c76c8574caf1b0798b\u0026amp;signature=17fb789262bd2a011d7fd3dc1a4398c23340b3c06598f339d9e96f16bb9af6df\">\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 and start a flow execution - SuperAI Flows\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new flow execution and start workflow processing. This endpoint creates a flow execution record and attempts to start the associated workflow processing. The execution is created with status \u0026#x27;queued\u0026#x27; and atomically promoted to \u0026#x27;running\u0026#x27; if the organization\u0026#x27;s concurrency limit allows. When the organization\u0026#x27;s credits are exhausted, the execution is still created (201) but held with status \u0026#x27;pending_payment\u0026#x27; instead of being processed: no workflow starts, and the execution is released back to \u0026#x27;queued\u0026#x27; automatically once credits are restored. Check the response\u0026#x27;s status field to detect this. Context: - Flow executions represent runtime instances of flow definitions - Each execution is isolated and maintains its own state - Input data must conform to the flow\u0026#x27;s input schema - Executions are scoped to the user\u0026#x27;s organization - WebSocket notifications are sent on creation for real-time updates Input Validation: - Input data is validated against the flow\u0026#x27;s input task schema - Validation occurs before database record creation or workflow start - Invalid input returns 400 Bad Request with detailed error messages - Validation errors include field location, type, and specific issue - No flow execution record is created if validation fails Idempotency: - The optional Idempotency-Key header must be a ULID; a malformed key returns 422 and nothing is created - The key in effect (sent, or generated when omitted) is returned as idempotency_key - Repeating a request on the same flow with the same key returns 201 with the original execution in its current state (its status may have changed since it was created, and is deleted if it was deleted), even if input differs; no new execution is created, started or queued - Keys are scoped per flow and never expire Execution Flow: 1. Validates flow exists and user has access 2. Validates input data against flow\u0026#x27;s input schema 3. Creates execution record in database 4. Starts workflow processing asynchronously 5. Sends WebSocket notification to connected clients 6. Returns immediately (does not wait for completion) Performance Notes: - Response time: \u0026lt; 200ms (workflow starts asynchronously) - Does not block on workflow completion - WebSocket notifications sent in background task Use Cases: - Trigger flow execution from UI dashboard - Automated flow execution via API integration - Batch processing of multiple documents - Event-driven workflow automation Related Endpoints: - GET /flow-executions/{id} - Check execution status - GET /flow-executions - List all executions for a flow - POST /flow-executions/{id}/execute - Re-execute failed execution\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://superai-flows-docs.mintlify.app/_mintlify/api/og/v2?division=flow-executions\u0026amp;title=Create+and+start+a+flow+execution\u0026amp;description=Create+a+new+flow+execution+and+start+workflow+processing.%0A%0AThis+endpoint+creates+a+flow+execution+record+and+attempts+to+start+the+associated%0Aworkflow+processi\u0026amp;theme=ab5065c76c8574caf1b0798b\u0026amp;signature=17fb789262bd2a011d7fd3dc1a4398c23340b3c06598f339d9e96f16bb9af6df\">\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/superai-flows-docs/qpT9WA2q8_qrkdpL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SuperAI Flows\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7443ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/flow-executions/create-and-start-a-flow-execution.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.flows.super.ai/#organization\",\"name\":\"SuperAI Flows\",\"url\":\"https://docs.flows.super.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/superai-flows-docs/mOFmLJuUNWWCPrgW/logo/light.svg?fit=max\u0026auto=format\u0026n=mOFmLJuUNWWCPrgW\u0026q=85\u0026s=763a91d73e6886f99fbebba85459ee15\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flows.super.ai#website\",\"name\":\"SuperAI Flows\",\"url\":\"https://docs.flows.super.ai\",\"publisher\":{\"@id\":\"https://docs.flows.super.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution#webpage\",\"url\":\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution\",\"name\":\"Create and start a flow execution\",\"description\":\"Create a new flow execution and start workflow processing. This endpoint creates a flow execution record and attempts to start the associated workflow processing. The execution is created with status 'queued' and atomically promoted to 'running' if the organization's concurrency limit allows. When the organization's credits are exhausted, the execution is still created (201) but held with status 'pending_payment' instead of being processed: no workflow starts, and the execution is released back to 'queued' automatically once credits are restored. Check the response's status field to detect this. Context: - Flow executions represent runtime instances of flow definitions - Each execution is isolated and maintains its own state - Input data must conform to the flow's input schema - Executions are scoped to the user's organization - WebSocket notifications are sent on creation for real-time updates Input Validation: - Input data is validated against the flow's input task schema - Validation occurs before database record creation or workflow start - Invalid input returns 400 Bad Request with detailed error messages - Validation errors include field location, type, and specific issue - No flow execution record is created if validation fails Idempotency: - The optional Idempotency-Key header must be a ULID; a malformed key returns 422 and nothing is created - The key in effect (sent, or generated when omitted) is returned as idempotency_key - Repeating a request on the same flow with the same key returns 201 with the original execution in its current state (its status may have changed since it was created, and is deleted if it was deleted), even if input differs; no new execution is created, started or queued - Keys are scoped per flow and never expire Execution Flow: 1. Validates flow exists and user has access 2. Validates input data against flow's input schema 3. Creates execution record in database 4. Starts workflow processing asynchronously 5. Sends WebSocket notification to connected clients 6. Returns immediately (does not wait for completion) Performance Notes: - Response time: \\u003c 200ms (workflow starts asynchronously) - Does not block on workflow completion - WebSocket notifications sent in background task Use Cases: - Trigger flow execution from UI dashboard - Automated flow execution via API integration - Batch processing of multiple documents - Event-driven workflow automation Related Endpoints: - GET /flow-executions/{id} - Check execution status - GET /flow-executions - List all executions for a flow - POST /flow-executions/{id}/execute - Re-execute failed execution\",\"dateModified\":\"2026-10-23T12:20:51.436Z\",\"isPartOf\":{\"@id\":\"https://docs.flows.super.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.flows.super.ai/api-reference/auth/submit-a-self-service-access-request\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"flow-executions\",\"item\":\"https://docs.flows.super.ai/api-reference/flow-executions/list-flow-executions-with-filtering-and-pagination\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create and start a flow execution\",\"item\":\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution#apireference\",\"headline\":\"Create and start a flow execution\",\"name\":\"Create and start a flow execution\",\"description\":\"Create a new flow execution and start workflow processing. This endpoint creates a flow execution record and attempts to start the associated workflow processing. The execution is created with status 'queued' and atomically promoted to 'running' if the organization's concurrency limit allows. When the organization's credits are exhausted, the execution is still created (201) but held with status 'pending_payment' instead of being processed: no workflow starts, and the execution is released back to 'queued' automatically once credits are restored. Check the response's status field to detect this. Context: - Flow executions represent runtime instances of flow definitions - Each execution is isolated and maintains its own state - Input data must conform to the flow's input schema - Executions are scoped to the user's organization - WebSocket notifications are sent on creation for real-time updates Input Validation: - Input data is validated against the flow's input task schema - Validation occurs before database record creation or workflow start - Invalid input returns 400 Bad Request with detailed error messages - Validation errors include field location, type, and specific issue - No flow execution record is created if validation fails Idempotency: - The optional Idempotency-Key header must be a ULID; a malformed key returns 422 and nothing is created - The key in effect (sent, or generated when omitted) is returned as idempotency_key - Repeating a request on the same flow with the same key returns 201 with the original execution in its current state (its status may have changed since it was created, and is deleted if it was deleted), even if input differs; no new execution is created, started or queued - Keys are scoped per flow and never expire Execution Flow: 1. Validates flow exists and user has access 2. Validates input data against flow's input schema 3. Creates execution record in database 4. Starts workflow processing asynchronously 5. Sends WebSocket notification to connected clients 6. Returns immediately (does not wait for completion) Performance Notes: - Response time: \\u003c 200ms (workflow starts asynchronously) - Does not block on workflow completion - WebSocket notifications sent in background task Use Cases: - Trigger flow execution from UI dashboard - Automated flow execution via API integration - Batch processing of multiple documents - Event-driven workflow automation Related Endpoints: - GET /flow-executions/{id} - Check execution status - GET /flow-executions - List all executions for a flow - POST /flow-executions/{id}/execute - Re-execute failed execution\",\"url\":\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flows.super.ai/api-reference/flow-executions/create-and-start-a-flow-execution#webpage\"},\"dateModified\":\"2026-10-23T12:20:51.436Z\",\"publisher\":{\"@id\":\"https://docs.flows.super.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flows.super.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SuperAI Flows\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SuperAI Flows","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Overview","icon":"code","href":"/api-reference/introduction"},{"title":"Authentication","icon":"lock","href":"/api-reference/authentication"},{"title":"Error Codes","icon":"triangle-exclamation","href":"/api-reference/errors"},{"title":"MCP Server","icon":"robot","href":"/api-reference/mcp-server"}]},{"group":"Endpoints","pages":[{"group":"auth","pages":[{"title":"Submit a self-service access request","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/auth/access-request","href":"/api-reference/auth/submit-a-self-service-access-request"},{"title":"Retrieve authentication API key","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/auth/anon-key","href":"/api-reference/auth/retrieve-authentication-api-key"},{"title":"Human-verification challenge configuration for the sign-in and signup forms","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/auth/captcha-config","href":"/api-reference/auth/human-verification-challenge-configuration-for-the-sign-in-and-signup-forms"},{"title":"Resolve login method for an email","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/auth/login-method","href":"/api-reference/auth/resolve-login-method-for-an-email"},{"title":"Public compliance configuration for the signup and sign-in surfaces","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/auth/public-config","href":"/api-reference/auth/public-compliance-configuration-for-the-signup-and-sign-in-surfaces"},{"title":"Resend user invitation email","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/auth/resend-invite","href":"/api-reference/auth/resend-user-invitation-email"},{"title":"Reset Password","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/auth/reset-password","href":"/api-reference/auth/reset-password"},{"title":"Pre-flight signup email policy check for magic link","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/auth/signup-email-policy","href":"/api-reference/auth/pre-flight-signup-email-policy-check-for-magic-link"},{"title":"The authenticated caller's terms-acceptance state","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/auth/terms-status","href":"/api-reference/auth/the-authenticated-callers-terms-acceptance-state"}]},{"group":"files","pages":[{"title":"Download file by URI (with redirect)","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/files/download","href":"/api-reference/files/download-file-by-uri-with-redirect"},{"title":"Resolve storage URI to download URL","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/files/resolve","href":"/api-reference/files/resolve-storage-uri-to-download-url"}]},{"group":"flow-executions","pages":[{"title":"List flow executions with filtering and pagination","description":"List flow executions with filtering, sorting, and pagination.\n\nRetrieve a paginated list of flow executions for a specific flow with support\nfor filtering by status, tags, and date ranges. Results can be sorted by\ncreation or update time.\n\nContext:\n - Returns executions for a single flow (specified by flow_id)\n - Excludes soft-deleted executions from results\n - Supports multiple filtering dimensions for flexible queries\n - Pagination uses offset-based approach (page/page_size)\n\nFiltering Logic:\n - Status filter: Returns executions containing tasks with ANY of specified statuses\n - Tag filter: Returns executions containing tasks with ANY of the specified tags,\n or with ALL of them (anywhere in the run) when tags_mode=all\n - Date range: created_after/created_before bound created_at;\n updated_after/updated_before bound updated_at (all inclusive, ISO 8601)\n - Multiple filters combined with AND logic\n - Empty filters return all executions\n\nPagination:\n - Offset-based: page=1, page_size=10 returns first 10 results\n - Default: page=1, page_size=10\n - Maximum page_size: 1000 results\n - Maximum page: 10,000 (to prevent excessive database load)\n - Use start_from_execution_id for cursor-like pagination\n\nSorting:\n - sort_field: 'created_at' (when execution was created) or\n 'updated_at' (when execution was last modified)\n - sort_direction: 'asc' (oldest first) or 'desc' (newest first)\n - Default: sort by created_at desc (most recently created first)\n\nPerformance Considerations:\n - ~50ms for 100 results\n - Consider caching for frequently accessed pages\n - Large page_size values increase response time linearly\n\nUse Cases:\n - Display execution history in UI dashboard\n - Monitor recent execution failures (filter by status='failed')\n - Find executions by business context (filter by tags)\n - Export execution audit trail\n - Identify oldest pending executions (sort by created_at asc)\n\nExample Queries:\n - Recent failures: ?flow_id=xxx\u0026status=failed\u0026sort_field=created_at\u0026sort_direction=desc\u0026page_size=20\n - Tagged executions: ?flow_id=xxx\u0026tags=priority:high\u0026tags=customer:acme\n - Paginated view: ?flow_id=xxx\u0026page=2\u0026page_size=50\n - Completed in window: ?flow_id=xxx\u0026status=completed\u0026created_after=2026-06-18T08:00:00Z\u0026created_before=2026-06-18T10:00:00Z\n\nRelated Endpoints:\n - GET /flow-executions/{id} - Get single execution details\n - POST /flow-executions - Create new execution\n - GET /flows/{id} - Get flow definition details","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flow-executions","href":"/api-reference/flow-executions/list-flow-executions-with-filtering-and-pagination"},{"title":"Create and start a flow execution","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flow-executions","href":"/api-reference/flow-executions/create-and-start-a-flow-execution"},{"title":"List the execution IDs of one filtered, sorted runs-table page","description":"IDs of the executions on the requested page, in the page's order.\n\nAccepts the same `filters`/`sort` the runs table sends over the WebSocket\n`set_page_view` frame and applies the identical mapping, so the IDs are\nexactly the rows the table shows. POST because the `metadata` filter is\nnested and does not fit query parameters.","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flow-executions/page-ids","href":"/api-reference/flow-executions/list-the-execution-ids-of-one-filtered-sorted-runs-table-page"},{"title":"Retrieve a specific flow execution","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flow-executions/{flow_execution_id}","href":"/api-reference/flow-executions/retrieve-a-specific-flow-execution"},{"title":"Soft delete a flow execution","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/flow-executions/{flow_execution_id}","href":"/api-reference/flow-executions/soft-delete-a-flow-execution"},{"title":"Cancel a flow execution","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flow-executions/{flow_execution_id}/cancel","href":"/api-reference/flow-executions/cancel-a-flow-execution"},{"title":"Re-execute a flow execution","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flow-executions/{flow_execution_id}/execute","href":"/api-reference/flow-executions/re-execute-a-flow-execution"},{"title":"Add task status updates (Internal API)","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flow-executions/{flow_execution_id}/task-status","href":"/api-reference/flow-executions/add-task-status-updates-internal-api"}]},{"group":"webhook-data","pages":[{"title":"Submit webhook data for a waiting task","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flow-executions/{flow_execution_id}/webhook-data","href":"/api-reference/webhook-data/submit-webhook-data-for-a-waiting-task"}]},{"group":"flows","pages":[{"title":"List all flows","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows","href":"/api-reference/flows/list-all-flows"},{"title":"Create a new flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flows","href":"/api-reference/flows/create-a-new-flow"},{"title":"Get available flow tags for autocomplete","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/available-tags","href":"/api-reference/flows/get-available-flow-tags-for-autocomplete"},{"title":"Generate file download URL","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flows/download-url","href":"/api-reference/flows/generate-file-download-url"},{"title":"Retrieve a flow by ID","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}","href":"/api-reference/flows/retrieve-a-flow-by-id"},{"title":"Delete a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/flows/{flow_id}","href":"/api-reference/flows/delete-a-flow"},{"title":"Partially update a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json patch /api/flows/{flow_id}","href":"/api-reference/flows/partially-update-a-flow"},{"title":"Get clone info for a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/clone-info","href":"/api-reference/flows/get-clone-info-for-a-flow"},{"title":"Update flow definition","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json put /api/flows/{flow_id}/definition","href":"/api-reference/flows/update-flow-definition"},{"title":"List flow files","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/files","href":"/api-reference/flows/list-flow-files"},{"title":"List flow invitations","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/invitations","href":"/api-reference/flows/list-flow-invitations"},{"title":"Upsert user invitations to a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json put /api/flows/{flow_id}/invitations","href":"/api-reference/flows/upsert-user-invitations-to-a-flow"},{"title":"Remove user invitations from a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/flows/{flow_id}/invitations","href":"/api-reference/flows/remove-user-invitations-from-a-flow"},{"title":"Get distinct metadata keys for a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/metadata/keys","href":"/api-reference/flows/get-distinct-metadata-keys-for-a-flow"},{"title":"Get distinct values for a metadata key","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/metadata/values","href":"/api-reference/flows/get-distinct-values-for-a-metadata-key"},{"title":"Get tag suggestions for a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/tag-suggestions","href":"/api-reference/flows/get-tag-suggestions-for-a-flow"},{"title":"Get tag usage for a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/tag-usage","href":"/api-reference/flows/get-tag-usage-for-a-flow"},{"title":"Get tags for flow executions","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/tags","href":"/api-reference/flows/get-tags-for-flow-executions"},{"title":"Permanently delete tags from a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/flows/{flow_id}/tags","href":"/api-reference/flows/permanently-delete-tags-from-a-flow"},{"title":"Update a single task in flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json put /api/flows/{flow_id}/task","href":"/api-reference/flows/update-a-single-task-in-flow"},{"title":"List team invitations for a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/team-invitations","href":"/api-reference/flows/list-team-invitations-for-a-flow"},{"title":"Upsert team (worker group) invitations to a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json put /api/flows/{flow_id}/team-invitations","href":"/api-reference/flows/upsert-team-worker-group-invitations-to-a-flow"},{"title":"Remove team invitations from a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/flows/{flow_id}/team-invitations","href":"/api-reference/flows/remove-team-invitations-from-a-flow"},{"title":"Generate file upload URL","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flows/{flow_id}/upload-url","href":"/api-reference/flows/generate-file-upload-url"},{"title":"Validate a flow definition without persisting","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flows/{flow_id}/validate","href":"/api-reference/flows/validate-a-flow-definition-without-persisting"},{"title":"List all versions of a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/versions","href":"/api-reference/flows/list-all-versions-of-a-flow"},{"title":"List version summaries for a flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/versions/summary","href":"/api-reference/flows/list-version-summaries-for-a-flow"},{"title":"Get specific flow version","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/versions/{version}","href":"/api-reference/flows/get-specific-flow-version"},{"title":"Update version metadata","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json patch /api/flows/{flow_id}/versions/{version}","href":"/api-reference/flows/update-version-metadata"},{"title":"Restore a past version","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/flows/{flow_id}/versions/{version}/restore","href":"/api-reference/flows/restore-a-past-version"},{"title":"List task summaries for flow version","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/flows/{flow_id}/versions/{version}/summary","href":"/api-reference/flows/list-task-summaries-for-flow-version"}]},{"group":"human-review-tasks","pages":[{"title":"List human review tasks assigned to the current user","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/human-review-tasks","href":"/api-reference/human-review-tasks/list-human-review-tasks-assigned-to-the-current-user"},{"title":"Create a new human review task","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/human-review-tasks","href":"/api-reference/human-review-tasks/create-a-new-human-review-task"},{"title":"List human review tasks for a flow execution (org-level access)","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/human-review-tasks/by-execution","href":"/api-reference/human-review-tasks/list-human-review-tasks-for-a-flow-execution-org-level-access"},{"title":"Get a human review task by ID","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/human-review-tasks/{task_id}","href":"/api-reference/human-review-tasks/get-a-human-review-task-by-id"},{"title":"List all assignments for a human review task","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/human-review-tasks/{task_id}/assignments","href":"/api-reference/human-review-tasks/list-all-assignments-for-a-human-review-task"},{"title":"Complete a human review task","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/human-review-tasks/{task_id}/complete","href":"/api-reference/human-review-tasks/complete-a-human-review-task"},{"title":"Start a human review task","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/human-review-tasks/{task_id}/start","href":"/api-reference/human-review-tasks/start-a-human-review-task"},{"title":"Unstart a human review task assignment","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/human-review-tasks/{task_id}/unstart","href":"/api-reference/human-review-tasks/unstart-a-human-review-task-assignment"}]},{"group":"integrations","pages":[{"title":"List integration catalog","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/catalog","href":"/api-reference/integrations/list-integration-catalog"},{"title":"List user credentials","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/credentials","href":"/api-reference/integrations/list-user-credentials"},{"title":"Create integration credentials","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/credentials","href":"/api-reference/integrations/create-integration-credentials"},{"title":"List credentials by provider","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/credentials/provider/{provider}","href":"/api-reference/integrations/list-credentials-by-provider"},{"title":"Get credential by ID","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/credentials/{credential_id}","href":"/api-reference/integrations/get-credential-by-id"},{"title":"Delete credential","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/integrations/credentials/{credential_id}","href":"/api-reference/integrations/delete-credential"},{"title":"Update credential","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json patch /api/integrations/credentials/{credential_id}","href":"/api-reference/integrations/update-credential"},{"title":"Get credential secrets","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/credentials/{credential_id}/credentials","href":"/api-reference/integrations/get-credential-secrets"},{"title":"List user databases","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/database","href":"/api-reference/integrations/list-user-databases"},{"title":"Create Database","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database","href":"/api-reference/integrations/create-database"},{"title":"Create managed database","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database/managed","href":"/api-reference/integrations/create-managed-database"},{"title":"List tables in managed database","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/database/managed/tables","href":"/api-reference/integrations/list-tables-in-managed-database"},{"title":"Create table in managed database","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database/managed/tables","href":"/api-reference/integrations/create-table-in-managed-database"},{"title":"Get table columns from managed database","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/database/managed/tables/{table_name}/columns","href":"/api-reference/integrations/get-table-columns-from-managed-database"},{"title":"Get table data from managed database","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/database/managed/tables/{table_name}/data","href":"/api-reference/integrations/get-table-data-from-managed-database"},{"title":"Query a managed-DB table with exact-match filters","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database/managed/tables/{table_name}/query","href":"/api-reference/integrations/query-a-managed-db-table-with-exact-match-filters"},{"title":"Insert one row into a managed-DB table","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database/managed/tables/{table_name}/rows","href":"/api-reference/integrations/insert-one-row-into-a-managed-db-table"},{"title":"Get database by ID","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/database/{db_id}","href":"/api-reference/integrations/get-database-by-id"},{"title":"Delete database","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/integrations/database/{db_id}","href":"/api-reference/integrations/delete-database"},{"title":"Get database columns","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/database/{db_id}/columns","href":"/api-reference/integrations/get-database-columns"},{"title":"Get Download Url","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/database/{db_id}/download","href":"/api-reference/integrations/get-download-url"},{"title":"Generate database upload URL","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database/{db_id}/upload-url","href":"/api-reference/integrations/generate-database-upload-url"},{"title":"Compare Csv For Replace","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database/{db_id}/upload/compare","href":"/api-reference/integrations/compare-csv-for-replace"},{"title":"Complete File Upload","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database/{db_id}/upload/complete","href":"/api-reference/integrations/complete-file-upload"},{"title":"Preview CSV file before import","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database/{db_id}/upload/preview","href":"/api-reference/integrations/preview-csv-file-before-import"},{"title":"Replace File Upload","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/database/{db_id}/upload/replace","href":"/api-reference/integrations/replace-file-upload"},{"title":"Process Emails","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/email/process","href":"/api-reference/integrations/process-emails"},{"title":"Create Email Task","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/email/tasks","href":"/api-reference/integrations/create-email-task"},{"title":"Deactivate Email Task","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/integrations/email/tasks","href":"/api-reference/integrations/deactivate-email-task"},{"title":"Get Email Task Status","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/email/tasks/{task_id}","href":"/api-reference/integrations/get-email-task-status"},{"title":"List all registered plugins","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/plugins/","href":"/api-reference/integrations/list-all-registered-plugins"},{"title":"Execute Postgres Plugin Task","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/plugins/postgres/execute","href":"/api-reference/integrations/execute-postgres-plugin-task"},{"title":"Test Postgres Plugin Connection","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/plugins/postgres/test-connection","href":"/api-reference/integrations/test-postgres-plugin-connection"},{"title":"Get plugin capabilities","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/integrations/plugins/{plugin_name}/capabilities","href":"/api-reference/integrations/get-plugin-capabilities"},{"title":"Test Postgres Connection","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/postgres/test-connection","href":"/api-reference/integrations/test-postgres-connection"},{"title":"Test Postgres Connection By Credential Id","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/postgres/test-connection/{credential_id}","href":"/api-reference/integrations/test-postgres-connection-by-credential-id"},{"title":"Test Sftp Connection","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/integrations/sftp/test-connection","href":"/api-reference/integrations/test-sftp-connection"}]},{"group":"models","pages":[{"title":"List available models","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/models","href":"/api-reference/models/list-available-models"}]},{"group":"organizations","pages":[{"title":"Why this account is restricted, if it is","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/organizations/account-restriction","href":"/api-reference/organizations/why-this-account-is-restricted-if-it-is"},{"title":"Get credit balance for current user's organization","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/organizations/credits","href":"/api-reference/organizations/get-credit-balance-for-current-users-organization"},{"title":"List the email domains this organization has claimed","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/organizations/domains","href":"/api-reference/organizations/list-the-email-domains-this-organization-has-claimed"},{"title":"Claim an email domain for this organization","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/organizations/domains","href":"/api-reference/organizations/claim-an-email-domain-for-this-organization"},{"title":"Release a claimed email domain","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/organizations/domains/{claim_id}","href":"/api-reference/organizations/release-a-claimed-email-domain"},{"title":"List signups waiting on this organization's review","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/organizations/join-requests","href":"/api-reference/organizations/list-signups-waiting-on-this-organizations-review"},{"title":"Decline a signup request","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/organizations/join-requests/{request_id}/reject","href":"/api-reference/organizations/decline-a-signup-request"},{"title":"Update organization settings","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json put /api/organizations/settings","href":"/api-reference/organizations/update-organization-settings"},{"title":"List all worker groups","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/organizations/worker-groups","href":"/api-reference/organizations/list-all-worker-groups"},{"title":"Create a worker group","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/organizations/worker-groups","href":"/api-reference/organizations/create-a-worker-group"},{"title":"Get a worker group","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/organizations/worker-groups/{group_id}","href":"/api-reference/organizations/get-a-worker-group"},{"title":"Update a worker group","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json put /api/organizations/worker-groups/{group_id}","href":"/api-reference/organizations/update-a-worker-group"},{"title":"Delete a worker group","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/organizations/worker-groups/{group_id}","href":"/api-reference/organizations/delete-a-worker-group"},{"title":"Add or remove members from a worker group","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/organizations/worker-groups/{group_id}/members","href":"/api-reference/organizations/add-or-remove-members-from-a-worker-group"},{"title":"Get organization by ID","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/organizations/{organization_id}","href":"/api-reference/organizations/get-organization-by-id"}]},{"group":"plugins","pages":[{"title":"List Instances","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/plugins/instances","href":"/api-reference/plugins/list-instances"},{"title":"List Integrations","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/plugins/{plugin_name}/instances","href":"/api-reference/plugins/list-integrations"},{"title":"Create Integration","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/plugins/{plugin_name}/instances","href":"/api-reference/plugins/create-integration"},{"title":"Update Integration","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json put /api/plugins/{plugin_name}/instances/{integration_id}","href":"/api-reference/plugins/update-integration"},{"title":"Delete Integration","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/plugins/{plugin_name}/instances/{integration_id}","href":"/api-reference/plugins/delete-integration"},{"title":"Execute Integration","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/plugins/{plugin_name}/instances/{integration_id}/execute","href":"/api-reference/plugins/execute-integration"},{"title":"Poll Integration","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/plugins/{plugin_name}/instances/{integration_id}/poll","href":"/api-reference/plugins/poll-integration"},{"title":"Get Ui Schema","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/plugins/{plugin_name}/instances/{integration_id}/ui_schema","href":"/api-reference/plugins/get-ui-schema"},{"title":"Handle Webhook","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/plugins/{plugin_name}/instances/{integration_id}/webhook/callback","href":"/api-reference/plugins/handle-webhook"},{"title":"Oauth Authorize","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/plugins/{plugin_name}/oauth/authorize","href":"/api-reference/plugins/oauth-authorize"},{"title":"Oauth Callback","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/plugins/{plugin_name}/{provider_name}/oauth/callback","href":"/api-reference/plugins/oauth-callback"}]},{"group":"profile","pages":[{"title":"Record the caller's acceptance of one or more documents","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/profile/accept-terms","href":"/api-reference/profile/record-the-callers-acceptance-of-one-or-more-documents"},{"title":"Whether this account has a password and whether it is SSO-managed","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/profile/credential-state","href":"/api-reference/profile/whether-this-account-has-a-password-and-whether-it-is-sso-managed"},{"title":"Grant or withdraw marketing consent","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/profile/marketing-consent","href":"/api-reference/profile/grant-or-withdraw-marketing-consent"},{"title":"Get current user profile","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/profile/me","href":"/api-reference/profile/get-current-user-profile"},{"title":"Update current user profile","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json patch /api/profile/me","href":"/api-reference/profile/update-current-user-profile"},{"title":"Change the authenticated user's password","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/profile/password","href":"/api-reference/profile/change-the-authenticated-users-password"}]},{"group":"service-accounts","pages":[{"title":"List all service accounts","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/service-accounts","href":"/api-reference/service-accounts/list-all-service-accounts"},{"title":"Create a new service account","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/service-accounts","href":"/api-reference/service-accounts/create-a-new-service-account"},{"title":"Get a specific service account","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/service-accounts/{service_account_id}","href":"/api-reference/service-accounts/get-a-specific-service-account"},{"title":"Delete a service account","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/service-accounts/{service_account_id}","href":"/api-reference/service-accounts/delete-a-service-account"},{"title":"Update a service account","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json patch /api/service-accounts/{service_account_id}","href":"/api-reference/service-accounts/update-a-service-account"},{"title":"List API keys for a service account","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/service-accounts/{service_account_id}/api-keys","href":"/api-reference/service-accounts/list-api-keys-for-a-service-account"},{"title":"Create an API key for a service account","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/service-accounts/{service_account_id}/api-keys","href":"/api-reference/service-accounts/create-an-api-key-for-a-service-account"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/service-accounts/{service_account_id}/api-keys/{api_key_id}","href":"/api-reference/service-accounts/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json patch /api/service-accounts/{service_account_id}/api-keys/{api_key_id}","href":"/api-reference/service-accounts/update-an-api-key"}]},{"group":"sso","pages":[{"title":"Get SSO configuration for organization","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/sso","href":"/api-reference/sso/get-sso-configuration-for-organization"},{"title":"Create SSO configuration for organization","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/sso","href":"/api-reference/sso/create-sso-configuration-for-organization"},{"title":"Remove SSO configuration for organization","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json delete /api/sso","href":"/api-reference/sso/remove-sso-configuration-for-organization"},{"title":"Update SSO metadata configuration","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json patch /api/sso","href":"/api-reference/sso/update-sso-metadata-configuration"},{"title":"Proxy SAML metadata to avoid CORS issues","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/sso/metadata","href":"/api-reference/sso/proxy-saml-metadata-to-avoid-cors-issues"},{"title":"Get Supabase SAML service-provider URLs","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/sso/service-provider-details","href":"/api-reference/sso/get-supabase-saml-service-provider-urls"}]},{"group":"task-data","pages":[{"title":"Analyze flow definition and extract schemas","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/task-data","href":"/api-reference/task-data/analyze-flow-definition-and-extract-schemas"}]},{"group":"task-executions","pages":[{"title":"List task executions with filtering","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/task-executions","href":"/api-reference/task-executions/list-task-executions-with-filtering"},{"title":"Update task execution and optionally re-execute flow","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json put /api/task-executions","href":"/api-reference/task-executions/update-task-execution-and-optionally-re-execute-flow"},{"title":"Create a task execution record","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/task-executions","href":"/api-reference/task-executions/create-a-task-execution-record"},{"title":"Retrieve a specific task execution","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/task-executions/{task_execution_id}","href":"/api-reference/task-executions/retrieve-a-specific-task-execution"}]},{"group":"task-executors","pages":[{"title":"List all available task executors","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/task-executors","href":"/api-reference/task-executors/list-all-available-task-executors"}]},{"group":"task-outputs","pages":[{"title":"List all task outputs","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/task-outputs","href":"/api-reference/task-outputs/list-all-task-outputs"},{"title":"Create task output","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json post /api/task-outputs","href":"/api-reference/task-outputs/create-task-output"},{"title":"Get task output by ID","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/task-outputs/{task_output_id}","href":"/api-reference/task-outputs/get-task-output-by-id"}]},{"group":"task-tags","pages":[{"title":"List active task tags for a flow execution","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json get /api/task-tags","href":"/api-reference/task-tags/list-active-task-tags-for-a-flow-execution"},{"title":"Add or remove task tags in batch","deprecated":null,"version":null,"openapi":"/openapi/superai-flows-openapi.json patch /api/task-tags","href":"/api-reference/task-tags/add-or-remove-task-tags-in-batch"}]}]}]},{"tab":"Changelog","icon":"bullhorn","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Create and start a flow execution - SuperAI Flows","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}