Back to Home

Device Frame API

Apply device frames to screenshots via HTTP

v1.0.0 · OAS 3.1
Base URL
https://device-frames-api.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)
devicerequired
Device identifier (e.g., 'pixel-8-pro')
variationrequired
Variation (e.g., 'black')
categoryoptional
Category filter (e.g., 'android-phone')

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

{
  "count": 143,
  "devices": [
    {
      "category": "android-phone",
      "device": "pixel-8-pro",
      "variation": "black",
      "frame_size": { "width": 1621, "height": 3135 },
      "screen": { "x": 183, "y": 169, "width": 1255, "height": 2792 },
      "hex_color": "#464749"
    }
  ]
}

Categories

android-phoneandroid-tabletiOSiPad

Responses

200Successful Response
Returns JSON object with device metadata

OpenAPI Specification

View OpenAPI JSON