BlogLog InRequest Demo
HomeProductDevelopersSelf-HostingChangelog
HomeProductDevelopersSelf-HostingChangelog
  • Getting Started
    • Overview
  • Workflows SDK
    • Introduction
    • Installation
    • Core Concepts
    • Defining Control Flow
    • Configuration
    • Custom Docker Images
  • Client SDK
    • Introduction
    • Authentication
    • API Versioning
LogoLogo
BlogLog InRequest Demo
Client SDKWorkflowsWorkflow Sandboxes

Deploy Workflow

Beta
POST
https://api.vellum.ai/v1/workflow-sandboxes/:id/deploy
POST
/v1/workflow-sandboxes/:id/deploy
1from vellum import Vellum
2
3client = Vellum(
4    api_version="YOUR_API_VERSION",
5    api_key="YOUR_API_KEY",
6)
7client.workflow_sandboxes.deploy_workflow(
8    id="id",
9)
Try it
200Successful
1{
2  "id": "string",
3  "name": "string",
4  "label": "string",
5  "created": "2024-01-15T09:30:00Z",
6  "last_deployed_on": "2024-01-15T09:30:00Z",
7  "last_deployed_history_item_id": "string",
8  "input_variables": [
9    {
10      "id": "string",
11      "key": "string",
12      "type": "STRING",
13      "required": true,
14      "default": {
15        "type": "STRING",
16        "value": "string"
17      },
18      "extensions": {
19        "color": "string"
20      }
21    }
22  ],
23  "output_variables": [
24    {
25      "id": "string",
26      "key": "string",
27      "type": "STRING",
28      "required": true,
29      "default": {
30        "type": "STRING",
31        "value": "string"
32      },
33      "extensions": {
34        "color": "string"
35      }
36    }
37  ],
38  "status": "ACTIVE",
39  "environment": "DEVELOPMENT",
40  "description": "string"
41}
Was this page helpful?
Previous

List Workflow Deployments

Next
Built with
List Workflow Deployments

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"
A UUID string identifying this workflow sandbox.

Headers

X-API-VersionstringOptional

Request

This endpoint expects an object.
workflow_deployment_idstring or nullOptionalformat: "uuid"
The Vellum-generated ID of the Workflow Deployment you'd like to update. Cannot specify both this and workflow_deployment_name. Leave null to create a new Workflow Deployment.
workflow_deployment_namestring or nullOptional>=1 character
The unique name of the Workflow Deployment you'd like to either create or update. Cannot specify both this and workflow_deployment_id. If provided and matches an existing Workflow Deployment, that Workflow Deployment will be updated. Otherwise, a new Prompt Deployment will be created.
labelstring or nullOptional>=1 character
In the event that a new Workflow Deployment is created, this will be the label it's given.
release_tagslist of strings or nullOptional
Optionally provide the release tags that you'd like to be associated with the latest release of the created/updated Prompt Deployment.
release_descriptionstring or nullOptional>=1 characterDefaults to
Optionally provide a description that details what's new in this Release.

Response

Optionally provide a description that details what's new in this Release.
API Key authentication via header
A UUID string identifying this workflow sandbox.
idstringformat: "uuid"
namestring<=150 characters
A name that uniquely identifies this workflow deployment within its workspace
labelstring<=150 characters
A human-readable label for the workflow deployment
createdstringformat: "date-time"
last_deployed_onstringformat: "date-time"
last_deployed_history_item_idstringformat: "uuid"
The ID of the history item associated with this Workflow Deployment's LATEST Release Tag
input_variableslist of objects
The input variables this Workflow Deployment expects to receive values for when it is executed.
output_variableslist of objects
The output variables this Workflow Deployment produces values for when it's executed.
statusenum or null
The current status of the workflow deployment * `ACTIVE` - Active * `ARCHIVED` - Archived
Allowed values:
environmentenum or null
Deprecated. The value returned will always be 'PRODUCTION'.
Allowed values:
descriptionstring or null
A human-readable description of the workflow deployment

A human-readable label for the workflow deployment

The current status of the workflow deployment

  • ACTIVE - Active
  • ARCHIVED - Archived

Optionally provide the release tags that you’d like to be associated with the latest release of the created/updated Prompt Deployment.

A human-readable description of the workflow deployment

The unique name of the Workflow Deployment you’d like to either create or update. Cannot specify both this and workflow_deployment_id. If provided and matches an existing Workflow Deployment, that Workflow Deployment will be updated. Otherwise, a new Prompt Deployment will be created.

The Vellum-generated ID of the Workflow Deployment you’d like to update. Cannot specify both this and workflow_deployment_name. Leave null to create a new Workflow Deployment.