create_flow
Build API automation workflows by defining sequential HTTP steps with data passing between requests, variable inputs, and execution configuration for testing and integration scenarios.
Instructions
Create a new flow in the project using Steps format for API automation
Example format: { "name": "User Registration Flow", "description": "Complete user registration with email verification", "folderId": "fld_456", "flow_data": { "version": "1.0", "steps": [ { "id": "register_user", "name": "Register New User", "method": "POST", "url": "{{baseUrl}}/api/users/register", "headers": {"Content-Type": "application/json"}, "body": "{"name": "{{userName}}", "email": "{{userEmail}}", "password": "{{password}}"}", "outputs": {"userId": "response.body.id", "activationToken": "response.body.token"} }, { "id": "verify_email", "name": "Verify Email Address", "method": "POST", "url": "{{baseUrl}}/api/auth/verify", "headers": {"Content-Type": "application/json"}, "body": "{"token": "{{register_user.activationToken}}"}", "outputs": {"verificationStatus": "response.body.status"} } ], "config": {"delay": 1000, "retryCount": 2, "parallel": false} }, "flow_inputs": [ {"name": "baseUrl", "type": "string", "required": true, "description": "Base API URL"}, {"name": "userName", "type": "string", "required": true, "description": "User full name"}, {"name": "userEmail", "type": "email", "required": true, "description": "User email"}, {"name": "password", "type": "password", "required": true, "description": "User password"} ] }
2-step API Testing Example: { "name": "API Integration Test", "description": "Test user creation and retrieval", "flow_data": { "version": "1.0", "steps": [ { "id": "create_user", "name": "Create User", "method": "POST", "url": "https://api.example.com/users", "headers": {"Authorization": "Bearer {{apiKey}}"}, "body": "{"name": "Test User", "email": "test@example.com"}", "expectedStatus": 201, "outputs": {"newUserId": "response.body.id"} }, { "id": "get_user", "name": "Retrieve Created User", "method": "GET", "url": "https://api.example.com/users/{{create_user.newUserId}}", "headers": {"Authorization": "Bearer {{apiKey}}"}, "expectedStatus": 200, "outputs": {"userData": "response.body"} } ] } }
Common mistakes:
❌ Empty steps array
❌ Missing required step fields (id, name, method, url)
❌ Invalid step references (must use {{step.output}})
✅ Use {{input.var}} for flow inputs
✅ Use {{step.output}} for chaining steps
✅ Define outputs to pass data between steps
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the flow (required) | |
| description | No | Description of the flow (optional) | |
| folderId | No | Folder ID to organize the flow (optional) | |
| flow_data | No | Flow data following backend Steps format | |
| flow_inputs | No | Dynamic input definitions for variable interpolation | |
| is_active | No | Flow active status (default: true) |