API reference / Renders & exports

Export screenshots

POST/api/v1/screenshots/export

Authorization

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

Required permission exports:write

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

optionsbodyrequired

object

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)$"
    },
    "options": {
      "type": "object",
      "properties": {
        "platforms": {
          "minItems": 1,
          "maxItems": 2,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "ios",
              "android"
            ]
          }
        },
        "devices": {
          "minItems": 1,
          "maxItems": 3,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "phone",
              "tablet",
              "desktop"
            ]
          }
        },
        "languages": {
          "minItems": 1,
          "maxItems": 40,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          }
        },
        "iosDisplaySizes": {
          "default": [
            "6.5"
          ],
          "maxItems": 4,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "6.9",
              "6.5",
              "6.3",
              "6.1"
            ]
          }
        },
        "ipadDisplaySizes": {
          "default": [
            "12.9"
          ],
          "maxItems": 4,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "11",
              "13",
              "12.9",
              "10.5"
            ]
          }
        },
        "androidDisplaySizes": {
          "default": [
            "play-high"
          ],
          "maxItems": 2,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "play-high",
              "preview"
            ]
          }
        },
        "customSizes": {
          "default": [],
          "maxItems": 5,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 60
              },
              "label": {
                "type": "string",
                "maxLength": 80
              },
              "width": {
                "type": "integer",
                "minimum": 1,
                "maximum": 8192
              },
              "height": {
                "type": "integer",
                "minimum": 1,
                "maximum": 8192
              }
            },
            "required": [
              "id",
              "width",
              "height"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "platforms",
        "devices",
        "languages"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "projectId",
    "options"
  ],
  "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/export" \
  --header "Authorization: Bearer $ALF_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: $ALF_REQUEST_ID" \
  --data '{
  "projectId": "11111111-1111-4111-8111-111111111111",
  "options": {
    "platforms": [
      "ios"
    ],
    "devices": [
      "phone"
    ],
    "languages": [
      "en"
    ]
  }
}'

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.

The result’s fields are not yet described in the OpenAPI schema.

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 →