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
- Pass the
idof an existing visual in the new generation request viaoriginal_visual_id - Abyssale creates a new visual with a new
idbut the samesharing_id - The
versionnumber increments by +1 - The
view_urlassociated with thesharing_idautomatically points to the new version
API Configuration
Include original_visual_id in the request body:
| Property | Type | Description |
|---|---|---|
original_visual_id | string (UUID v4) | The id of the existing visual to create a new version for |
Example
POST https://api.abyssale.com/banner-builder/{designId}/generatejson
{
"original_visual_id": "a14e1d26-ff41-47cb-bbf9-8f2d777a5bd7",
"elements": {
"text_field": {
"payload": "Updated Content for V2"
}
}
}Constraints
| Method | Constraint |
|---|---|
| Synchronous API | None |
| Asynchronous API | Request must generate a single visual only, and the format must match the original. Multi-visual requests are rejected. |
Response Properties
| Property | Description |
|---|---|
id | New UUID unique to this version |
sharing_id | Shared identifier linking all versions of this visual. Preserved from the original visual across all new versions. |
version | Incremented (e.g. 1 → 2) |
view_url | Now points to this new latest version |
Related
- Generate Single Image — returns the
idused for versioning - Asynchronous Generation — batch generation IDs also support versioning
