API reference / Screenshots

screenshots preview post

POST/api/v1/screenshots/preview

Authorization

Send your API key or MCP OAuth token in the Authorization: Bearer header. Active or trialing Unlimited is required.

Required permission designs:read

Every mutation requires JSON and an Idempotency-Key. Reuse the same key and exact input when retrying.

Parameters

Idempotency-Keyheaderrequired

string

Persist this key for retries. Reusing it with changed input returns 409. Receipts are retained for at least 24 hours.

min length: 8 · max length: 128

Request body

application/json

projectIdbodyrequired

string · uuid

variantIdbodyoptional

string · uuid

languagebodyoptional

string

min length: 1 · max length: 40

devicebodyoptional

"phone" | "tablet" | "desktop"

default: "phone"

platformbodyoptional

"ios" | "android"

displaySizebodyoptional

"11" | "13" | "6.9" | "6.5" | "6.3" | "6.1" | "duo-inner" | "duo-outer" | "12.9" | "10.5" | "play-high" | "preview"

screensbodyoptional

integer[]

min items: 1 · max items: 10

maxEdgebodyoptional

integer

minimum: 200 · maximum: 1600 · default: 1024

formatbodyoptional

"png" | "jpeg"

default: "jpeg"

View complete request schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "variantId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "language": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "device": {
      "default": "phone",
      "type": "string",
      "enum": [
        "phone",
        "tablet",
        "desktop"
      ]
    },
    "platform": {
      "type": "string",
      "enum": [
        "ios",
        "android"
      ]
    },
    "displaySize": {
      "type": "string",
      "enum": [
        "11",
        "13",
        "6.9",
        "6.5",
        "6.3",
        "6.1",
        "duo-inner",
        "duo-outer",
        "12.9",
        "10.5",
        "play-high",
        "preview"
      ]
    },
    "screens": {
      "minItems": 1,
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": 0,
        "maximum": 9007199254740991
      }
    },
    "maxEdge": {
      "default": 1024,
      "type": "integer",
      "minimum": 200,
      "maximum": 1600
    },
    "format": {
      "default": "jpeg",
      "type": "string",
      "enum": [
        "png",
        "jpeg"
      ]
    }
  },
  "required": [
    "projectId"
  ],
  "additionalProperties": false
}

Request example

Set ALF_API_URL to https://dashboard.applaunchflow.com/api/v1 and ALF_API_KEY to your key. Replace sample IDs with your project’s values. Use a new ALF_REQUEST_ID for each new operation.

cURL

curl --request POST \
  --url "$ALF_API_URL/screenshots/preview" \
  --header "Authorization: Bearer $ALF_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: $ALF_REQUEST_ID" \
  --data '{
  "projectId": "11111111-1111-4111-8111-111111111111"
}'

This example shows the request structure. Some editor operations require additional query parameters that are not yet described in OpenAPI.

Response

Successful JSON responses wrap the result in data, with a request ID in meta.requestId.

variantIddatarequired

string · uuid

languagedatarequired

string

platformdatarequired

string

devicedatarequired

string

sizedatarequired

string

imagesdatarequired

object[]

View response schema

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "variantId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "language": {
          "type": "string"
        },
        "platform": {
          "type": "string"
        },
        "device": {
          "type": "string"
        },
        "size": {
          "type": "string"
        },
        "images": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "screenIndex": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "width": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "height": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "mimeType": {
                "type": "string"
              },
              "url": {
                "type": "string"
              },
              "expiresAt": {
                "type": "string"
              }
            },
            "required": [
              "screenIndex",
              "width",
              "height",
              "mimeType",
              "url",
              "expiresAt"
            ]
          }
        }
      },
      "required": [
        "variantId",
        "language",
        "platform",
        "device",
        "size",
        "images"
      ],
      "additionalProperties": {}
    },
    "meta": {
      "type": "object",
      "required": [
        "requestId"
      ],
      "properties": {
        "requestId": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

Errors & retries

Errors use application/problem+json. Check the stable code and keep requestId when contacting support. Respect Retry-After on 429 responses.

See error handling and idempotency →