id string
Unique identifier for the streamline tool. Format: auto_ followed by alphanumeric characters.
name string
Human-readable name for the automation workflow.
description string
Detailed description of what the workflow does and its purpose.
category string
Workflow category. Values: marketing, sales, hr, it, operations, communication, data_processing.
workflowType string
Type of workflow execution. Values: sequential, parallel, conditional, event_driven.
triggerType string
How the workflow can be triggered. Values: manual, scheduled, event, api.
capabilities object
Technical capabilities and execution details.
Show capabilities
executionTime object
Expected execution time ranges.
Show execution time
minimum integer
Minimum execution time in seconds.
maximum integer
Maximum execution time in seconds.
average integer
Average execution time in seconds.
supportedParameters array of objects
Parameters that can be passed to the workflow.
Show parameter structure
name string
Parameter name.
type string
Parameter data type (e.g., "string", "number", "boolean", "object").
required boolean
Whether the parameter is mandatory.
description string
Description of what the parameter controls.
default any optional
Default value if not provided.
outputFormat object
What the workflow returns upon completion.
Show output format
success object
Structure of successful execution response.
error object
Structure of error response.
status array of strings
Possible status values. Example: ["pending", "running", "completed", "failed"].
pricing object optional
Pricing information for workflow execution.
Show pricing
costPerExecution number
Cost per workflow run.
freeTier integer optional
Number of free executions per month.
volumeDiscount object optional
Discounts for high-volume usage.
permissions object
Required permissions to execute this workflow.
Show permissions
requiredRoles array of strings optional
User roles required to trigger. Example: ["admin", "manager"].
requiredScopes array of strings optional
API scopes required. Example: ["automation:execute", "data:write"].
status string
Workflow availability status. Values: active, inactive, maintenance, deprecated.
isTemplate boolean
Whether this is a template workflow that can be customized.
createdBy string
User ID of the person who created this workflow.
createdAt integer
Unix timestamp (seconds) when the workflow was created.
updatedAt integer
Unix timestamp (seconds) when the workflow was last updated.
A ApiResponse object containing the API response data.
{
"id": "auto_email_campaign",
"name": "Email Campaign Automation",
"description": "Automated email campaign creation and distribution workflow with A/B testing and analytics.",
"category": "marketing",
"workflowType": "sequential",
"triggerType": "manual",
"capabilities": {
"executionTime": {
"minimum": 30,
"maximum": 3600,
"average": 300
},
"supportedParameters": [
{
"name": "campaignName",
"type": "string",
"required": true,
"description": "Name of the email campaign"
},
{
"name": "targetAudience",
"type": "array",
"required": true,
"description": "List of recipient email addresses"
},
{
"name": "contentTemplate",
"type": "string",
"required": false,
"description": "Email template to use",
"default": "default_template"
}
],
"outputFormat": {
"success": {
"campaignId": "string",
"sentCount": "number",
"openRate": "number"
},
"error": {
"errorCode": "string",
"message": "string"
},
"status": ["pending", "running", "completed", "failed"]
}
},
"pricing": {
"costPerExecution": 0.5,
"freeTier": 10,
"volumeDiscount": {
"tier1": { "minExecutions": 100, "discountPercent": 10 },
"tier2": { "minExecutions": 500, "discountPercent": 25 }
}
},
"permissions": {
"requiredRoles": ["marketing", "admin"],
"requiredScopes": ["email:send", "analytics:read"]
},
"status": "active",
"isTemplate": false,
"createdBy": "user_marketing_manager",
"createdAt": 1728057600,
"updatedAt": 1728057600
}