Back to Home

Device Frame API

Apply device frames to screenshots via HTTP

v1.0.0 · OAS 3.1
Base URL
https://device-frames.fly.dev
POST/apply_frame

Apply Frame

Apply a device frame to an uploaded screenshot.

Request Body

multipart/form-data
filerequired
Screenshot image file (PNG, JPEG, or WebP)
device_typerequired
Device type (e.g., '16 Pro Max')
device_variationrequired
Device variation (e.g., 'Blue Titanium')
categoryoptional
Device category (e.g., 'iOS')
background_coloroptional
Background color as hex (#RRGGBB or #RRGGBBAA). Default: transparent

Responses

200Successful Response
Returns framed image as PNG file
422Validation Error
{
  "detail": [
    {
      "loc": ["string", 0],
      "msg": "string",
      "type": "string"
    }
  ]
}
GET/list_devices

List Devices

List all available device frames with their metadata.

Response Structure

{
  "category": {
    "device_type": {
      "variation": {
        "frame_png": "path/to/frame.png",
        "template": {...template.json content...},
        "frame_size": {
          "width": 1234,
          "height": 5678
        }
      }
    }
  }
}

Categories

android-phoneandroid-tabletiOSiPad

Responses

200Successful Response
Returns JSON object with device metadata

OpenAPI Specification

View OpenAPI JSON