Import template image
import_template_imageUpload and attach an image to a template draft canvas for background or sample imagery. Use only during template authoring, not for general media library assets.
Instructions
Upload and attach a transient image asset specifically to a template draft canvas. Call while authoring a template draft in canvas studio to place background or sample imagery. Do NOT use for general workspace media library assets, logos, and photos (use import_image instead). Requires draft owner authorization and idempotencyKey. Idempotent: duplicate uploads with identical idempotencyKey return the existing asset. Returns created template image asset with imageId, dimensions, and public CDN preview URL.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| creator | No | Optional author or photographer attribution name. | |
| draftId | Yes | The unique template draft ID this image is attached to. | |
| license | No | Optional license type identifier. | |
| fileName | Yes | Original image filename (e.g. background.jpg). | |
| mimeType | Yes | MIME type: image/jpeg | image/png | image/webp | |
| provider | Yes | Asset origin provider: pinterest | unsplash | pexels | user_upload | generated | |
| sourceUrl | No | Optional source URL if fetched from web. | |
| dataBase64 | Yes | Base64-encoded image binary string. | |
| externalId | No | Optional external asset ID from provider. | |
| attribution | No | Optional human-readable attribution string. | |
| searchQuery | No | Optional search keyword that discovered this image. | |
| rightsStatus | Yes | Rights ownership status: rights_unknown | licensed_for_publish | user_owned | generated | |
| idempotencyKey | Yes | Unique idempotency key to prevent duplicate image creation. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Public delivery URL. | |
| imageId | No | Created template image ID. |