For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
BlogLog InRequest Demo
HomeProductDevelopersSelf-HostingChangelog
HomeProductDevelopersSelf-HostingChangelog
  • Getting Started
    • Overview
  • Workflows SDK
    • Introduction
    • Installation
    • Core Concepts
    • Defining Control Flow
    • Configuration
    • Custom Docker Images
      • Displayable Nodes
      • Datasets
      • CLI
      • Push Feature Status
  • Client SDK
    • Introduction
    • Authentication
    • API Versioning
LogoLogo
BlogLog InRequest Demo
On this page
  • Support Stages
  • Current Status
  • Generally Supported Components
  • Components with Potential Limitations
  • Using the Push Command
  • Checking Push Support Status
  • Troubleshooting
Workflows SDKAPI Reference

Push Feature Status

Was this page helpful?
Previous

Examples Gallery

Next
Built with

The push feature in Vellum Workflows SDK allows you to upload locally defined Vellum resources to the Vellum application. This feature is in active development, with different components and use cases at varying levels of support.

Support Stages

The support for the push feature can be in one of the following stages for different components and workflows:

  1. Blocked on push: The feature is not yet supported for this component or workflow type. Attempting to push will result in an error.

  2. Supported but hidden from UI: The feature works via the CLI or SDK, but there is no corresponding UI element in the Vellum application to indicate or manage this capability.

  3. Supported but read-only in UI: The feature works and is visible in the UI, but you cannot modify the pushed components through the UI interface.

  4. Fully supported and editable: The feature is fully supported, visible in the UI, and can be edited through both the UI and code interfaces.

Current Status

The support level for different components is determined on a case-by-case basis. If you encounter issues with pushing specific components or workflows, please contact Vellum support for the most up-to-date information on support status.

Generally Supported Components

The following components typically have good support for the push feature:

  • Basic workflow structures
  • Standard node types (Prompt, Search, API, Templating)
  • Simple control flow patterns

Components with Potential Limitations

The following components may have limited support or be in earlier stages of the support lifecycle:

  • Complex nested workflows
  • Custom node types
  • Advanced control flow patterns (complex loops, conditional branching)
  • Workflows with external integrations

Using the Push Command

To push your workflow to Vellum, use the following command:

1vellum workflows push --workflow-sandbox-id=<sandbox_id_> --include-sandbox

If you encounter an error indicating that push is not supported for a particular component, you may need to:

  1. Check if there’s an alternative approach to achieve the same result
  2. Wait for support to be added in a future release
  3. Contact Vellum support for guidance

Checking Push Support Status

To verify if your workflow can be pushed successfully, you can use the --dry-run option:

1vellum workflows push --workflow-sandbox-id=<sandbox_id_> --dry-run --include-sandbox

This will validate your workflow without actually pushing it to Vellum, allowing you to identify any unsupported components.

Troubleshooting

If you encounter issues with the push feature:

  1. Ensure you’re using the latest version of the Vellum Workflows SDK
  2. Check the error message for specific information about unsupported components
  3. Try simplifying your workflow to identify which component is causing the issue
  4. Use the --strict flag to get more detailed error information:

For specific guidance on your use case, contact Vellum support at support@vellum.ai.