API reference / Mockups

Set up mockups

POST/api/v1/mockups/setup

Authorization

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

Required permission designs: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

generationIdbodyrequired

string · uuid

screenshotPathbodyrequired

string

min length: 1 · max length: 1024

presetIdbodyrequired

"hero-launch" | "pivot-showcase" | "slow-rotate" | "drifting-tilt"

devicebodyoptional

"phone" | "tablet" | "laptop"

default: "phone"

platformbodyoptional

"ios" | "android"

outputRatiobodyoptional

"1:1" | "4:3" | "16:9" | "9:16"

motionDurationSecondsbodyoptional

number

minimum: 1 · maximum: 60

labelbodyoptional

string

min length: 1 · max length: 120

View complete request schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "generationId": {
      "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)$"
    },
    "screenshotPath": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024
    },
    "presetId": {
      "type": "string",
      "enum": [
        "hero-launch",
        "pivot-showcase",
        "slow-rotate",
        "drifting-tilt"
      ]
    },
    "device": {
      "default": "phone",
      "type": "string",
      "enum": [
        "phone",
        "tablet",
        "laptop"
      ]
    },
    "platform": {
      "type": "string",
      "enum": [
        "ios",
        "android"
      ]
    },
    "outputRatio": {
      "type": "string",
      "enum": [
        "1:1",
        "4:3",
        "16:9",
        "9:16"
      ]
    },
    "motionDurationSeconds": {
      "type": "number",
      "minimum": 1,
      "maximum": 60
    },
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    }
  },
  "required": [
    "generationId",
    "screenshotPath",
    "presetId"
  ],
  "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/mockups/setup" \
  --header "Authorization: Bearer $ALF_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: $ALF_REQUEST_ID" \
  --data '{
  "generationId": "11111111-1111-4111-8111-111111111111",
  "screenshotPath": "string",
  "presetId": "hero-launch"
}'

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

projectdatarequired

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)$"
        },
        "project": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        }
      },
      "required": [
        "variantId",
        "project"
      ]
    },
    "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 →