API reference / Other
website post
POST
/api/v1/websiteParameters
Idempotency-Keyheaderrequiredstring
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
generationIdbodyrequiredstring · uuid
variantIdbodyrequiredstring · uuid
documentbodyrequiredobject
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)$"
},
"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)$"
},
"document": {
"type": "object",
"properties": {
"uiText": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 40
},
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"sourceLanguage": {
"type": "string"
},
"translations": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"copy": {
"type": "object",
"properties": {
"featureIds": {
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
"fields": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 200
},
"additionalProperties": {
"type": "string",
"maxLength": 100000
}
},
"richText": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "doc"
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"text": {
"type": "string"
},
"marks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"attrs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
},
"attrs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type",
"content"
],
"additionalProperties": {}
}
},
"mobileText": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"richTextMobile": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "doc"
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"text": {
"type": "string"
},
"marks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"attrs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
},
"attrs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type",
"content"
],
"additionalProperties": {}
}
}
},
"required": [
"featureIds",
"fields",
"richText",
"mobileText",
"richTextMobile"
]
},
"sourceHash": {
"type": "string",
"maxLength": 64
}
},
"required": [
"copy",
"sourceHash"
]
}
},
"version": {
"default": 1,
"type": "number",
"const": 1
},
"theme": {
"type": "object",
"properties": {
"paletteMode": {
"default": "v1",
"type": "string",
"enum": [
"v1",
"v2"
]
},
"paletteOptions": {
"default": {
"v1": {
"primary": "#ffffff",
"secondary": "#f3f5f9",
"accent": "#2563eb",
"text": "#0f172a",
"textSecondary": "#64748b"
},
"v2": {
"primary": "#0b0d12",
"secondary": "#141821",
"accent": "#60a5fa",
"text": "#f5f7fa",
"textSecondary": "#9aa4b5"
}
},
"type": "object",
"properties": {
"v1": {
"type": "object",
"properties": {
"primary": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"secondary": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"accent": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"text": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"textSecondary": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
}
},
"required": [
"primary",
"secondary",
"accent",
"text",
"textSecondary"
]
},
"v2": {
"type": "object",
"properties": {
"primary": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"secondary": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"accent": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"text": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"textSecondary": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
}
},
"required": [
"primary",
"secondary",
"accent",
"text",
"textSecondary"
]
}
},
"required": [
"v1",
"v2"
]
},
"fontFamily": {
"default": "Inter",
"type": "string",
"enum": [
"Poppins",
"Inter",
"Montserrat",
"Open Sans",
"Roboto",
"Lato",
"Space Grotesk",
"Nunito",
"Baloo 2",
"Playfair Display",
"Georgia",
"Merriweather",
"Lora",
"Times New Roman",
"Bebas Neue",
"Oswald"
]
}
}
},
"sectionOrder": {
"default": [
"hero",
"features",
"showcase",
"cta"
],
"type": "array",
"items": {
"type": "string",
"enum": [
"hero",
"features",
"showcase",
"cta"
]
}
},
"hero": {
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eyebrow": {
"default": "",
"type": "string",
"maxLength": 60
},
"headline": {
"default": "",
"type": "string",
"maxLength": 120
},
"subheadline": {
"default": "",
"type": "string",
"maxLength": 320
},
"deviceModelId": {
"default": "iphone-17-pro",
"type": "string",
"enum": [
"iphone-17-pro",
"google-pixel-10-pro",
"ipad-pro",
"macbook-pro-14",
"iphone-duo"
]
},
"deviceFinish": {
"default": "black",
"type": "string",
"enum": [
"silver",
"black",
"glacier",
"burgundy",
"cosmic-orange",
"deep-blue",
"pixel-obsidian",
"pixel-porcelain",
"pixel-moonstone",
"duo-night-sky",
"duo-star-white"
]
},
"devicePose": {
"default": {},
"type": "object",
"properties": {
"rotationX": {
"default": -0.19198621771937624,
"type": "number",
"minimum": -3.141592653589793,
"maximum": 3.141592653589793
},
"rotationY": {
"default": -0.2617993877991494,
"type": "number",
"minimum": -3.141592653589793,
"maximum": 3.141592653589793
},
"rotationZ": {
"default": -0.05235987755982989,
"type": "number",
"minimum": -3.141592653589793,
"maximum": 3.141592653589793
}
}
},
"devicePosition": {
"default": {},
"type": "object",
"properties": {
"x": {
"default": 0,
"type": "number",
"minimum": -50,
"maximum": 50
},
"y": {
"default": 0,
"type": "number",
"minimum": -50,
"maximum": 50
}
}
},
"deviceScale": {
"default": 1.3,
"type": "number",
"minimum": 0.6,
"maximum": 1.8
},
"devicePositionMobile": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -50,
"maximum": 50
},
"y": {
"type": "number",
"minimum": -50,
"maximum": 50
}
},
"required": [
"x",
"y"
]
},
"deviceScaleMobile": {
"type": "number",
"minimum": 0.6,
"maximum": 1.8
},
"screenshotPath": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"deviceStillPath": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"showAppStoreBadge": {
"default": true,
"type": "boolean"
},
"showGooglePlayBadge": {
"default": true,
"type": "boolean"
}
}
},
"features": {
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"layout": {
"default": "story",
"type": "string",
"enum": [
"story",
"stack"
]
},
"title": {
"default": "",
"type": "string",
"maxLength": 120
},
"subtitle": {
"default": "",
"type": "string",
"maxLength": 240
},
"items": {
"default": [],
"maxItems": 8,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"icon": {
"default": "sparkle",
"type": "string",
"enum": [
"sparkle",
"lightning",
"shield",
"heart",
"star",
"rocket",
"clock",
"chart",
"bell",
"lock",
"globe",
"users",
"camera",
"music",
"wallet",
"map"
]
},
"storyFocus": {
"type": "string",
"enum": [
"full",
"top",
"center",
"bottom"
]
},
"storyTransition": {
"type": "string",
"enum": [
"tilt",
"flip"
]
},
"title": {
"default": "",
"type": "string",
"maxLength": 80
},
"description": {
"default": "",
"type": "string",
"maxLength": 280
},
"deviceModelId": {
"default": "iphone-17-pro",
"type": "string",
"enum": [
"iphone-17-pro",
"google-pixel-10-pro",
"ipad-pro",
"macbook-pro-14",
"iphone-duo"
]
},
"deviceFinish": {
"default": "black",
"type": "string",
"enum": [
"silver",
"black",
"glacier",
"burgundy",
"cosmic-orange",
"deep-blue",
"pixel-obsidian",
"pixel-porcelain",
"pixel-moonstone",
"duo-night-sky",
"duo-star-white"
]
},
"devicePose": {
"default": {},
"type": "object",
"properties": {
"rotationX": {
"default": 0,
"type": "number",
"minimum": -3.141592653589793,
"maximum": 3.141592653589793
},
"rotationY": {
"default": 0,
"type": "number",
"minimum": -3.141592653589793,
"maximum": 3.141592653589793
},
"rotationZ": {
"default": 0,
"type": "number",
"minimum": -3.141592653589793,
"maximum": 3.141592653589793
}
}
},
"devicePosition": {
"default": {},
"type": "object",
"properties": {
"x": {
"default": 0,
"type": "number",
"minimum": -50,
"maximum": 50
},
"y": {
"default": 0,
"type": "number",
"minimum": -50,
"maximum": 50
}
}
},
"deviceScale": {
"default": 1,
"type": "number",
"minimum": 0.6,
"maximum": 1.8
},
"devicePositionMobile": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -50,
"maximum": 50
},
"y": {
"type": "number",
"minimum": -50,
"maximum": 50
}
},
"required": [
"x",
"y"
]
},
"deviceScaleMobile": {
"type": "number",
"minimum": 0.6,
"maximum": 1.8
}
},
"required": [
"id"
]
}
},
"screenshotPaths": {
"default": [],
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
}
}
},
"showcase": {
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"title": {
"default": "",
"type": "string",
"maxLength": 120
},
"subtitle": {
"default": "",
"type": "string",
"maxLength": 240
},
"layout": {
"default": "marquee",
"type": "string",
"enum": [
"marquee",
"grid"
]
},
"source": {
"default": "raw",
"type": "string",
"enum": [
"raw",
"layouts"
]
},
"screenshotVariantId": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
},
"screenshotPaths": {
"default": [],
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
}
}
},
"cta": {
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"headline": {
"default": "",
"type": "string",
"maxLength": 120
},
"subheadline": {
"default": "",
"type": "string",
"maxLength": 240
}
}
},
"links": {
"default": {},
"type": "object",
"properties": {
"appStoreUrl": {
"default": "",
"type": "string",
"maxLength": 2048
},
"googlePlayUrl": {
"default": "",
"type": "string",
"maxLength": 2048
},
"websiteUrl": {
"default": "",
"type": "string",
"maxLength": 2048
},
"twitterUrl": {
"default": "",
"type": "string",
"maxLength": 2048
},
"instagramUrl": {
"default": "",
"type": "string",
"maxLength": 2048
},
"tiktokUrl": {
"default": "",
"type": "string",
"maxLength": 2048
},
"youtubeUrl": {
"default": "",
"type": "string",
"maxLength": 2048
},
"linkedinUrl": {
"default": "",
"type": "string",
"maxLength": 2048
},
"contactEmail": {
"default": "",
"type": "string",
"maxLength": 200
}
}
},
"legal": {
"default": {},
"type": "object",
"properties": {
"privacy": {
"default": "",
"type": "string",
"maxLength": 60000
},
"terms": {
"default": "",
"type": "string",
"maxLength": 60000
},
"support": {
"default": "",
"type": "string",
"maxLength": 20000
}
}
},
"seo": {
"default": {},
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 120
},
"description": {
"default": "",
"type": "string",
"maxLength": 320
},
"ogImagePath": {
"default": null,
"anyOf": [
{
"type": "string",
"maxLength": 400
},
{
"type": "null"
}
]
}
}
},
"richText": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "doc"
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"text": {
"type": "string"
},
"marks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"attrs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
},
"attrs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type",
"content"
],
"additionalProperties": {}
}
},
"mobileText": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"richTextMobile": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "doc"
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"text": {
"type": "string"
},
"marks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"attrs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
}
},
"required": [
"type"
],
"additionalProperties": {}
}
},
"attrs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type",
"content"
],
"additionalProperties": {}
}
},
"generated": {
"default": false,
"type": "boolean"
}
},
"required": [
"theme"
]
}
},
"required": [
"generationId",
"variantId",
"document"
],
"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/website" \
--header "Authorization: Bearer $ALF_API_KEY" \
--header "Content-Type: application/json" \
--header "Idempotency-Key: $ALF_REQUEST_ID" \
--data '{
"generationId": "11111111-1111-4111-8111-111111111111",
"variantId": "11111111-1111-4111-8111-111111111111",
"document": {
"theme": {}
}
}'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.
projectdatarequiredobject
View response schema
{
"type": "object",
"required": [
"data",
"meta"
],
"properties": {
"data": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"project": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"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.