task-data
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:
- Submit a flow definition in SuperAI Flows DSL format
- The endpoint validates the structure and loads each task executor
- For each task, it extracts the output schema and any dynamic configuration data
- 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_errorsfield - 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 schemasPOST /flows: Create flow (uses task-data validation internally)PUT /flows/{flow_id}: Update flow (uses task-data validation internally)
What made this section unhelpful for you?
On this page
- task-data