Images API

REST API endpoints for uploading and generating product images.

Upload Images

POST /api/v1/images
Content-Type: multipart/form-data

Upload one or more image files to blob storage. Returns URLs that can be used in product creation.

Limits

Constraint	Value
Max files per request	10
Max file size	10 MB
Accepted types	Any `image/*` MIME type

# Single file
curl -X POST \
  -H "Authorization: Bearer your_api_key" \
  -F "file=@product-photo.jpg" \
  https://your-store.yns.store/api/v1/images

# Multiple files
curl -X POST \
  -H "Authorization: Bearer your_api_key" \
  -F "file=@photo1.jpg" \
  -F "file=@photo2.png" \
  https://your-store.yns.store/api/v1/images

Response

{
  "images": [
    {
      "url": "https://your-store.blob.vercel-storage.com/images/store-id/production/api-upload-photo1-abc123.jpg",
      "pathname": "images/store-id/production/api-upload-photo1-abc123.jpg"
    }
  ]
}

Generate Image

POST /api/v1/images/generate

Generates an image using AI from a text prompt. The image is uploaded to the store's CDN and returns the URL. Timeout: 30 seconds.

Request Body

Field	Type	Required	Description
`prompt`	`string`	Yes	Text prompt (1-1000 characters)
`type`	`string`	No	Image type: `product`, `collection`, or `hero` (default: `product`)
`name`	`string`	No	Filename prefix (default: `generated`)

The type parameter affects the generated image's aspect ratio and style:

Type	Use Case
`product`	Square product photos, clean backgrounds
`collection`	Wide banner images for collection headers
`hero`	Full-width hero images for landing pages

curl -X POST \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A minimalist ceramic coffee mug on a marble surface, soft natural lighting",
    "type": "product",
    "name": "coffee-mug"
  }' \
  https://your-store.yns.store/api/v1/images/generate

Response

{
  "url": "https://your-store.blob.vercel-storage.com/images/coffee-mug-abc123.png",
  "pathname": "images/coffee-mug-abc123.png"
}

PreviousSubscribersAPI Reference