TEASEDocs
API ReferencePages & Publish

Upload a background source image

Uploads the original (un-edited) background image for a domain and variant, stored as the draft source. Requires a write-scoped key.

Authorization

bearerAuth
AuthorizationBearer <token>

Your al_live_<prefix>_<secret> API key. Mint and manage keys in the dashboard.

In: header

Query Parameters

domain*string

Registered hostname, e.g. onlydasha.com.

variant?string

Which background variant to set.

Default"mobile"

Value in

  • "mobile"
  • "desktop"

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

POST
/api/admin/bg/upload
curl -X POST "https://example.com/api/admin/bg/upload?domain=string" \  -F file="string"
{  "size": 842113,  "ext": ".jpg",  "variant": "mobile",  "domain": "onlydasha.com"}
{  "detail": {    "code": "bg_type",    "message": "Allowed: JPEG, PNG, WebP or AVIF"  }}
{  "detail": {    "code": "domain_not_found",    "message": "Domain 'onlydasha.com' is not registered"  }}

Apply a preset to domains

Stamps the preset into each target domain's draft banner (texts, files, preset_id and a single-preset assignment), materializes the preset's master files into each domain folder, and enables the banner only when the preset is complete (all texts, an avatar and — in the 'manual' link mode — the link). Drafts are re-baked; going live stays an explicit /publish. Requires a write-scoped key.

Apply background edits and regenerate variants

Applies the client-side image-editor design state to the uploaded source and regenerates the responsive draft background variants. Requires a write-scoped key.