Durable Workflows

Publish Workflow Version

Changed on

Publishes the graph in the body as the workflow's next immutable version: 201 when new, 200 when it matches the latest. Roll back by republishing an earlier graph. An invalid graph returns 422 graph_invalid. With an Idempotency-Key, a retry within 24 hours replays a snapshot of the original body with HTTP 200, and reuse with a different graph returns 409 conflict. Unlike run creation, this is not durable.

post/v3/workflows/{workflow_id}/versions

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/workflows/{workflow_id}/versions
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

workflow_idstring required

Workflow definition ID

Headers

Idempotency-Keystring

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Request body

Response

Existing identical version returned, or an idempotency-key replay.

Changes