Skip to navigation
Client SDKWorkflows

Pull Workflow

Beta

Used to pull the definition of a Workflow from Vellum. Returns a zip archive of the Workflow’s code by default, or a flattened plain-text representation if the Accept header is set to ‘text/plain’.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
The ID or name of the Workflow Deployment, or the ID of the Workflow Sandbox, to pull from.

Headers

X-API-VersionstringOptional

Query parameters

exclude_codebooleanOptional
If true, omit the Workflow's code from the response.
exclude_displaybooleanOptional
If true, omit UI display metadata files when pulling from a Workflow Sandbox.
include_jsonbooleanOptional
If true, include a JSON representation of the Workflow's definition alongside its code.
include_sandboxbooleanOptional
If true, include the Workflow Sandbox's scenarios as sandbox inputs when pulling from a Workflow Sandbox.
release_tagstringOptional

Release tag to use when pulling from deployment (implies deployment-only lookup)

strictbooleanOptional

If true, fail on any code generation error instead of returning best-effort code.

versionstringOptional

Semantic version range to validate against the Workflow SDK version (e.g., '>=1.0.0,<1.2.3')

Response

This endpoint returns a file.

Errors

400
Bad Request Error