Documentation Index
Fetch the complete documentation index at: https://mintlify.com/tailor-platform/sdk/llms.txt
Use this file to discover all available pages before exploring further.
Commands for managing workflows and workflow executions.
workflow
Manage workflows and workflow executions.
Usage
tailor-sdk workflow [command]
| Command | Description |
|---|
workflow list | List all workflows in the workspace |
workflow get | Get workflow details |
workflow start | Start a workflow execution |
workflow executions | List or get workflow executions |
workflow resume | Resume a failed or pending workflow execution |
workflow list
List all workflows in the workspace.
Usage
tailor-sdk workflow list [options]
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
workflow get
Get workflow details by name.
Usage
tailor-sdk workflow get [options] <name>
| Argument | Description | Required |
|---|
name | Workflow name | Yes |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
workflow start
Start a workflow execution.
Usage
tailor-sdk workflow start [options] <name>
| Argument | Description | Required |
|---|
name | Workflow name | Yes |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
--config <CONFIG> | -c | Path to SDK config file | No | "tailor.config.ts" |
--machineuser <MACHINEUSER> | -m | Machine user name | Yes | - |
--arg <ARG> | -a | Workflow argument (JSON string) | No | - |
--wait | -W | Wait for execution to complete | No | false |
--interval <INTERVAL> | -i | Polling interval when using —wait (e.g., ‘3s’, ‘500ms’, ‘1m’) | No | "3s" |
--logs | -l | Display job execution logs after completion (requires —wait) | No | false |
tailor-sdk workflow start my-workflow -m admin-machine-user
tailor-sdk workflow start my-workflow -m admin -a '{"userId": "123"}'
tailor-sdk workflow start my-workflow -m admin -W
tailor-sdk workflow start my-workflow -m admin -W -l
workflow executions
List or get workflow executions.
Usage
tailor-sdk workflow executions [options] [executionId]
| Argument | Description | Required |
|---|
executionId | Execution ID (if provided, shows details) | No |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
--workflow-name <WORKFLOW_NAME> | -n | Filter by workflow name (list mode only) | No | - |
--status <STATUS> | -s | Filter by status (list mode only) | No | - |
--wait | -W | Wait for execution to complete | No | false |
--interval <INTERVAL> | -i | Polling interval when using —wait (e.g., ‘3s’, ‘500ms’, ‘1m’) | No | "3s" |
--logs | - | Display job execution logs (detail mode only) | No | false |
tailor-sdk workflow executions
tailor-sdk workflow executions -n my-workflow
tailor-sdk workflow executions -s RUNNING
tailor-sdk workflow executions <execution-id>
tailor-sdk workflow executions <execution-id> --logs
tailor-sdk workflow executions <execution-id> -W
workflow resume
Resume a failed or pending workflow execution.
Usage
tailor-sdk workflow resume [options] <executionId>
| Argument | Description | Required |
|---|
executionId | Failed execution ID | Yes |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
--wait | -W | Wait for execution to complete | No | false |
--interval <INTERVAL> | -i | Polling interval when using —wait (e.g., ‘3s’, ‘500ms’, ‘1m’) | No | "3s" |
--logs | -l | Display job execution logs after completion (requires —wait) | No | false |
tailor-sdk workflow resume <execution-id>
tailor-sdk workflow resume <execution-id> -W
tailor-sdk workflow resume <execution-id> -W -l