Skip to main content

ImageVariationsResponse

images object[]required
  • Array [
  • idstringrequired

    Numeric media id, returned as a string (the engine casts it). Use uuid to address media in the API.

    Example: 42
    uuidstring<uuid>required
    namestringrequired
    mime_typestringrequired
    Example: image/jpeg
    typestringrequired

    Possible values: [image, video, gif]

    urlstring<uri>required
    thumb_url(string | null)<uri>nullable
    is_videobooleanrequired
    is_processingboolean

    True while an uploaded video is still being converted.

    widthinteger | nullnullable

    Width in pixels, when stored.

    heightinteger | nullnullable

    Height in pixels, when stored.

    duration_msinteger | nullnullable

    Video duration in milliseconds; null for images or videos not read yet.

    sizeinteger

    File size in bytes.

    alt_textstring | nullnullable
    folder object

    The folder the item is filed in, or null when it sits at the library root (or the folder was not loaded).

    oneOf
    uuidstring<uuid>required
    namestringrequired
    created_atstringrequired

    Y-m-d H:i:s in UTC (not RFC 3339).

    Example: 2026-10-16 05:30:00
  • ]
  • aspect_ratiostringrequired
    Example: 1:1
    qualitystringrequired
    Example: standard
    credits_usedintegerrequired

    Text credits only. 0 while the image credit pool is on; count × credit_weight when it is switched off.

    Example: 0
    credits_remaininginteger | nullnullable

    Text credits left this billing cycle (null = no limit).

    Example: 45
    image_credits_usedintegerrequired

    Image credits this call spent (1 per image; 0 when the image credit pool is switched off).

    Example: 1
    image_credits_remaininginteger | nullnullablerequired

    Image credits left this month (null = no limit, or the image credit pool is switched off).

    Example: 29
    ImageVariationsResponse
    {
    "images": [
    {
    "id": "42",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "mime_type": "image/jpeg",
    "type": "image",
    "url": "string",
    "thumb_url": "string",
    "is_video": true,
    "is_processing": true,
    "width": 0,
    "height": 0,
    "duration_ms": 0,
    "size": 0,
    "alt_text": "string",
    "folder": {
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
    },
    "created_at": "2026-10-16 05:30:00"
    }
    ],
    "aspect_ratio": "1:1",
    "quality": "standard",
    "credits_used": 0,
    "credits_remaining": 45,
    "image_credits_used": 1,
    "image_credits_remaining": 29
    }