# Upload Image From URL
Import an image from a url or data uri.
If you want to upload an image from a file, use the Upload Image From File endpoint instead.
*Rate limits*:
Burst: `3/s`
Steady: `100/m`
Daily: `100/d`
**Scopes:**
`images:write`
# OpenAPI definition
```json
{
"openapi": "3.0.2",
"info": {
"title": "Images API",
"version": "2025-01-15",
"description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.",
"contact": {
"name": "Klaviyo Developer Experience Team",
"email": "developers@klaviyo.com",
"url": "https://developers.klaviyo.com"
},
"termsOfService": "https://www.klaviyo.com/legal/api-terms",
"license": {
"name": "License",
"url": "https://www.klaviyo.com/legal"
}
},
"servers": [
{
"url": "https://a.klaviyo.com",
"description": "Production"
}
],
"paths": {
"/api/images": {
"post": {
"operationId": "upload_image_from_url",
"summary": "Upload Image From URL",
"description": "Import an image from a url or data uri.\n\nIf you want to upload an image from a file, use the Upload Image From File endpoint instead.
*Rate limits*:
Burst: `3/s`
Steady: `100/m`
Daily: `100/d`\n\n**Scopes:**\n`images:write`",
"parameters": [
{
"name": "revision",
"in": "header",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"required": true,
"schema": {
"type": "string",
"default": "2025-01-15"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ImageCreateQuery"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostImageResponse"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"tags": [
"Images"
],
"x-klaviyo-operation-aliases": [
"create_image"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "100/m",
"daily": "100/d"
},
"x-klaviyo-scopes": [
"images:write"
]
}
}
},
"components": {
"schemas": {
"ImageEnum": {
"type": "string",
"enum": [
"image"
]
},
"ImageCreateQueryResourceObject": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/ImageEnum"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"description": "A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added.",
"type": "string"
},
"import_from_url": {
"description": "An existing image url to import the image from. Alternatively, you may specify a base-64 encoded data-uri (`data:image/...`). Supported image formats: jpeg,png,gif. Maximum image size: 5MB.",
"type": "string",
"example": "https://www.example.com/example.jpg"
},
"hidden": {
"description": "If true, this image is not shown in the asset library.",
"type": "boolean",
"default": false
}
},
"required": [
"import_from_url"
]
}
},
"required": [
"type",
"attributes"
]
},
"ImageCreateQuery": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ImageCreateQueryResourceObject"
}
},
"required": [
"data"
]
},
"PostImageResponse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/ImageEnum"
},
"id": {
"description": "The ID of the image",
"type": "string",
"example": "7"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"image_url": {
"type": "string"
},
"format": {
"type": "string"
},
"size": {
"type": "integer"
},
"hidden": {
"type": "boolean"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00"
}
},
"required": [
"name",
"image_url",
"format",
"size",
"hidden",
"updated_at"
]
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
}
},
"required": [
"data"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
}
},
"responses": {
"ClientError": {
"description": "Client Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
},
"ServerError": {
"description": "Server Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
}
},
"securitySchemes": {
"Klaviyo-API-Key": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key`
For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Images"
}
],
"security": [
{
"Klaviyo-API-Key": []
}
],
"x-readme": {
"explorer-enabled": false,
"proxy-enabled": true,
"samples-enabled": true
},
"_id": {
"buffer": {
"0": 103,
"1": 226,
"2": 175,
"3": 88,
"4": 45,
"5": 92,
"6": 183,
"7": 0,
"8": 55,
"9": 12,
"10": 62,
"11": 91
}
}
}
```