Skip to main content

GA4GH

The GA4GH Workflow Execution Service (WES) is a protocol for running the same genomic data analysis in multiple cloud environments. Use GA4GH WES endpoints to send the same workflow to different compute centres and receive reliable, consistent results, enhancing the reproducibility and reusability of genomic analyses.

Path and query parameters

Name

Type

Location

Req/Opt

Description

page_size

integer

query

Optional

Page size

page_token

string

query

Optional

Page token

run_id

string

path

Required

Run string identifier

Request body parameters

Name

Type

Req/Opt

Description

Ga4ghRunCreate

GA4GH: Launch run

workflow_params

string

Optional

JSON-encoded workflow input parameters, including input and output locations, forwarded to the workflow engine.

workflow_type

string

Optional

Workflow descriptor type. For Seqera Platform WES requests this is typically NFL for Nextflow, but clients must use a value supported by this WES deployment.

workflow_type_version

string

Optional

Workflow descriptor version supported by this WES deployment.

tags

object

Optional

Additional key-value metadata to attach to the GA4GH run request.

workflow_engine_parameters

object

Optional

Additional workflow engine parameters, such as workspaceId or computeEnvId, forwarded to the underlying launch request.

workflow_url

string

Optional

Workflow entrypoint URL or path to launch. When attachments are used, this can be a relative path to one of the attached files.

Ga4ghRunCancel

GA4GH: Cancel run