SuperAI Flows

Build reliable, scalable workflows that orchestrate AI models, data processing, and business logic through a simple API.

Docs

• Resend user invitation email: Resend invitation email to an existing user account.
• Retrieve authentication API key: Retrieve the anonymous authentication key required for client authentication.
• Authentication: How to authenticate with the SuperAI Flows API using JWT bearer tokens or service-account API keys.
• Error Codes: Error response format, HTTP status codes, and the full catalog of machine-readable error codes.
• Download file by URI (with redirect): Download a file by resolving its gs:// storage URI.
• Resolve storage URI to download URL: Resolve a gs:// storage URI to a temporary pre-signed download URL.
• Add task status updates (Internal API): Add task status updates to a flow execution (Internal API).
• Create and start a flow execution: Create a new flow execution and start workflow processing.
• List flow executions with filtering and pagination: List flow executions with filtering, sorting, and pagination.
• Patch Flow Execution Status: Patch the status of a flow execution.
• Re-execute a flow execution: Re-execute a flow execution, optionally skipping cached results.
• Retrieve a specific flow execution: Retrieve detailed information for a specific flow execution.
• Soft delete a flow execution: Soft delete a flow execution by marking it as deleted.
• Create a new flow: Create a new flow in draft status.
• Delete a flow: Soft delete a flow.
• Generate file download URL: Generate pre-signed URL for downloading a flow file.
• Generate file upload URL: Generate pre-signed URL for uploading files to a flow.
• Get specific flow version: Retrieve a specific version of a flow.
• List all flows: List all flows accessible to the authenticated user.
• List all versions of a flow: List all versions of a specific flow.
• List flow files: List all files associated with a flow.
• List flow invitations: List all invitations for a specific flow.
• List task summaries for flow version: List task execution summaries for a specific flow version.
• Partially update a flow: Partially update flow properties.
• Remove user invitations from a flow: Remove invitations for specific users from a flow.
• Retrieve a flow by ID: Retrieve a specific flow by ID.
• Update a single task in flow: Update a single task within a flow definition.
• Update flow definition: Update the complete definition of a flow.
• Upsert user invitations to a flow: Upsert invitations for multiple users to access a flow.
• Complete a human review task: Complete a human review task.
• Create a new human review task: Create a new human review task with assigned users.
• Get a human review task by ID: Get a human review task by its ID.
• List all assignments for a human review task: List all assignments for a human review task.
• List human review tasks assigned to the current user: List all human review tasks assigned to the current user.
• Start a human review task: Start a human review task.
• Unstart a human review task assignment: Unstart a human review task assignment.
• Compare Csv For Replace: Compare existing CSV with new CSV for replace operation.
• Complete File Upload: Complete file upload and process the file.
• Create Database: Create a new CSV database instance.
• Create Email Task: Create a new email task with a unique email address.
• Create integration credentials: Create new integration credentials for connecting to external services.
• Create Integration Legacy
• Delete credential: Soft-delete an integration credential.
• Delete database: Delete a database integration.
• Delete File
• Delete Integration Legacy
• Execute Postgres Plugin Task: Execute PostgreSQL task using the new plugin system.
• Generate database upload URL: Generate a pre-signed URL for uploading files to a database.
• Get credential by ID: Retrieve metadata for a specific integration credential.
• Get credential secrets: Retrieve decrypted credential secrets for integration use.
• Get database by ID: Retrieve detailed information for a specific database.
• Get database columns: Retrieve column names from a specific database.
• Get Download Url: Generate pre-signed URL for downloading the database CSV file.
• Get Email Task Status: Get status of an email task.
• Get plugin capabilities: Retrieve detailed capabilities of a specific plugin.
• Get Sharepoint Drives
• Get Sharepoint Sites
• Handle Webhook Legacy
• List all registered plugins: List all registered plugins from the integration registry.
• List credentials by provider: Retrieve user credentials filtered by integration provider.
• List Folders
• List integration catalog: Retrieve the catalog of available third-party integrations.
• List Integration Instances
• List user credentials: Retrieve all integration credentials for the authenticated user.
• List user databases: List all databases accessible to the authenticated user.
• Move File
• Oauth Authorize Legacy
• Oauth Callback Legacy
• Preview CSV file before import: Preview CSV file before final import.
• Process Emails: Manually trigger email processing (for testing).
• Replace File Upload: Replace existing database data with new file upload.
• Test Postgres Connection: Test PostgreSQL connection (proxied to legacy system).
• Test Postgres Connection By Credential Id: Test PostgreSQL connection by credential ID (proxied to legacy system).
• Test Postgres Plugin Connection: Test PostgreSQL connection using the new plugin system.
• Test Sftp Connection: Test SFTP connection by attempting to connect and write a test file.
• Update credential: Update existing integration credentials with new values.
• Overview: The SuperAI Flows REST API — base URL, conventions, and how the reference is organized.
• MCP Server: Connect external AI agents and MCP-compatible clients to SuperAI Flows over the Model Context Protocol.
• List available models: Retrieve a list of available AI models, deduplicated by model name and optionally filtered by region.
• Get credit balance for current user's organization: Get credit balance for the current user's organization.
• Create Integration
• Delete Integration
• Execute Integration
• Get Ui Schema
• Handle Webhook
• List Instances
• List Integrations
• Oauth Authorize
• Oauth Callback
• Update Integration
• Get current user profile: Retrieve complete profile information for the currently authenticated user.
• Update current user profile: Update the currently authenticated user's profile information.
• Activate a service account: Activate a service account.
• Create a new service account: Create a new service account.
• Create an API key for a service account: Create a new API key for a specific service account.
• Deactivate a service account: Deactivate a service account.
• Delete a service account: Delete a service account.
• Get a specific service account: Get details for a specific service account.
• List all service accounts: List all service accounts accessible to the current user.
• List API keys for a service account: List all API keys associated with a specific service account.
• Update a service account: Update a service account.
• Create SSO configuration for organization: Create SSO configuration for the current user's organization.
• Get SSO configuration for organization: Get SSO configuration for the current user's organization.
• Proxy SAML metadata to avoid CORS issues: Fetches SAML metadata from external URLs to avoid browser CORS restrictions
• Remove SSO configuration for organization: Remove SSO configuration for the current user's organization.
• Update SSO metadata configuration: Update SSO metadata configuration for the current user's organization.
• Analyze flow definition and extract schemas: Analyze a flow definition to extract task output schemas, dynamic data, and validation errors.
• Create a task execution record: Create a new task execution record for a specific task within a flow execution.
• List task executions with filtering: List task executions with optional filtering by flow execution, task name, or execution index.
• Retrieve a specific task execution: Retrieve a specific task execution by its unique identifier.
• Update task execution and optionally re-execute flow: Update an existing task execution and optionally trigger flow re-execution.
• List all available task executors: List all available task executors for workflow composition.
• Create task output: Create a task output record for a completed task and notify connected clients.
• Get task output by ID: Retrieve a specific task output by its unique identifier.
• List all task outputs: List all task outputs across all flow executions in your organization.
• Add or remove task tags in batch: Add or remove tags from task executions in batch operations.
• List active task tags for a flow execution: List all active tags for task executions within a flow execution.
• Downloading Files: Download files from gs:// URLs returned in your flow execution outputs.
• Introduction: Build reliable, scalable workflows that orchestrate AI models, data processing, and business logic — all through a simple API.
• API Quickstart: Start processing documents with SuperAI Flows in under 5 minutes — authenticate, run your first workflow, and retrieve results.

OpenAPI Specs

• superai-flows-openapi