> ## Documentation Index > Fetch the complete documentation index at: https://docs.flows.super.ai/llms.txt > Use this file to discover all available pages before exploring further. # List flow executions with filtering and pagination > List flow executions with filtering, sorting, and pagination. Retrieve a paginated list of flow executions for a specific flow with support for filtering by status, tags, and date ranges. Results can be sorted by creation or update time and include optional run number calculation. Context: - Returns executions for a single flow (specified by flow_id) - Excludes soft-deleted executions from results - Supports multiple filtering dimensions for flexible queries - Pagination uses offset-based approach (page/page_size) - Run numbers calculated on-demand (performance impact) Filtering Logic: - Status filter: Returns executions containing tasks with ANY of specified statuses - Tag filter: Returns executions containing tasks with ANY of specified tags - Multiple filters combined with AND logic - Empty filters return all executions Pagination: - Offset-based: page=1, page_size=10 returns first 10 results - Default: page=1, page_size=10 - Maximum page_size: 1000 results - Maximum page: 10,000 (to prevent excessive database load) - Use start_from_execution_id for cursor-like pagination Run Numbers: - include_run_number=true: Calculates sequential number (1, 2, 3...) - Based on creation time for the flow - Includes deleted executions in count (may have gaps) - Performance impact: Additional database query per execution - Recommended: Use only when displaying in UI Sorting: - sort_field: 'created_at' (when execution was created) or 'updated_at' (when execution was last modified) - sort_direction: 'asc' (oldest first) or 'desc' (newest first) - Default: sort by created_at desc (most recently created first) Performance Considerations: - Without run_number: ~50ms for 100 results - With run_number: ~200ms for 100 results (N+1 query issue) - Consider caching for frequently accessed pages - Large page_size values increase response time linearly Use Cases: - Display execution history in UI dashboard - Monitor recent execution failures (filter by status='failed') - Find executions by business context (filter by tags) - Export execution audit trail - Identify oldest pending executions (sort by created_at asc) Example Queries: - Recent failures: ?flow_id=xxx&status=failed&sort_field=created_at&sort_direction=desc&page_size=20 - Tagged executions: ?flow_id=xxx&tags=priority:high&tags=customer:acme - Paginated view: ?flow_id=xxx&page=2&page_size=50 - With run numbers: ?flow_id=xxx&include_run_number=true Related Endpoints: - GET /flow-executions/{id} - Get single execution details - POST /flow-executions - Create new execution - GET /flows/{id} - Get flow definition details ## OpenAPI ````yaml /openapi/superai-flows-openapi.json get /api/flow-executions openapi: 3.1.0 info: description: >- SuperAI Flows is a workflow orchestration platform that enables you to design, deploy, and monitor automated workflows at scale. Build complex workflows using our declarative YAML DSL, execute them reliably, and integrate seamlessly with AI models, cloud storage, and enterprise systems. **Key Capabilities:** - **Workflow Management**: Define workflows as code with version control and automated execution - **Task Orchestration**: Chain together API calls, data processing, and AI operations - **Real-time Monitoring**: Track execution progress with WebSocket notifications and comprehensive logging - **Multi-tenant Architecture**: Organization-scoped resources with role-based access control **API Versioning and Breaking Changes:** We follow a strict compatibility policy to ensure your integrations remain stable: - **Non-breaking changes** (safe, no action required): - Adding new API endpoints - Adding new optional query parameters to existing endpoints - Adding new fields to API responses - Adding new values to existing enums - **Breaking changes** (requires client updates): - Removing or renaming API endpoints - Removing query parameters or request fields - Removing response fields - Changing field types or validation rules - Removing values from existing enums **Client Implementation Requirements:** Your API clients MUST be designed to gracefully handle additional fields in responses. We may add new fields to any response object without considering this a breaking change. Ensure your JSON parsers ignore unknown fields rather than raising errors. **Backward Compatibility Guarantee:** We commit to maintaining backward compatibility for all non-breaking changes. Breaking changes will be: - Announced at least 15 days in advance - Documented in our changelog with migration guide For the latest API updates and migration guides, see our changelog. title: SuperAI Flow Platform version: 0.1.0 servers: - description: Production server url: https://flows.super.ai security: [] tags: - description: >- Flow management operations for defining and organizing workflows. Flows represent workflow definitions with tasks, dependencies, and execution logic. They serve as reusable templates that can be executed multiple times with different inputs. **What is a flow?** A flow consists of: - **Tasks**: Individual units of work that perform specific actions - **Dependencies**: Relationships between tasks that define execution order - **Configuration**: Settings and parameters that control flow behavior **Use these endpoints to:** - Create new flow definitions from scratch or import from YAML - List and search existing flows in your organization - Retrieve detailed flow information including task definitions - Update flow configurations and task parameters - Delete flows that are no longer needed Flows are the foundation of your workflow automation—once defined, they can be executed via the flow-executions endpoints. name: flows x-displayName: Flows - description: >- Flow execution operations for running and monitoring workflows. Flow executions represent runtime instances of flows. When you execute a flow, a new flow execution is created with its own unique ID, status, and execution context. Each execution is independent and maintains its own state, input data, and results. **Key concepts:** - **Execution Status**: Tracks the lifecycle (running, completed, failed, cancelled) - **Run Number**: Sequential identifier for executions of the same flow - **Execution Context**: Contains input parameters, user information, and metadata - **Task Results**: Stores outputs from each task within the execution **Use these endpoints to:** - Start new flow executions with custom input parameters - Monitor execution progress and status in real-time - Retrieve execution history and detailed results - Filter and search executions by status, date, or flow - Cancel running executions when needed - Access task-level execution details and outputs Flow executions transform flow definitions into actual work and deliverable results. name: flow-executions x-displayName: Flow Executions - description: >- Task execution operations for tracking individual task runs within flow executions. Task executions represent individual task runs within a flow execution. Each task in a flow execution has its own task execution record that tracks its lifecycle, inputs, outputs, and status. **What is tracked:** - **Status**: Current state (pending, running, completed, failed, skipped) - **Input/Output**: Data passed to and produced by the task - **Timing**: Start time, end time, and duration - **Errors**: Failure details and error messages - **Tags**: Metadata and categorization **Use these endpoints to:** - Query task execution status for debugging - Retrieve task outputs for analysis - Debug task failures with detailed error information - Track task performance and timing - Monitor task execution progress within flows Task executions provide granular visibility into workflow execution, essential for debugging and optimization. name: task-executions x-displayName: Task Executions - description: >- Task executor operations for discovering available task types and their capabilities. Task executors define the available task types that can be used in flow definitions. Each executor specifies its input schema, execution behavior, and capabilities. This endpoint enables programmatic discovery of task types for building flows dynamically. **What task executors provide:** - **Input Schema**: JSON Schema defining required and optional parameters - **Output Schema**: Expected output structure and data types - **Description**: Human-readable explanation of functionality - **Agent Prompts**: Instructions for AI-powered flow generation **Use these endpoints to:** - Discover available task types for flow building - View task input/output schemas for validation - Understand task capabilities and requirements - Build flow builder UIs with dynamic task lists - Enable AI agents to select appropriate tasks Task executors enable dynamic, flexible workflow creation by providing a registry of available operations. name: task-executors x-displayName: Task Executors - description: >- Task output operations for storing and retrieving task execution results. Task outputs store the results produced by task executions in a structured, queryable format. While task executions track the full lifecycle (input, output, error, status), task outputs focus specifically on the final output data formatted for display, analysis, and downstream consumption. **Key characteristics:** - **Summary Field**: Structured output data ready for consumption - **Historical Record**: Permanent storage of task results - **Queryable**: Filter and search outputs by task, execution, or flow - **Linked**: Connected to parent flow execution and task execution **Use these endpoints to:** - Store task results after successful execution - Retrieve outputs for specific tasks or entire executions - Query historical outputs for analysis and reporting - Access formatted results for display in dashboards - Feed outputs to downstream tasks or external systems Task outputs provide the data foundation for workflow analytics, debugging, and result visualization. name: task-outputs x-displayName: Task Outputs - description: >- Task data operations for flow validation, schema discovery, and dynamic configuration. The task-data endpoint analyzes flow definitions to extract task output schemas, dynamic configuration options, and validation errors. This is essential for building flow configuration UIs, validating flows before execution, and understanding task data structures. **Primary Use Cases:** - **Flow Builder UI**: Get task output schemas for validating downstream task inputs - **Schema Discovery**: Understand the structure of data each task produces - **Dynamic Configuration**: Retrieve runtime-dependent options (e.g., available spreadsheets, database tables) - **Flow Validation**: Validate flow definitions programmatically before saving or executing - **Custom Integrations**: Build tools that work with SuperAI Flows programmatically **What You Get:** - **Output Schemas**: JSON Schema definitions for each task's output structure - **Dynamic Data**: Runtime-dependent configuration options (dropdown choices, conditional fields) - **Validation Errors**: Detailed error messages for invalid flow definitions **How It Works:** 1. Submit a flow definition in SuperAI Flows DSL format 2. The endpoint validates the structure and loads each task executor 3. For each task, it extracts the output schema and any dynamic configuration data 4. Returns all schemas, dynamic data, and any validation errors encountered **Key Concepts:** - **Output Schema**: JSON Schema describing the structure of data a task produces - **Dynamic Data**: Configuration options that depend on user credentials or external state (e.g., list of Google Sheets accessible with your credentials) - **Validation Levels**: Basic (structure only) vs Full (includes semantic validation) **Integration Notes:** - The flow builder frontend uses this endpoint to power the task configuration UI - Flows API uses this validation internally when creating/updating flows - Response includes validation errors even on HTTP 200 - always check `validation_errors` field - May make external API calls to fetch dynamic data, so response time varies (100ms-2s typical) **Related Endpoints:** - `GET /task-executors`: List available task executor types and their schemas - `POST /flows`: Create flow (uses task-data validation internally) - `PUT /flows/{flow_id}`: Update flow (uses task-data validation internally) name: task-data x-displayName: Task Data - description: >- Task tag operations for categorizing and organizing tasks with metadata. Task tags provide metadata and categorization for tasks within flow executions. Tags enable flexible organization, filtering, and grouping of tasks beyond their structural relationships. **What tags enable:** - **Categorization**: Group related tasks across different flows - **Filtering**: Query executions by tag criteria - **Metadata**: Attach custom key-value pairs to tasks - **Organization**: Create logical groupings for reporting **Use these endpoints to:** - Manage task labels and categories - Add organizational metadata to tasks - Query tasks by tag criteria - Build custom views and dashboards Task tags provide flexible organization capabilities that enhance workflow management and analysis. name: task-tags x-displayName: Task Tags - description: >- Integration operations for connecting flows to external services and platforms. Integrations enable your workflows to interact with third-party services, databases, storage systems, and communication platforms. They provide a unified interface for managing credentials, testing connections, and configuring service-specific features. **Supported integration types:** - **Databases**: PostgreSQL, MySQL, and other SQL databases - **Storage**: SFTP, cloud storage, and file systems - **Communication**: Email (SMTP, SES), webhooks, notifications - **Collaboration**: SharePoint, Google Drive, document management - **Custom**: Plugin architecture for extending functionality **Key concepts:** - **Credentials**: Securely stored authentication information per integration - **Plugins**: Modular integration implementations with discovery and registration - **OAuth Flows**: Automated authorization for third-party services - **Webhooks**: Inbound event handling from external platforms - **Connection Testing**: Validate credentials and connectivity before use **Use these endpoints to:** - Configure and manage integration credentials - Test connections to external services - Handle OAuth authorization flows for cloud services - Set up and manage webhooks for inbound events - Discover available integration capabilities - Access integration-specific features (folders, schemas, etc.) Integrations bridge your workflows with the external world, enabling powerful automation across your entire technology stack. name: integrations x-displayName: Integrations - description: >- Authentication operations for user authentication, authorization, and session management. Authentication endpoints handle user identity verification, token generation, and access control throughout the platform. The system uses JWT (JSON Web Token) based authentication managed through core.flows.super.ai. **Authentication flow:** 1. Obtain credentials from your account at core.flows.super.ai 2. Authenticate to receive JWT access token and refresh token 3. Include access token in API requests via Authorization header 4. API validates tokens and extracts user identity and organization context 5. Tokens expire after 1 hour and must be refreshed **Key concepts:** - **Bearer Tokens**: Short-lived JWT tokens (1 hour) used for API requests - **Anon-Key**: Long-lived API key used to authenticate to the authentication API. - **Refresh Tokens**: Long-lived tokens used to obtain new access tokens - **Protected Routes**: Most endpoints require valid authentication - **Public Endpoints**: Limited whitelisted paths accessible without auth **Getting started with authentication:** 1. **Obtain your Anonymous Key** (public endpoint - no authentication required): ```bash curl https://flows.super.ai/api/auth/anon-key ``` 2. **Authenticate** to receive your tokens: ```bash curl -X POST 'https://core.flows.super.ai/auth/v1/token?grant_type=password' \ -H 'Content-Type: application/json' \ -H 'apikey: ANON_KEY' \ -d '{"email": "you@example.com", "password": "your-password"}' ``` This will return a JWT access token and refresh token. 3. **Use the access token** in your requests: ```bash curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://flows.super.ai/api/flows ``` **Token management:** - Access tokens expire after 1 hour - Use refresh tokens to obtain new access tokens without re-authenticating - Store tokens securely and never commit them to version control All API endpoints (except whitelisted public paths) require authentication. Include your bearer token in the Authorization header: `Bearer ` name: auth x-displayName: Authentication - description: >- User profile operations for viewing and updating account information. Profile endpoints allow authenticated users to view and update their own account information and preferences. These endpoints operate on the currently authenticated user (determined from the JWT token) and do not require specifying a user ID. **Account information includes:** - **Personal Details**: First name, last name, email - **Organization**: Associated organization and role - **Status**: Account status and permissions - **Metadata**: Created/updated timestamps **Use these endpoints to:** - Retrieve current user information for display - Update personal details (name, preferences) - View organization membership and role - Access account metadata Profile endpoints provide self-service account management capabilities, reducing the need for administrative intervention for routine updates. **Note:** All profile endpoints are protected and automatically scope to the authenticated user. Email and organization changes require admin privileges. name: profile x-displayName: Profile - description: >- Model operations for querying available AI models and their configurations. Model endpoints provide information about the AI models available through the platform. These endpoints enable discovery of models, their capabilities, and regional availability. **Key features:** - **Model Discovery**: List all available AI models - **Regional Filtering**: Query models by geographic region (EU, Global) - **Model Metadata**: Access model information including provider, location, and capabilities **Use these endpoints to:** - Discover available AI models for your workflows - Filter models by region for compliance or latency requirements - Retrieve model metadata for configuration and selection - Build dynamic model selection UIs **Regional filtering:** - `eu`: Models deployed in European regions (West Europe, France Central, Germany, Sweden) - `global`: Models deployed in US and other global regions Model endpoints enable intelligent model selection and routing based on your requirements for compliance, performance, and cost. name: models x-displayName: Models - description: >- File download operations for retrieving files from gs:// storage URIs. When Super.AI Flows processes documents, task outputs often include file references as `gs://` URIs pointing to Google Cloud Storage. These endpoints let you download those files without needing to understand GCS internals or parse storage URLs. **The problem these endpoints solve:** Previously, downloading a file required: 1. Recognizing the URL as a GCS reference 2. Parsing out the file key from the URI 3. Calling a separate endpoint to get a signed URL 4. Downloading using that signed URL **Now it's simple:** Pass the `gs://` URI exactly as received and get your file. **Two ways to download:** 1. **Direct download** (`GET /files/download`): Returns a redirect to the file. Perfect for curl with `-L` flag. ``` curl -L -H "X-API-Key: saf_xxx" "https://flows.super.ai/api/files/download?uri=gs://..." -o file.pdf ``` 2. **Resolve first** (`POST /files/resolve`): Returns a JSON response with the download URL. Better for programmatic use and sensitive files (keeps URI out of logs). ``` curl -X POST "https://flows.super.ai/api/files/resolve" \ -H "X-API-Key: saf_xxx" \ -H "Content-Type: application/json" \ -d '{"uri": "gs://..."}' ``` **Security:** - Files are organization-scoped: you can only download files from flows your organization owns - URIs are validated to prevent path traversal attacks - Download URLs expire after 1 hour **Common use cases:** - Download processed documents from completed flow executions - Retrieve extracted data files from task outputs - Integrate file downloads into automated pipelines name: files x-displayName: Files - description: >- Human review task operations for creating and managing human-in-the-loop review workflows. name: human-review-tasks x-displayName: Human Review Tasks - description: >- Service account operations for managing programmatic API access credentials. name: service-accounts x-displayName: Service Accounts - description: >- Organization operations for viewing credit balance and organization-scoped information. name: organizations x-displayName: Organizations - description: Single Sign-On operations for configuring SAML-based SSO authentication. name: sso x-displayName: SSO - description: >- Plugin operations for managing integration plugin instances, OAuth flows, and webhooks. name: plugins x-displayName: Plugins paths: /api/flow-executions: get: tags: - flow-executions summary: List flow executions with filtering and pagination description: >- List flow executions with filtering, sorting, and pagination. Retrieve a paginated list of flow executions for a specific flow with support for filtering by status, tags, and date ranges. Results can be sorted by creation or update time and include optional run number calculation. Context: - Returns executions for a single flow (specified by flow_id) - Excludes soft-deleted executions from results - Supports multiple filtering dimensions for flexible queries - Pagination uses offset-based approach (page/page_size) - Run numbers calculated on-demand (performance impact) Filtering Logic: - Status filter: Returns executions containing tasks with ANY of specified statuses - Tag filter: Returns executions containing tasks with ANY of specified tags - Multiple filters combined with AND logic - Empty filters return all executions Pagination: - Offset-based: page=1, page_size=10 returns first 10 results - Default: page=1, page_size=10 - Maximum page_size: 1000 results - Maximum page: 10,000 (to prevent excessive database load) - Use start_from_execution_id for cursor-like pagination Run Numbers: - include_run_number=true: Calculates sequential number (1, 2, 3...) - Based on creation time for the flow - Includes deleted executions in count (may have gaps) - Performance impact: Additional database query per execution - Recommended: Use only when displaying in UI Sorting: - sort_field: 'created_at' (when execution was created) or 'updated_at' (when execution was last modified) - sort_direction: 'asc' (oldest first) or 'desc' (newest first) - Default: sort by created_at desc (most recently created first) Performance Considerations: - Without run_number: ~50ms for 100 results - With run_number: ~200ms for 100 results (N+1 query issue) - Consider caching for frequently accessed pages - Large page_size values increase response time linearly Use Cases: - Display execution history in UI dashboard - Monitor recent execution failures (filter by status='failed') - Find executions by business context (filter by tags) - Export execution audit trail - Identify oldest pending executions (sort by created_at asc) Example Queries: - Recent failures: ?flow_id=xxx&status=failed&sort_field=created_at&sort_direction=desc&page_size=20 - Tagged executions: ?flow_id=xxx&tags=priority:high&tags=customer:acme - Paginated view: ?flow_id=xxx&page=2&page_size=50 - With run numbers: ?flow_id=xxx&include_run_number=true Related Endpoints: - GET /flow-executions/{id} - Get single execution details - POST /flow-executions - Create new execution - GET /flows/{id} - Get flow definition details operationId: list_flow_executions_api_flow_executions_get parameters: - description: UUID of the flow to list executions for. Required parameter. example: 550e8400-e29b-41d4-a716-446655440000 in: query name: flow_id required: true schema: description: UUID of the flow to list executions for. Required parameter. format: uuid title: Flow Id type: string - description: >- Field to sort results by. Valid values: 'created_at', 'updated_at'. Defaults to 'created_at' for most recently modified first. example: created_at in: query name: sort_field required: false schema: anyOf: - pattern: ^(created_at|updated_at)$ type: string - type: 'null' description: >- Field to sort results by. Valid values: 'created_at', 'updated_at'. Defaults to 'created_at' for most recently modified first. title: Sort Field - description: >- Sort order direction. Valid values: 'asc' (ascending), 'desc' (descending). Defaults to 'desc' for newest first. example: desc in: query name: sort_direction required: false schema: anyOf: - pattern: ^(asc|desc)$ type: string - type: 'null' description: >- Sort order direction. Valid values: 'asc' (ascending), 'desc' (descending). Defaults to 'desc' for newest first. title: Sort Direction - description: >- Filter by execution status. Can specify multiple values. Valid values: 'queued', 'running', 'in_progress', 'completed', 'failed', 'stale'. Returns executions containing tasks with ANY of the specified statuses. Example: ?status=failed&status=running example: - running - completed in: query name: status required: false schema: anyOf: - items: type: string type: array - type: 'null' description: >- Filter by execution status. Can specify multiple values. Valid values: 'queued', 'running', 'in_progress', 'completed', 'failed', 'stale'. Returns executions containing tasks with ANY of the specified statuses. Example: ?status=failed&status=running title: Status - description: >- Filter by task tags. Can specify multiple values. Returns executions containing tasks with ANY of the specified tags. Tags use key:value format. Example: ?tags=priority:high&tags=env:prod example: - priority:high - department:finance in: query name: tags required: false schema: anyOf: - items: type: string type: array - type: 'null' description: >- Filter by task tags. Can specify multiple values. Returns executions containing tasks with ANY of the specified tags. Tags use key:value format. Example: ?tags=priority:high&tags=env:prod title: Tags - description: >- Calculate sequential run number for each execution. Run numbers start at 1 and increment based on creation time. Warning: Adds performance overhead (~150ms per 100 executions). Recommended only for UI display purposes. example: false in: query name: include_run_number required: false schema: default: false description: >- Calculate sequential run number for each execution. Run numbers start at 1 and increment based on creation time. Warning: Adds performance overhead (~150ms per 100 executions). Recommended only for UI display purposes. title: Include Run Number type: boolean - description: >- Page number for pagination (1-indexed). Minimum: 1, Maximum: 10,000. Works with page_size to implement offset-based pagination. example: 1 in: query name: page required: false schema: default: 1 description: >- Page number for pagination (1-indexed). Minimum: 1, Maximum: 10,000. Works with page_size to implement offset-based pagination. maximum: 10000 minimum: 1 title: Page type: integer - description: >- Number of results to return per page. Minimum: 1, Maximum: 1000. Larger values increase response time. Recommended: 10-100. example: 10 in: query name: page_size required: false schema: default: 10 description: >- Number of results to return per page. Minimum: 1, Maximum: 1000. Larger values increase response time. Recommended: 10-100. maximum: 1000 minimum: 1 title: Page Size type: integer - description: >- Start listing after this execution ID. Provides cursor-like pagination. When combined with sort parameters, returns results after the specified execution. Useful for infinite scroll or keyset pagination patterns. example: 550e8400-e29b-41d4-a716-446655440000 in: query name: start_from_execution_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: >- Start listing after this execution ID. Provides cursor-like pagination. When combined with sort parameters, returns results after the specified execution. Useful for infinite scroll or keyset pagination patterns. title: Start From Execution Id responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/FlowExecutionResponseWithRunNumber' title: Response List Flow Executions Api Flow Executions Get type: array description: List of flow executions successfully retrieved '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request - Invalid query parameters '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Forbidden - User lacks permission to view this flow's executions '404': content: application/json: examples: flow_not_found: summary: Flow not found value: error: code: not_found message: Flow not found request_id: 01K8KACP7D2XFGHJ9KLM4NPQR8 resource_not_found: summary: Resource not found value: error: code: not_found message: Resource not found request_id: 01K8KABR6S16YETA2SZPVBS9SP schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found - The requested resource does not exist '422': content: application/json: examples: type_error: summary: Type validation error value: error: code: validation_error details: - input: not-a-uuid loc: - path - flow_id msg: Input should be a valid UUID type: uuid_parsing message: Request validation failed request_id: 01K8KACP7D2XFGHJ9KLM4NPQR8 validation_error: summary: Validation error value: error: code: validation_error details: - loc: - body - name msg: Field required type: missing message: Request validation failed request_id: 01K8KABR6S16YETA2SZPVBS9SP schema: $ref: '#/components/schemas/ErrorResponse' description: Unprocessable Entity - Request validation failed '500': content: application/json: examples: internal_error: summary: Internal server error value: error: code: internal_error message: Internal server error request_id: 01K8KABR6S16YETA2SZPVBS9SP repository_error: summary: Database error value: error: code: repository_error message: Database operation failed request_id: 01K8KACP7D2XFGHJ9KLM4NPQR8 schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error - An unexpected error occurred security: - APIKeyAuth: [] BearerAuth: [] components: schemas: FlowExecutionResponseWithRunNumber: description: |- Flow execution response with optional sequential run number. Extends FlowExecutionResponse to include an optional run_number field that indicates the sequential position of this execution among all executions for the same flow (including deleted ones). properties: created_at: format: date-time title: Created At type: string flow_id: description: >- UUID of the flow definition being executed. References the parent flow that defines the workflow structure. example: 550e8400-e29b-41d4-a716-446655440000 format: uuid title: Flow Id type: string 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. example: 3 minimum: 1 title: Flow Version type: integer id: format: uuid title: Id type: string 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. example: file_key: documents/abc123.pdf metadata: priority: high title: Input type: object modified_by: title: Modified By type: 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. example: 660e8400-e29b-41d4-a716-446655440001 format: uuid title: Organization Id type: string run_number: anyOf: - minimum: 1 type: integer - type: 'null' description: >- Sequential run number for this execution within its flow. Starts at 1 for the first execution and increments by creation time. Includes deleted executions in count, so visible numbers may have gaps. Only populated when include_run_number=true query parameter is set. Null when not requested to avoid performance overhead. example: 42 title: Run Number status: description: >- Current execution status. Possible values: 'queued', 'running', 'in_progress', 'completed', 'failed', 'deleted', 'stale'. Status transitions: queued → running → in_progress → completed/failed. Use 'completed' to indicate success, 'failed' for errors. example: running title: Status type: string updated_at: format: date-time title: Updated At type: string required: - id - created_at - updated_at - modified_by - flow_id - flow_version - status - input - organization_id title: FlowExecutionResponseWithRunNumber type: object ErrorResponse: description: |- Standard API error response structure. All error responses from the API follow this format, ensuring consistent error handling for API consumers. Example: { "error": { "message": "Flow not found", "code": "not_found" }, "request_id": "01K8KABR6S16YETA2SZPVBS9SP" } examples: - error: code: not_found message: Resource not found request_id: 01K8KABR6S16YETA2SZPVBS9SP properties: error: $ref: '#/components/schemas/ErrorDetail' request_id: anyOf: - type: string - type: 'null' description: >- Unique request identifier in ULID format for debugging and support. Example: 01K8KABR6S16YETA2SZPVBS9SP title: Request Id required: - error title: ErrorResponse type: object ErrorDetail: description: |- Standard error detail structure. This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py. properties: code: anyOf: - type: string - type: 'null' description: Machine-readable error code for programmatic handling title: Code details: anyOf: - items: type: string type: array - items: additionalProperties: true type: object type: array - additionalProperties: true type: object - type: 'null' description: >- Additional error context, validation errors, or debugging information title: Details message: description: Human-readable error message title: Message type: string required: - message title: ErrorDetail type: object securitySchemes: APIKeyAuth: description: >- API key authentication. Include your API key in the X-API-Key header as: `X-API-Key YOUR_API_KEY` Example: ``` X-API-Key: saf_1234567890 ``` in: header name: X-API-Key type: apiKey BearerAuth: bearerFormat: JWT description: >- JWT Bearer token authentication. Include your access token in the Authorization header as: `Bearer YOUR_ACCESS_TOKEN` Example: ``` Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... ``` scheme: bearer type: http ````