OpenAPI Specification
openapi: 3.0.1
info:
contact:
email: info@seqera.io
url: https://seqera.io
description: Seqera Platform services API
title: Seqera actions workflows API
version: 1.181.0
tags:
- description: Workflow executions
name: workflows
paths:
/workflow:
get:
description: Lists all workflow records, enriched with `attributes`. Append `?workspaceId` to list workflow records in a workspace context.
operationId: ListWorkflows
parameters:
- description: 'Additional attribute values to include in the response (`labels`, `optimized` status). Returns an empty value (`labels: null`) if omitted.'
explode: false
in: query
name: attributes
schema:
items:
$ref: '#/components/schemas/WorkflowQueryAttribute'
type: array
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Pagination max results
in: query
name: max
schema:
format: int32
type: integer
- description: Pagination offset
in: query
name: offset
schema:
format: int32
type: integer
- description: Filter search parameter
in: query
name: search
schema:
type: string
- description: Include total size in the response
in: query
name: includeTotalSize
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListWorkflowsResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: List workflows
tags:
- workflows
/workflow/delete:
post:
description: Deletes the workflow records identified by the given list of `workflowIds`.
operationId: DeleteWorkflowMany
parameters:
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Force the deletion even if any workflows are active
in: query
name: force
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteWorkflowsRequest'
description: Delete workflows request
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteWorkflowsResponse'
description: OK - Return the IDs of workflows that could not be deleted, if any
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Delete workflows
tags:
- workflows
/workflow/launch:
post:
description: Submits a workflow execution.
operationId: CreateWorkflowLaunch
parameters:
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Source workspace numeric identifier
in: query
name: sourceWorkspaceId
required: false
schema:
format: int64
nullable: true
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitWorkflowLaunchRequest'
description: Workflow launch request
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitWorkflowLaunchResponse'
description: OK
'400':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ErrorResponse'
- $ref: '#/components/schemas/WorkflowLaunchValidationErrorResponse'
description: Bad request — single-failure launches return `ErrorResponse`; multi-failure launches return `WorkflowLaunchValidationErrorResponse` with a per-blocker `errors[]` array
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Launch workflow
tags:
- workflows
/workflow/random-name:
get:
operationId: GenerateRandomWorkflowName
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RandomWorkflowNameResponse'
description: Generated name
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Generates a random name
tags:
- workflows
/workflow/validate:
get:
description: 'Check that the given run name of a workflow has a valid format. When the session ID is given: check that no other workflow in the system exists with the combination of both elements.'
operationId: ValidateWorkflowConstraints
parameters:
- description: Workflow run name to validate
in: query
name: runName
schema:
type: string
- description: Workflow session ID to validate
in: query
name: sessionId
schema:
type: string
responses:
'204':
description: OK - No content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request. Invalid run name format
'403':
description: Operation not allowed
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Duplicated element. Existing run name and session ID combination
security:
- BearerAuth: []
summary: Validate run name
tags:
- workflows
/workflow/{workflowId}:
delete:
operationId: DeleteWorkflow
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Force the deletion even if the workflow is active
in: query
name: force
schema:
type: boolean
responses:
'204':
description: OK - Not content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Delete the Workflow entity with the given ID
tags:
- workflows
get:
description: Retrieves the details of the workflow record associated with the given `workflowId`.
operationId: DescribeWorkflow
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Comma-separated list of attributes to retrieve. Returns an empty value for each attribute not specified.
explode: false
in: query
name: attributes
schema:
items:
$ref: '#/components/schemas/WorkflowQueryAttribute'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkflowResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Describe workflow
tags:
- workflows
patch:
description: Updates only the workflow-extension store; never a core workflow field. Designed to carry workflow-extension attributes generally so future fields reuse this operation. Returns the updated workflow representation.
operationId: UpdateWorkflow
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkflowRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkflowResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Conflict — a concurrent update prevented the write; the request may be retried
security:
- BearerAuth: []
summary: Apply a partial update to the workflow-extension metadata for the given Workflow ID
tags:
- workflows
/workflow/{workflowId}/cancel:
post:
description: Cancels the workflow execution identified by the given `workflowId`.
operationId: CancelWorkflow
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Cancel on the Platform side even if it cannot be cancelled on the CE provider side
in: query
name: force
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyBodyRequest'
responses:
'204':
description: OK - No content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Cancel workflow
tags:
- workflows
/workflow/{workflowId}/download:
get:
description: Downloads the workflow files for the Nextflow main job associated with the given `workflowId`.
operationId: DownloadWorkflowLog
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Filename to download
in: query
name: fileName
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
responses:
'200':
content:
text/plain:
schema:
format: binary
type: string
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Download workflow files
tags:
- workflows
/workflow/{workflowId}/download/{taskId}:
get:
description: Downloads the workflow files of the task identified by the given `taskId`.
operationId: DownloadWorkflowTaskLog
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Task numeric identifier
in: path
name: taskId
required: true
schema:
format: int64
type: integer
- description: Filename to download
in: query
name: fileName
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
responses:
'200':
content:
text/plain:
schema:
format: binary
type: string
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Download workflow task files
tags:
- workflows
/workflow/{workflowId}/launch:
get:
description: Retrieves the details of the workflow launch associated with the given `workflowId`.
operationId: DescribeWorkflowLaunch
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkflowLaunchResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Duplicate element. Existing run name and session ID combination
security:
- BearerAuth: []
summary: Describe workflow launch
tags:
- workflows
/workflow/{workflowId}/log:
get:
description: Retrieves the output logs for the Nextflow main job of the workflow identified by the given `workflowId`.
operationId: GetWorkflowLog
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Workflow log cursor
in: query
name: next
schema:
type: string
- description: Maximum length in bytes of the log to retrieve
in: query
name: maxLength
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowLogResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Get workflow logs
tags:
- workflows
/workflow/{workflowId}/log/{taskId}:
get:
description: Retrieves the output logs for the workflow task identified by the given `taskId`.
operationId: GetWorkflowTaskLog
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Task numeric identifier
in: path
name: taskId
required: true
schema:
format: int64
type: integer
- description: Workflow log cursor
in: query
name: next
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Maximum length in bytes of the log to retrieve
in: query
name: maxLength
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowLogResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Get workflow task logs
tags:
- workflows
/workflow/{workflowId}/metrics:
get:
operationId: DescribeWorkflowMetrics
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetWorkflowMetricsResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Get the execution metrics for the given Workflow ID
tags:
- workflows
/workflow/{workflowId}/progress:
get:
operationId: DescribeWorkflowProgress
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetProgressResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Retrieve the execution progress for the given Workflow ID
tags:
- workflows
/workflow/{workflowId}/star:
delete:
description: Removes the workflow identified by the given `workflowId` from your list of starred workflows.
operationId: DeleteWorkflowStar
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkflowStarResponse'
description: OK
'403':
description: Operation not allowed
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not found
summary: Unstar workflow
tags:
- workflows
get:
description: Confirms whether the given `workflowId` is starred.
operationId: DescribeWorkflowStar
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkflowStarResponse'
description: OK
'403':
description: Operation not allowed
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not found
summary: Check workflow star status
tags:
- workflows
post:
description: Adds the workflow identified by the given `workflowId` to your list of starred workflows.
operationId: CreateWorkflowStar
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkflowStarResponse'
description: OK
'403':
description: Operation not allowed
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Duplicated element
summary: Star workflow
tags:
- workflows
/workflow/{workflowId}/task/{taskId}:
get:
operationId: DescribeWorkflowTask
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Task numeric identifier
in: path
name: taskId
required: true
schema:
format: int64
type: integer
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeTaskResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Describe a task entity with the given ID
tags:
- workflows
/workflow/{workflowId}/tasks:
get:
operationId: ListWorkflowTasks
parameters:
- description: Workflow string identifier
in: path
name: workflowId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Pagination max results
in: query
name: max
schema:
format: int32
type: integer
- description: Pagination offset
in: query
name: offset
schema:
format: int32
type: integer
- description: Field to sort by
in: query
name: sortBy
schema:
type: string
- description: Sorting direction (asc|desc)
in: query
name: sortDir
schema:
type: string
- description: Search tasks by name
in: query
name: search
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListTasksResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: List the tasks for the given Workflow ID and filter parameters
tags:
- workflows
components:
schemas:
WfFusionMeta:
properties:
enabled:
type: boolean
version:
maxLength: 20
type: string
type: object
ComputeEnv.Status:
enum:
- CREATING
- AVAILABLE
- DISABLED
- DELETING
- ERRORED
- INVALID
- DELETED
type: string
JobInfoDto:
properties:
exitCode:
format: int32
type: integer
id:
format: int64
type: integer
message:
type: string
operationId:
type: string
status:
type: string
type: object
PipelineMinInfoResponse.PipelineVersionMinInfoResponse:
properties:
dateCreated:
format: date-time
type: string
hash:
type: string
id:
type: string
isDefault:
type: boolean
isDraftVersion:
type: boolean
lastUpdated:
format: date-time
type: string
name:
type: string
type: object
LabelDbDto:
properties:
dateCreated:
format: date-time
type: string
id:
format: int64
type: integer
isDefault:
type: boolean
isDynamic:
type: boolean
isInterpolated:
type: boolean
name:
type: string
resource:
type: boolean
value:
type: string
type: object
LocalComputeConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
- properties:
fusion2Enabled:
type: boolean
schedConfig:
$ref: '#/components/schemas/SchedConfig'
schedEnabled:
type: boolean
waveEnabled:
type: boolean
type: object
title: Local execution configuration
type: object
LsfComputeConfig:
allOf:
- $ref: '#/components/schemas/AbstractGridConfig'
- properties:
perJobMemLimit:
type: boolean
perTaskReserve:
type: boolean
unitForLimits:
type: string
type: object
title: IBM LSF configuration
type: object
EksComputeConfig:
allOf:
- $ref: '#/components/schemas/K8sComputeConfig'
- properties:
clusterName:
description: The AWS EKS cluster name
type: string
fusion2Enabled:
type: boolean
region:
description: AWS region
type: string
waveEnabled:
type: boolean
type: object
title: Amazon EKS cluster configuration
type: object
DescribeWorkflowLaunchResponse:
properties:
launch:
$ref: '#/components/schemas/WorkflowLaunchResponse'
type: object
SchedConfig:
properties:
backendStrategy:
description: Backend used by Intelligent Compute to run tasks. 'ECS' (AWS only, default) delegates task execution to AWS ECS; 'EC2' (AWS only) runs tasks directly on AWS EC2 instances; 'VM' runs tasks on cloud VMs (provider-agnostic).
enum:
- ECS
- EC2
- VM
type: string
diskAllocation:
type: string
fusionSnapshots:
description: Enable Fusion snapshots so interrupted (e.g. spot-reclaimed) tasks can resume from a snapshot instead of restarting from scratch.
type: boolean
machineTypes:
description: EC2 instance types for compute nodes. Leave empty to automatically select the most cost-effective types for each task.
items:
type: string
type: array
nvmeEnabled:
description: When true, only use instance types providing local SSD (NVMe) storage. Maps to diskAllocation='nvme'.
type: boolean
pool:
allOf:
- $ref: '#/components/schemas/SchedConfig.Pool'
description: Warm-pool configuration. When present and enabled, the scheduler maintains a pool of idle VMs ready to absorb incoming tasks with sub-5s start latency.
predictionModel:
description: 'Resource-prediction model used by Intelligent Compute to size tasks. Suggested values: ''none'' (default), ''qr/v1'', ''qr/v2''. Any other string is accepted.'
type: string
provisioningModel:
enum:
- spot
- spotFirst
- ondemand
type: string
type: object
CloudPriceModel:
enum:
- standard
- spot
type: string
x-enum-varnames:
- standard
- spot
WorkflowMetrics:
properties:
cpu:
$ref: '#/components/schemas/ResourceData'
cpuUsage:
$ref: '#/components/schemas/ResourceData'
gpuMemAvg:
$ref: '#/components/schemas/ResourceData'
gpuMemPeak:
$ref: '#/components/schemas/ResourceData'
gpuUsage:
$ref: '#/components/schemas/ResourceData'
id:
format: int64
nullable: true
type: integer
mem:
$ref: '#/components/schemas/ResourceData'
memUsage:
$ref: '#/components/schemas/ResourceData'
process:
maxLength: 255
type: string
reads:
$ref: '#/components/schemas/ResourceData'
time:
$ref: '#/components/schemas/ResourceData'
timeUsage:
$ref: '#/components/schemas/ResourceData'
vmem:
$ref: '#/components/schemas/ResourceData'
writes:
$ref: '#/components/schemas/ResourceData'
required:
- process
type: object
DescribeTaskResponse:
properties:
task:
$ref: '#/components/schemas/Task'
type: object
TaskStatus:
enum:
- NEW
- SUBMITTED
- RUNNING
- CACHED
- COMPLETED
- FAILED
- ABORTED
type: string
EmptyBodyRequest:
type: object
DeleteWorkflowsResponse:
properties:
failedWorkflowIds:
items:
type: string
type: array
type: object
AzCloudConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/seqera-labs/refs/heads/main/openapi/seqera-labs-workflows-api-openapi.yml