Launch workflow

POST 
/workflow/launch

Submits a workflow execution.

Request

Query Parameters

workspaceId int64

Workspace numeric identifier

sourceWorkspaceId int64

Source Optional workspace numeric identifier

application/json

Bodyrequired

Workflow launch request

launch object
idstring
computeEnvIdstring
runNamestring
pipelinestring
workDirstring
revisionstring
sessionIdstring
configProfilesstring[]
userSecretsstring[]
workspaceSecretsstring[]
configTextstring
towerConfigstring
paramsTextstring
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
mainScriptstring
entryNamestring
schemaNamestring
resumeboolean
pullLatestboolean
stubRunboolean
optimizationIdstring
optimizationTargetsstring
labelIdsint64[]
headJobCpusint32
headJobMemoryMbint32
launchContainerstring
dateCreateddate-time

Responses

200

OK

application/json

Schema

Schema

workflowIdstring

Example (auto)

{
  "workflowId": "string"
}

400

Bad request

application/json

Schema

Schema

messagestringrequired

Example (auto)

{
  "message": "string"
}

403

Operation not allowed

Authorization: http

name: BearerAuthtype: httpscheme: bearerbearerFormat: jwt

• python
• curl
• java
• r
• javascript
• go
• powershell

• HTTP.CLIENT
• REQUESTS

import http.client
import json

conn = http.client.HTTPSConnection("docs.seqera.io")
payload = ''
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <token>'
}
conn.request("POST", "/workflow/launch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Auth

Bearer Token

Parameters

workspaceId — query

sourceWorkspaceId — query

Body required

{
  "launch": {
    "id": "string",
    "computeEnvId": "string",
    "runName": "string",
    "pipeline": "string",
    "workDir": "string",
    "revision": "string",
    "sessionId": "string",
    "configProfiles": [
      "string"
    ],
    "userSecrets": [
      "string"
    ],
    "workspaceSecrets": [
      "string"
    ],
    "configText": "string",
    "towerConfig": "string",
    "paramsText": "string",
    "preRunScript": "string",
    "postRunScript": "string",
    "mainScript": "string",
    "entryName": "string",
    "schemaName": "string",
    "resume": true,
    "pullLatest": true,
    "stubRun": true,
    "optimizationId": "string",
    "optimizationTargets": "string",
    "labelIds": [
      0
    ],
    "headJobCpus": 0,
    "headJobMemoryMb": 0,
    "launchContainer": "string",
    "dateCreated": "2024-07-29T15:51:28.071Z"
  }
}