API Input
Define the input schema for your flow when it's called via API.
The API Input node does two things depending on context:
- During development — it uses the test data you provide so you can run and test the flow without making a real API call
- When deployed — it receives and validates the actual JSON payload sent to your flow's API endpoint
This node is the entry point for any flow you plan to deploy as an API.
Configuration
| Field | Description |
|---|---|
| JSON Schema | Defines the expected structure and required fields of the incoming API payload |
| Test Data | Sample data used when running the flow in the editor — must match the schema |
| Tag | Optional label to reference this input in downstream nodes |
Outputs
| Output | Description |
|---|---|
json_data | The parsed input data — test data in the editor, live payload when deployed |
schema_validation | Validation result confirming the input matched the expected schema |
Tips
- Define your schema carefully — it becomes the API contract for your deployed flow
- Always fill in Test Data so you can run the flow in the editor without deploying first
- Connect directly to a Use AI Model or Custom Code node to process the incoming payload
- See the Deployment documentation for how to call your flow's endpoint once deployed