SDK API Reference / WorkflowSDK

Class: WorkflowSDK

Workflow operations API

Methods

attempt()

attempt(attemptId): Promise<WorkflowAttempt>

Get a specific attempt

Parameters

attemptId

string

Attempt ID

Returns

Promise<WorkflowAttempt>

Workflow attempt details

Throws

When the get operation fails

Example

const attempt = await workflow.attempt('67890');

---

attempts()

attempts(options?): Promise<WorkflowAttempt[]>

List attempts (optionally filtered by project/workflow)

Parameters

options?

Filter and pagination options

includeRetried?

boolean

last_id?

string

limit?

number

projectName?

string

workflowName?

string

Returns

Promise<WorkflowAttempt[]>

Paginated list of attempts

Throws

When the list operation fails

Example

// List all attempts
const result = await workflow.attempts();

// List attempts for a project
const result = await workflow.attempts({ projectName: 'myproject' });

// List attempts for a workflow
const result = await workflow.attempts({
  projectName: 'myproject',
  workflowName: 'daily_etl'
});

---

delete()

delete(projectIdOrName): Promise<{ projectId: string; projectName: string; }>

Delete workflow project

Deletes a workflow project from Treasure Data

Parameters

projectIdOrName

string

Project ID or name

Returns

Promise<{ projectId: string; projectName: string; }>

Deleted project information

Throws

When the delete operation fails

Example

// Delete project by name
await workflow.delete('my_project');

// Delete project by ID
await workflow.delete('12345');

---

download()

download(projectIdOrName, outputDir, options?): Promise<{ filesExtracted: number; projectName: string; revision: string; }>

Download workflow project

Downloads a workflow project archive to a local directory

Parameters

projectIdOrName

string

Project ID or name

outputDir

string

Output directory path

options?

Download options

revision?

string

Returns

Promise<{ filesExtracted: number; projectName: string; revision: string; }>

Download result with project details

Throws

When the download operation fails

Example

// Download project by name
await workflow.download('my_project', './workflows');

// Download specific revision
await workflow.download('my_project', './workflows', {
  revision: 'v1.0.0'
});

---

kill()

kill(attemptId, reason?): Promise<string>

Kill a running attempt

Parameters

attemptId

string

Attempt ID to kill

reason?

string

Optional reason for killing

Returns

Promise<string>

Kill response message

Throws

When the kill operation fails

Example

await workflow.kill('67890');
await workflow.kill('67890', 'manual stop');

---

logFiles()

logFiles(attemptId, taskName?): Promise<LogFileHandle[]>

List log files for an attempt

Parameters

attemptId

string

Attempt ID

taskName?

string

Optional task name to filter by

Returns

Promise<LogFileHandle[]>

Array of log file handles with pre-signed S3 URLs

Throws

When the list operation fails

Example

// List all log files
const files = await workflow.logFiles('67890');

// Filter by task
const files = await workflow.logFiles('67890', '+step1');

---

logs()

logs(attemptId, taskName?): Promise<string>

Get log content for an attempt/task

Downloads and decompresses log files from pre-signed S3 URLs

Parameters

attemptId

string

Attempt ID

taskName?

string

Optional task name to filter by

Returns

Promise<string>

Decompressed log content as string

Throws

When the get operation fails

Example

// Get all logs for an attempt
const logs = await workflow.logs('67890');

// Get logs for a specific task
const logs = await workflow.logs('67890', '+step1');

---

projects()

projects(pattern?, options?): Promise<WorkflowProject[]>

List all workflow projects

Parameters

pattern?

string

Optional glob pattern to filter project names (supports * and ?)

options?

Pagination options

last_id?

string

limit?

number

Returns

Promise<WorkflowProject[]>

Paginated list of workflow projects

Throws

When the list operation fails

Example

// List all projects
const result = await workflow.projects();

// Filter by pattern
const result = await workflow.projects('cdp_segment_*');

// Paginate results
const result = await workflow.projects(undefined, { limit: 50 });

---

push()

push(projectDir, options?): Promise<{ projectId: string; projectName: string; revision: string; }>

Push workflow project

Pushes a local workflow project directory to Treasure Data

Parameters

projectDir

string

Project directory path

options?

Push options

clearSchedule?

