The Flixy API, in 5 minutes

Authentication

Base URL : https://flixy.design/api/v1/

Authorization: Bearer flx_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

The “X-Api-Key” header is also accepted. Limit: 60 requests per minute per key. Creations are paid in credits with your Business discount; a failed creation is refunded.

Examples

curl -X POST https://flixy.design/api/v1/generate.php \
  -H "Authorization: Bearer $FLIXY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format":"reel_video","prompt":"A runner smiles at sunrise"}'

const r = await fetch("https://flixy.design/api/v1/generate.php", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.FLIXY_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({ format: "reel_video", prompt: "A runner smiles at sunrise" }),
});
const job = await r.json();
// Poll job.status_url every 3 s until status is "done", then download job.url

import os, time, requests
H = {"Authorization": f"Bearer {os.environ['FLIXY_KEY']}"}
job = requests.post("https://flixy.design/api/v1/generate.php", headers=H,
                    json={"format": "reel_video", "prompt": "A runner smiles at sunrise"}).json()
while True:
    s = requests.get(job["status_url"], headers=H).json()
    if s["status"] in ("done", "failed"): break
    time.sleep(3)
print(s.get("url"))

$ch = curl_init("https://flixy.design/api/v1/generate.php");
curl_setopt_array($ch, [
  CURLOPT_POST => true, CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("FLIXY_KEY"), "Content-Type: application/json"],
  CURLOPT_POSTFIELDS => json_encode(["format" => "reel_video", "prompt" => "A runner smiles at sunrise"]),
]);
$job = json_decode(curl_exec($ch), true);

Endpoints

{
  "format": "native_square",
  "prompt": "A smiling runner at sunrise on a city bridge",
  "type": "image",
  "params": { "image_size": "2K" },
  "enhance": true
}

{
  "ok": true,
  "id": 1842,
  "status": "queued",
  "type": "image",
  "format": "native_square",
  "credits_charged": 0.29,
  "balance": 412.5,
  "status_url": "https://flixy.design/api/v1/status.php?id=1842"
}

{
  "ok": true,
  "id": 1842,
  "type": "image",
  "status": "done",
  "url": "https://flixy.design/api/v1/file.php?id=1842&exp=…&sig=…",
  "width": 2048,
  "height": 2048
}

{
  "kind": "push",
  "brief": "Meditation app, 7-day free trial, busy professionals",
  "lang": "en",
  "variants": 3,
  "tone": "warm",
  "brand": "Calmly"
}

{
  "ok": true,
  "kind": "push",
  "items": [
    { "title": "Breathe. Just 3 minutes.", "message": "Your 7-day free trial is ready.", "image_prompt": "…" }
  ],
  "credits_charged": 0.06,
  "balance": 412.44
}

{
  "brief": "Winter sale -40% on sneakers",
  "width": 300,
  "height": 250,
  "colors": "#FF80BF, #1E1A24",
  "cta": "Shop now",
  "lang": "en"
}

{
  "ok": true,
  "width": 300,
  "height": 250,
  "svg": "<svg xmlns=…>…</svg>",
  "credits_charged": 0.12
}

{
  "ok": true,
  "account": "Acme Inc.",
  "balance": 412.44,
  "discount_percent": 20,
  "credit_usd": 1
}

{ "ok": true, "formats": [ … ], "copy_kinds": [ … ] }

generate.php fields

Ad formats

Copy types (“kind” field of copy.php) : native push facebook tiktok banner ctv advertorial titles email

Errors

{ "ok": false, "error": { "code": "insufficient_credits", "message": "Not enough credits for this creation." } }

A technical question? Business support answers 24/7 : business@flixy.design.