Skip to content

Images API

Import an image from a URL

POSThttps://email.growthdept.ai/api/images

Downloads the image (JPEG, PNG, GIF or WebP, at most 5 MB) into the account's library. A base64 data URL works too.

The request body can be up to 5 MB.

Rate limits

Burst: 3/s

Steady: 60/m

Daily: 500/day

Tier S. See rate limits for how requests are counted.

Scopes

images:write

Operation id

upload_image_from_url The same operation as in Klaviyo's API. OpenAPI document

Query parameters

array of strings

Attributes of image resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      image
    • idstring

    • attributesobjectrequired

      attributes: 3 fields
      • namestringcan be null

      • import_from_urlstringrequired

      • hiddenbooleancan be null

    • relationshipsobject

    • metaobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

201Success

Response body

object

  • dataobjectrequired

    data: 4 fields
    • typestringrequired

      image
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • namestringrequired

      • image_urlstringrequired

      • formatstringrequired

      • sizeintegerrequired

      • hiddenbooleanrequired

      • updated_atstring (date-time)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject