Sign in

v51

latestOpenAPI 3.0.1Apache License Version 2.0raw.githubusercontent.com2026-08-01304136381.9 KB
workflows

Retrieve a workflow version by ID

get/workflows/{workflowId}/workflowVersions/{workflowVersionId}

Path parameters

workflowIdinteger required

id of the workflow

workflowVersionIdinteger required

id of the workflow version

Query parameters

includestring

Comma-delimited list of fields to include: validations, aliases, images, authors, metrics

Response

Get a workflow version by ID

aiTopicProcessedboolean
aliasesobject
authorstring
commitIDstring
dbUpdateDateinteger
descriptionSource'README' | 'CUSTOM_README' | 'DESCRIPTOR'
dirtyBitboolean
doiStatus'NOT_REQUESTED' | 'REQUESTED' | 'CREATED'
doiURLstring
doisobject

The DOIs for the version of the entry

emailstring
frozenboolean
hiddenboolean
idinteger
kernelImagePathstring

User-specified notebook kernel image reference

last_modifiedinteger
legacyVersionboolean
metricsByPlatformobject
namestring required

Implementation specific, can be a quay.io or docker hub tag name

readMePathstring
referencestring required

git commit/tag/branch

referenceType'COMMIT' | 'TAG' | 'BRANCH' | 'NOT_APPLICABLE' | 'UNSET'
syncedboolean
userFilesstring[]
validboolean
verifiedboolean
verifiedPlatformsstring[]

Verified platforms for the version

verifiedSourcestring
verifiedSourcesstring[]
workflow_pathstring
workingDirectorystring