Seqera Labs workflows API

openapi: 3.2.0
info:
  contact:
    email: info@seqera.io
    url: https://seqera.io
  description: Seqera Platform services API
  title: Seqera actions Workflows API
  version: 1.181.0
servers:
- url: https://api.cloud.seqera.io
  description: Base URL declared by the provider in apis.yml (roadmap#122).
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
          type:
          - integer
          - 'null'
      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:
    SchedConfig.Pool:
      properties:
        desiredWarm:
          description: Target number of idle VMs to keep warm. Bounds total warm-VM cost across all of this CE's pool clusters.
          format: int32
          type: integer
        enabled:
          description: Whether the warm pool is active for this CE. When false, the scheduler will not maintain idle VMs.
          type: boolean
        scaleToZeroSecs:
          description: Seconds of inactivity after which the warm pool scales to zero. Set to 0 to never scale to zero.
          format: int32
          type: integer
      type: object
    AltairPbsComputeConfig:
      allOf:
      - $ref: '#/components/schemas/AbstractGridConfig'
      title: Altair PBS configuration
      type: object
    ResourceData:
      properties:
        max:
          format: float
          type: number
        maxLabel:
          type: string
        mean:
          format: float
          type: number
        min:
          format: float
          type: number
        minLabel:
          type: string
        q1:
          format: float
          type: number
        q1Label:
          type: string
        q2:
          format: float
          type: number
        q2Label:
          type: string
        q3:
          format: float
          type: number
        q3Label:
          type: string
        warnings:
          items:
            type: string
          type: array
      type: object
    ComputeEnv.Status:
      enum:
      - CREATING
      - AVAILABLE
      - DISABLED
      - DELETING
      - ERRORED
      - INVALID
      - DELETED
      type: string
    WorkflowLoad:
      properties:
        aborted:
          format: int64
          type: integer
        cached:
          format: int64
          type: integer
        cost:
          type: number
        cpuEfficiency:
          format: float
          type: number
        cpuLoad:
          format: int64
          type: integer
        cpuShareMillis:
          format: int64
          type:
          - integer
          - 'null'
        cpuShares:
          format: int64
          type:
          - integer
          - 'null'
        cpuTime:
          format: int64
          type: integer
        cpus:
          format: int64
          type: integer
        dateCreated:
          format: date-time
          type: string
        executors:
          items:
            type: string
          type: array
        failed:
          format: int64
          type: integer
        ignored:
          format: int64
          type: integer
        invCtxSwitch:
          format: int64
          type: integer
        lastUpdated:
          format: date-time
          type: string
        loadCpus:
          format: int64
          type: integer
        loadMemory:
          format: int64
          type: integer
        loadTasks:
          format: int64
          type: integer
        memoryEfficiency:
          format: float
          type: number
        memoryReq:
          format: int64
          type: integer
        memoryRss:
          format: int64
          type: integer
        netCost:
          type: number
        netCpuLoad:
          format: int64
          type: integer
        netCpuShareMillis:
          format: int64
          type:
          - integer
          - 'null'
        netCpuShares:
          format: int64
          type:
          - integer
          - 'null'
        netCpuTime:
          format: int64
          type: integer
        netCpus:
          format: int64
          type: integer
        netInvCtxSwitch:
          format: int64
          type: integer
        netMemoryConsumption:
          type: number
        netMemoryReq:
          format: int64
          type: integer
        netMemoryRss:
          format: int64
          type: integer
        netReadBytes:
          format: int64
          type: integer
        netVolCtxSwitch:
          format: int64
          type: integer
        netWriteBytes:
          format: int64
          type: integer
        numSpotInterruptions:
          format: int32
          type: integer
        peakCpus:
          format: int64
          type: integer
        peakMemory:
          format: int64
          type: integer
        peakTasks:
          format: int64
          type: integer
        pending:
          format: int64
          type: integer
        readBytes:
          format: int64
          type: integer
        requestedCpuTime:
          format: int64
          type:
          - integer
          - 'null'
        requestedMemory:
          format: int64
          type:
          - integer
          - 'null'
        retries:
          format: int64
          type: integer
        running:
          format: int64
          type: integer
        submitted:
          format: int64
          type: integer
        succeeded:
          format: int64
          type: integer
        version:
          format: int64
          type: integer
        volCtxSwitch:
          format: int64
          type: integer
        writeBytes:
          format: int64
          type: integer
      required:
      - aborted
      - cached
      - cpuLoad
      - cpuTime
      - cpus
      - failed
      - ignored
      - invCtxSwitch
      - loadCpus
      - loadMemory
      - loadTasks
      - memoryReq
      - memoryRss
      - peakCpus
      - peakMemory
      - peakTasks
      - pending
      - readBytes
      - retries
      - running
      - submitted
      - succeeded
      - volCtxSwitch
      - writeBytes
      type: object
    SubmitWorkflowLaunchRequest:
      properties:
        launch:
          $ref: '#/components/schemas/WorkflowLaunchRequest'
      type: object
    SeqeraComputeConfig:
      allOf:
      - $ref: '#/components/schemas/ComputeConfig'
      - properties:
          defaultDataRetentionPolicy:
            type: boolean
          instanceTypeSize:
            allOf:
            - $ref: '#/components/schemas/SeqeraComputeCloudInstanceTypeSize'
            description: Size of the Data Studios instance (SMALL, MEDIUM, LARGE)
          region:
            type: string
        type: object
      title:

# --- 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