Create a Dynamic Image by API

Creates a dynamic image URL for a given design. Only one dynamic image is allowed per design — subsequent calls return the existing URL without modifying it.

INFO

The dynamic_image_url for each format is also returned by the Get Design Details endpoint once the dynamic image has been created.

POST/dynamic-image/{designId}API Reference

Path Parameters

Parameter	Type	Required	Description
designId	string	Yes	Unique identifier of the design for which to create the dynamic image URL.

Request Body

Field	Type	Required	Description
enable_rate_limit	boolean	No	When true, requests to this dynamic image URL are rate-limited per IP address to prevent abuse. Defaults to false.
enable_production_mode	boolean	No	When true, no rate limit is applied to requests but generated images are not saved back to the Abyssale application (they won't appear in the dashboard). When false (default/test mode), images are saved and visible in the dashboard.

Response

Field	Type	Description
id	string (uuid)	Unique ID of the dynamic image.
design_id	string (uuid)	ID of the associated design.
formats	array	List of formats available for this dynamic image. Each item includes id, uid, width, height, unit, and dynamic_image_url.

Response Example

INFO

Returns 200 if a dynamic image already exists for the design (idempotent), or 201 on first creation. The response body is identical in both cases.

{
  "id": "a12b3c4d-5e6f-7890-abcd-ef1234567890",
  "design_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "formats": [
    {
      "id": "facebook-post",
      "uid": "11111111-2222-3333-4444-555555555555",
      "width": 1200,
      "height": 1200,
      "unit": "px",
      "dynamic_image_url": "https://img.abyssale.com/a12b3c4d-5e6f-7890-abcd-ef1234567890/facebook-post"
    },
    {
      "id": "instagram-story",
      "uid": "66666666-7777-8888-9999-000000000000",
      "width": 1080,
      "height": 1920,
      "unit": "px",
      "dynamic_image_url": "https://img.abyssale.com/a12b3c4d-5e6f-7890-abcd-ef1234567890/instagram-story"
    }
  ]
}

Related

• Image Generation via URL — use the dynamic_image_url to generate images
• Design Details — retrieve dynamic_image_url for each format once created
• Overview — Dynamic Images — credits, caching, and bandwidth