Screenshots API

Generate professional App Store and Play Store screenshots with customizable templates, device frames, and localized text.

Screenshots are generated using AI and professional templates. You provide the app screenshots and we add device frames, backgrounds, and marketing text.

Generate a single marketing screenshot with device frame and text overlay.

POST /projects/:projectId/screenshots

Authentication

Requires API key with Authorization: Bearer <api_key> header

URL Parameters

Name	Type	Required	Description
`projectId`	`string`	Yes	The project ID

Request Body

Name	Type	Required	Description
`sourceImage`	`string`	Yes	URL or base64-encoded screenshot image
`template`	`string`	No	Template style: "minimal", "gradient", "colorful" (default: `minimal`)
`device`	`string`	No	Device frame: "iphone-15-pro", "iphone-15", "ipad-pro", "pixel-8" (default: `iphone-15-pro`)
`headline`	`string`	No	Marketing headline text
`subheadline`	`string`	No	Subheadline text
`locale`	`string`	No	Locale for text (auto-translates if different from source) (default: `en-US`)
`backgroundColor`	`string`	No	Background color (hex) (default: `#0a0a0a`)
`textColor`	`string`	No	Text color (hex) (default: `#ffffff`)

Response Example

{
  "success": true,
  "data": {
    "screenshotId": "scr_abc123",
    "url": "https://cdn.appstorecopilot.com/screenshots/scr_abc123.png",
    "width": 1290,
    "height": 2796,
    "size": 524288,
    "expiresAt": "2024-01-22T10:00:00Z"
  }
}

Code Examples

curl -X POST https://api.appstorecopilot.com/v1/projects/proj_abc123/screenshots \
  -H "Authorization: Bearer $ASC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceImage": "https://example.com/screenshot.png",
    "template": "gradient",
    "device": "iphone-15-pro",
    "headline": "Track Your Tasks",
    "subheadline": "Stay organized and productive",
    "backgroundColor": "#1a1a2e"
  }'

Generate a complete set of screenshots for multiple devices and locales.

POST /projects/:projectId/screenshots/set

Authentication

Requires API key with Authorization: Bearer <api_key> header

URL Parameters

Name	Type	Required	Description
`projectId`	`string`	Yes	The project ID

Request Body

Name	Type	Required	Description
`sourceImages`	`string[]`	Yes	Array of source screenshot URLs (up to 10)
`devices`	`string[]`	Yes	Target devices: "iphone-6.7", "iphone-6.5", "ipad-12.9"
`locales`	`string[]`	No	Target locales for text translation (default: `["en-US"]`)
`headlines`	`string[]`	No	Headlines for each screenshot (in source language)
`template`	`string`	No	Template style to apply to all screenshots (default: `minimal`)

Response Example

{
  "success": true,
  "data": {
    "setId": "set_xyz789",
    "status": "processing",
    "totalScreenshots": 30,
    "completedScreenshots": 0,
    "estimatedTime": 60,
    "statusUrl": "https://api.appstorecopilot.com/v1/screenshots/sets/set_xyz789"
  }
}

Code Examples

curl -X POST https://api.appstorecopilot.com/v1/projects/proj_abc123/screenshots/set \
  -H "Authorization: Bearer $ASC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceImages": [
      "https://example.com/screenshot1.png",
      "https://example.com/screenshot2.png",
      "https://example.com/screenshot3.png"
    ],
    "devices": ["iphone-6.7", "iphone-6.5", "ipad-12.9"],
    "locales": ["en-US", "es-ES", "fr-FR"],
    "headlines": [
      "Track Your Tasks",
      "Stay Organized",
      "Achieve Your Goals"
    ],
    "template": "gradient"
  }'

Check the status of a screenshot set generation job.

GET /screenshots/sets/:setId

Authentication

Requires API key with Authorization: Bearer <api_key> header

URL Parameters

Name	Type	Required	Description
`setId`	`string`	Yes	The screenshot set ID

Response Example

{
  "success": true,
  "data": {
    "setId": "set_xyz789",
    "status": "completed",
    "totalScreenshots": 30,
    "completedScreenshots": 30,
    "screenshots": [
      {
        "id": "scr_001",
        "device": "iphone-6.7",
        "locale": "en-US",
        "url": "https://cdn.appstorecopilot.com/screenshots/scr_001.png"
      }
    ]
  }
}

Code Examples

curl https://api.appstorecopilot.com/v1/screenshots/sets/set_xyz789 \
  -H "Authorization: Bearer $ASC_API_KEY"

Supported Device Sizes

Device	Size	Store
`iphone-6.7`	1290 × 2796	App Store (iPhone 15 Pro Max)
`iphone-6.5`	1284 × 2778	App Store (iPhone 14 Plus)
`iphone-5.5`	1242 × 2208	App Store (iPhone 8 Plus)
`ipad-12.9`	2048 × 2732	App Store (iPad Pro)
`phone`	1080 × 1920	Play Store (Phone)
`tablet-7`	1200 × 1920	Play Store (7" Tablet)