Skip to main content
PUT
Create or update workflow version

Authorizations

Authorization
string
header
required

API key passed as Authorization: Bearer <api_key>

Path Parameters

workflowID
string
required

Unique workflow identifier

Example:

"wf_abc123"

versionID
string
required

Version identifier (e.g., "v1", "v2")

Example:

"v1"

Body

application/json
version_id
string

Optional; overrides the version in the path when present

Example:

"v2"

definition
object

The complete workflow definition for this version. Required when creating a new version; omit (or send null) to keep the stored definition when updating.

output_mapping
object

Final output keys mapped to step output refs. Omit to leave unchanged, send {} to clear, send entries to replace the whole map.

Example:
published
boolean

Publish state for this version. Omitted keeps the stored value.

locked
boolean

Lock this version against further edits. Omitted keeps the stored value.

production
boolean

Mark as the production version. Omitted keeps the stored value.

allowed_to_share
boolean

Toggle unlisted sharing for this version.

  • true → makes the version "unlisted" (accessible via link, hidden from public listings)
  • false → makes the version "private" (organization only)
  • No effect on public versions
  • Omitted keeps the stored value (new versions default to private)

Response

Workflow version created or updated successfully

Summary information about a workflow version

version_id
string
required

Version identifier

Example:

"v1"

slug
string
required

Workflow slug (inherited from parent workflow)

Example:

"text-to-image-generator"

published
boolean

Whether this version is published

Example:

false

locked
boolean

Whether this version is locked from modifications

Example:

false

production
boolean

Whether this is a production version

Example:

true

allowed_to_share
boolean

True if version is unlisted (accessible via direct link but hidden from public listings).

Example:

false

trigger_count
integer

Number of times this specific version has been triggered

Example:

15

created_at
string<date-time>

RFC3339 timestamp when version was created

Example:

"2025-12-01T10:00:00Z"

updated_at
string<date-time>

RFC3339 timestamp when version was last updated

Example:

"2025-12-05T14:20:00Z"

status
enum<string>

Version lifecycle status

Available options:
active,
archived,
deleted
Example:

"active"

visibility
enum<string>

Version visibility

Available options:
private,
unlisted,
public
Example:

"private"

Whether the version is featured as popular in public listings

Example:

false

updated_by
string

Identifier of the user who last updated the version

definition
object

The complete workflow definition — steps, input schema, and metadata. Omitted from the response when the version has no stored definition.

public_description
string

Public listing description. Omitted when unset.

Example:

"Generates images from text prompts"

public_thumbnail
string

Public listing thumbnail URL. Omitted when unset.

Example:

"https://storage.googleapis.com/uploads/thumb.png"

Sort position within the popular public listing. Omitted when unset.

Example:

1

public_example_output
string

Public listing example output URL. Omitted when unset.

Example:

"https://storage.googleapis.com/uploads/example.png"

Last modified on August 17, 2026