Skip to content

Visual Versioning

Visual Versioning lets you update a previously generated visual without changing its unique sharing_id. This keeps external links stable while tracking iterative changes internally.

How Versioning Works

  1. Pass the id of an existing visual in the new generation request via original_visual_id
  2. Abyssale creates a new visual with a new id but the same sharing_id
  3. The version number increments by +1
  4. The view_url associated with the sharing_id automatically points to the new version

API Configuration

Include original_visual_id in the request body:

PropertyTypeDescription
original_visual_idstring (UUID v4)The id of the existing visual to create a new version for

Example

POST https://api.abyssale.com/banner-builder/{designId}/generate
json
{
  "original_visual_id": "a14e1d26-ff41-47cb-bbf9-8f2d777a5bd7",
  "elements": {
    "text_field": {
      "payload": "Updated Content for V2"
    }
  }
}

Constraints

MethodConstraint
Synchronous APINone
Asynchronous APIRequest must generate a single visual only, and the format must match the original. Multi-visual requests are rejected.

Response Properties

PropertyDescription
idNew UUID unique to this version
sharing_idShared identifier linking all versions of this visual. Preserved from the original visual across all new versions.
versionIncremented (e.g. 12)
view_urlNow points to this new latest version