Skip to content

Quick Start

Generate your first device mockup in under a minute.

Prerequisites

1. Make Your First Request

bash
curl -X POST https://shotprose.com/api/v1/mockup \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "screenshot_url": "https://example.com/screenshot.png",
    "settings": {
      "device": "iphone-15-pro-max"
    }
  }'
javascript
const response = await fetch('https://shotprose.com/api/v1/mockup', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    screenshot_url: 'https://example.com/screenshot.png',
    settings: {
      device: 'iphone-15-pro-max'
    }
  })
});

const data = await response.json();
console.log(data.image.data); // base64 image
python
import requests

response = requests.post(
    'https://shotprose.com/api/v1/mockup',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={
        'screenshot_url': 'https://example.com/screenshot.png',
        'settings': {
            'device': 'iphone-15-pro-max'
        }
    }
)

data = response.json()
print(data['image']['data'])  # base64 image

2. Handle the Response

The API returns a JSON response with the generated image:

json
{
  "success": true,
  "image": {
    "data": "iVBORw0KGgoAAAANSUhEUgAA...", // base64 encoded
    "mimeType": "image/webp",
    "width": 1920,
    "height": 1080
  },
  "duration": 2340
}

3. Save the Image

javascript
const buffer = Buffer.from(data.image.data, 'base64');
fs.writeFileSync('mockup.png', buffer);
python
import base64

image_bytes = base64.b64decode(data['image']['data'])
with open('mockup.png', 'wb') as f:
    f.write(image_bytes)

4. Get Raw Image (Optional)

Add ?output=raw to receive the image bytes directly instead of JSON:

bash
curl -X POST "https://shotprose.com/api/v1/mockup?output=raw" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"screenshot_url": "https://example.com/screenshot.png"}' \
  --output mockup.png

Next Steps

Shotprose API Documentation