Analyze flow definition and extract schemas

Analyze a flow definition to extract task output schemas, dynamic data, and validation errors.

Overview This endpoint validates a flow definition and returns metadata needed for flow building, execution planning, and UI generation. It processes all tasks in the flow definition to extract their output schemas (for type validation), dynamic configuration data (for UI dropdowns and conditional fields), and any structural or semantic validation errors.

Use Cases

• Flow Builder UI: Get task output schemas for downstream task input validation
• Dynamic Configuration: Retrieve runtime-dependent options (e.g., available spreadsheets, databases)
• Flow Validation: Check for errors before saving or executing a flow
• Schema Discovery: Understand what data each task will produce
• Custom Integrations: Programmatically validate and analyze flow definitions

How It Works

1. Parses and validates the flow definition structure (basic validation)
2. For each task in the flow:
   • Loads the task executor implementation
   • Calls the executor's get_output_model() to get the output schema
   • Calls the executor's dynamic data methods (if available) to get runtime options
   • Collects any errors encountered during schema/data extraction
3. If full_validation=true, performs additional semantic validation (checks task parameter values, validates connections between tasks, etc.)
4. Returns all schemas, dynamic data, and validation errors in a single response

Dynamic Data Explained Dynamic data represents configuration options that depend on external state or user credentials. For example:

• Google Sheets task: List of spreadsheets accessible with user's credentials
• Database task: List of available tables/columns
• API task: Available endpoints or data models from connected service

Validation Levels

• Basic (default): Structure validation only (required fields, data types)
• Full (full_validation=true): Includes semantic validation (valid references, parameter constraints, external resource availability)

Performance Notes

• May make external API calls to fetch dynamic data (e.g., Google Sheets API)
• Response time varies based on number of tasks and external service latency
• Typical response time: 100ms-2s depending on task executors used

Related Endpoints

• POST /flows - Create flow (uses this endpoint's validation internally)
• PUT /flows/{flow_id} - Update flow (uses this endpoint's validation internally)
• GET /task-executors - List available task executors