string[]

clearScheduleAll?

boolean

projectName?

string

revision?

string

scheduleFrom?

string

skipValidation?

boolean

Returns

Promise<{ projectId: string; projectName: string; revision: string; }>

Push result with project details

Throws

When the push operation fails

Example

// Push project with auto-generated revision
await workflow.push('./my_project');

// Push with specific revision
await workflow.push('./my_project', {
  revision: 'v1.0.0'
});

// Push with project name override
await workflow.push('./my_project', {
  projectName: 'production_workflow',
  revision: '2025-01-11'
});

---

retryAttempt()

retryAttempt(attemptId, options?): Promise<{ attemptId: string; sessionId: string; }>

Retry an attempt

Parameters

attemptId

string

Attempt ID to retry

options?

Retry options

force?

boolean

resumeFrom?

string

retryParams?

Record<string, unknown>

Returns

Promise<{ attemptId: string; sessionId: string; }>

Retry response with new session/attempt IDs

Throws

When the retry operation fails

Example

// Retry attempt
const result = await workflow.retryAttempt('67890');

// Resume from specific task
const result = await workflow.retryAttempt('67890', {
  resumeFrom: '+step2'
});

// Force retry with parameter override
const result = await workflow.retryAttempt('67890', {
  force: true,
  retryParams: { key: 'value' }
});

---

retrySession()

retrySession(sessionId, options?): Promise<{ attemptId: string; sessionId: string; }>

Retry a session

Parameters

sessionId

string

Session ID to retry

options?

Retry options

fromTask?

string

retryParams?

Record<string, unknown>

Returns

Promise<{ attemptId: string; sessionId: string; }>

Retry response with new session/attempt IDs

Throws

When the retry operation fails

Example

// Retry entire session
const result = await workflow.retrySession('12345');

// Resume from specific task
const result = await workflow.retrySession('12345', {
  fromTask: '+step2'
});

// Override parameters
const result = await workflow.retrySession('12345', {
  retryParams: { key: 'value' }
});

---

run()

run(workflow, params, options?): Promise<StartAttemptResponse>

Start a workflow run

Parameters

workflow

string

Workflow identifier in format "project.workflow"

params

Record<string, unknown> = {}

Workflow parameters

options?

Optional session time (defaults to now)

sessionTime?

string

Returns

Promise<StartAttemptResponse>

Started attempt information

Throws

When workflow format is invalid or workflow not found

Example

// Start with project.workflow format
const result = await workflow.run('myproject.myworkflow', { key: 'value' });

// Start with custom session time
const result = await workflow.run('myproject.myworkflow', { key: 'value' }, {
  sessionTime: '2023-08-17T18:56:24+09:00'
});

---

sessions()

sessions(options?): Promise<WorkflowSession[]>

List workflow sessions

Parameters

options?

Session filter and pagination options

fromTime?

string

last_id?

string

limit?

number

projectName?

string

status?

SessionStatus

toTime?

string

workflowName?

string

Returns

Promise<WorkflowSession[]>

Paginated list of sessions

Throws

When the list operation fails

Example

// List all sessions
const result = await workflow.sessions();

// List sessions for specific workflow
const result = await workflow.sessions({
  projectName: 'myproject',
  workflowName: 'daily_etl'
});

// Filter by status
const result = await workflow.sessions({ status: 'error' });

---

tasks()

tasks(attemptId, includeSubtasks): Promise<WorkflowTask[]>

Get tasks for an attempt

Parameters

attemptId

string

Attempt ID

includeSubtasks

boolean = false

Whether to include subtasks

Returns

Promise<WorkflowTask[]>

Array of workflow tasks

Throws

When the get operation fails

Example

const tasks = await workflow.tasks('67890');
const allTasks = await workflow.tasks('67890', true); // Include subtasks

---

workflows()

workflows(projectName?, options?): Promise<Workflow[]>

List workflows (optionally filtered by project)

Parameters

projectName?

string

Optional project name to filter by

options?

Pagination options

last_id?

string

limit?

number

Returns

Promise<Workflow[]>

Paginated list of workflows

Throws

When the list operation fails

Example

// List all workflows
const result = await workflow.workflows();

// List workflows for a specific project
const result = await workflow.workflows('myproject');