API dokumentatsioon

Sissejuhatus

Flixy API võimaldab teie tarkvaral kasutada Flixy Studio funktsioone: luua kirjelduse põhjal terviklikke veebisaite, neid muuta ja tõlkida, kirjutada veebisaidi sisu, lugeda menüüsid, katalooge ja PDF-faile ning luua pilte ja logosid. Maksate ainult õnnestunud päringute eest, ettemakstud saldost.

Pikad ülesanded (veebisaidi loomine, muutmine või tõlkimine) käivituvad töödena: API vastab kohe ning teie jälgite tööd või saate webhooki. Sisu, dokumentide lugemine ja pildid vastavad otse, tavaliselt mõne sekundiga.

Arendajakonsool

Võtmeid, saldot, täiendusi, webhooke ja päringute logisid hallatakse arendajakonsoolis aadressil dev.flixy.studio.

• Eraldi arendajakonto. Nagu teistelgi AI-platvormidel, on teie arendajakonto teie Flixy Studio kontost eraldi: sellel on oma registreerumine, sisselogimine ja seanss. Ühest välja logimine ei logi teid kunagi teisest välja. Mõlema jaoks võite kasutada sama e-posti aadressi.
• Seotud organisatsioon. Kui kasutate ka Flixy Studiot, saate oma organisatsiooni oma arendajakontoga siduda, et API saaks selle veebisaitidega töötada. Vt Seotud organisatsioon.
• Konto turvalisus. Kaheastmeline kinnitamine, aktiivsed seansid ja andmete eksport on saadaval konsoolis jaotises Konto.

Autentimine

Saatke oma võti iga päringu päises Authorization. Võtmed algavad eesliitega fx_live_ või fx_test_.

Authorization: Bearer fx_live_8sJ2…

curl https://flixy.studio/v1/account \
  -H "Authorization: Bearer $FLIXY_API_KEY"

Igal võtmel on õigused (scopes). Päring ilma vajaliku õiguseta tagastab 403 missing_scope.

Test- ja live-võtmed

• Testvõtmed (fx_test_…) on tasuta. Need tagastavad realistlikke näidisvastuseid AI-d kasutamata, nii et saate kogu integratsiooni ehitada ja testida. Veebisaidi tööd lõpevad mõne sekundi pärast näidisveebisaidiga.
• Live-võtmed (fx_live_…) tagastavad päris tulemusi ja nende eest võetakse tasu teie saldost.

Iga vastus sisaldab päist Flixy-Mode: test või Flixy-Mode: live.

Päringud ja vastused

Saatke JSON-kehad päisega Content-Type: application/json (kuni 16 MB). Vastused on JSON-vormingus. Kuupäevad on ISO 8601 vormingus UTC-ajas. Igal vastusel on päis X-Request-Id: andke see meie toele, kui vajate päringuga abi.

Määrake Accept-Language, et saada veateateid oma keeles (fr, en, es, de, it, pt, nl, ca, el, sv, no, da, fi, is, et, lv, lt, ja; vaikimisi inglise keeles).

Vead

Vead kasutavad standardseid HTTP olekukoode ja neil on alati sama kuju:

{
  "error": {
    "type": "billing_error",
    "code": "insufficient_balance",
    "message": "Insufficient balance: top up your developer account…",
    "request_id": "req_5c1f0a9e2b7d4c11"
  }
}

Päringupiirangud

• 60 päringut minutis võtme kohta (päis X-RateLimit-Limit).
• 3 veebisaidi tööd korraga konto kohta. Sisu, dokumentide ja piltide päringuid see piirang ei puuduta.
• Kui piirang on saavutatud, vastab API koodiga 429 ja päisega Retry-After sekundites.

Vajate rohkem? Kirjutage aadressile contact@flixy.studio ja kirjeldage oma kasutusjuhtu.

Idempotentsus

Võrguvead juhtuvad. Lisage päis Idempotency-Key (8 kuni 100 märki, näiteks teie enda tellimuse ID) igale POST-päringule: kui saadate sama päringu uuesti 24 tunni jooksul, tagastab API esimese vastuse — päisega Idempotent-Replayed: true — ega täida ega arvelda tööd kunagi kaks korda.

Tööd

Veebisaidi loomine, muutmine ja tõlkimine võtab umbes 30 sekundist 3 minutini. Need lõpp-punktid vastavad koodiga 202 Accepted ja tööga. Jälgige seda iga 5 sekundi järel või oodake sündmust job.succeeded / job.failed webhooki kaudu.

{
  "id": "job_69023cfbb08a8130d8f6",
  "object": "job",
  "type": "site",
  "status": "succeeded",
  "mode": "live",
  "site_id": "691589621",
  "price": 0.72,
  "currency": "EUR",
  "created_at": "2026-11-11T09:45:01Z",
  "finished_at": "2026-11-11T09:46:35Z",
  "result": { "id": "691589621", "object": "site", "status": "ready", "pages": ["index.html", "menu.html"] }
}

status on queued, running, succeeded või failed. Ebaõnnestunud töö eest ei võeta kunagi tasu ja selle error selgitab põhjust.

Veebisaidi loomine

Loob kirjelduse põhjal tervikliku veebisaidi. Õigus: sites:write.

curl https://flixy.studio/v1/sites \
  -H "Authorization: Bearer $FLIXY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1042" \
  -d '{
    "prompt": "Website for an artisan bakery in Lyon: sourdough breads, pastries, online pre-orders",
    "language": "fr",
    "structure": "multipage",
    "features": ["contact_form", "map", "shop"],
    "business": { "name": "Boulangerie du Parc", "city": "Lyon", "phone": "+33 4 00 00 00 00" }
  }'

const res = await fetch('https://flixy.studio/v1/sites', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.FLIXY_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': 'order-1042',
  },
  body: JSON.stringify({
    prompt: 'Website for an artisan bakery in Lyon: sourdough breads, pastries, online pre-orders',
    language: 'fr',
    business: { name: 'Boulangerie du Parc', city: 'Lyon' },
  }),
});
const job = await res.json(); // 202 → { id: 'job_…', status: 'queued', site_id: '…' }

import os, requests

job = requests.post(
    'https://flixy.studio/v1/sites',
    headers={'Authorization': f"Bearer {os.environ['FLIXY_API_KEY']}", 'Idempotency-Key': 'order-1042'},
    json={'prompt': 'Website for an artisan bakery in Lyon: sourdough breads, pastries, online pre-orders',
          'language': 'fr', 'business': {'name': 'Boulangerie du Parc', 'city': 'Lyon'}},
    timeout=30,
).json()

function flixy(string $method, string $path, ?array $body = null): array {
    $ch = curl_init('https://flixy.studio/v1' . $path);
    curl_setopt_array($ch, [
        CURLOPT_CUSTOMREQUEST => $method,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('FLIXY_API_KEY'), 'Content-Type: application/json'],
        CURLOPT_POSTFIELDS => $body ? json_encode($body) : null,
    ]);
    return json_decode(curl_exec($ch), true);
}

$job = flixy('POST', '/sites', ['prompt' => 'Website for an artisan bakery in Lyon', 'language' => 'fr']);

Veebisaidi hankimine

Tagastab veebisaidi, selle oleku ja lehed. Lisage include=html, et saada iga lehe täielik HTML (pilte majutab Flixy). Õigus: sites:read.

{
  "id": "691589621",
  "object": "site",
  "name": "Boulangerie du Parc",
  "status": "ready",
  "language": "fr",
  "pages": ["index.html", "menu.html", "contact.html"],
  "owner": "developer",
  "html": { "index.html": "<!doctype html>…" }
}

Omaniku järgi filtreerimiseks lisage loendile owner=developer või owner=organization. Seotud organisatsiooni veebisaidid tagastavad ka dashboard_url ja editor_url, et neid Flixy Studios avada.

Veebisaidi muutmine

Rakendab tavakeeles kirjeldatud muudatuse, nagu Flixy redaktoris. Iga muudatus loob uue versiooni. Õigus: sites:write.

curl https://flixy.studio/v1/sites/691589621/edits \
  -H "Authorization: Bearer $FLIXY_API_KEY" -H "Content-Type: application/json" \
  -d '{"instruction": "Add an opening hours section: Tuesday to Saturday, 7am to 7pm"}'

Veebisaidi tõlkimine

Tõlgib veebisaidi iga lehe — navigeerimise, nupud, vormid, pildikirjeldused, pealkirja ja kirjelduse otsingumootorite jaoks — säilitades kujunduse, pildid, lingid, hinnad ja kontaktandmed. Õigus: sites:write.

Veebisisu kirjutamine

Kirjutab sisu, mis on mõeldud avaldamiseks veebisaidil või ettevõtte poolt klientidele saatmiseks. Vastab otse. Õigus: content:write.

curl https://flixy.studio/v1/content \
  -H "Authorization: Bearer $FLIXY_API_KEY" -H "Content-Type: application/json" \
  -d '{
    "type": "product_description",
    "language": "it",
    "topic": "Pizza Margherita cooked in a wood-fired oven",
    "facts": "San Marzano tomatoes, fior di latte mozzarella, fresh basil, 48-hour dough",
    "length": "short"
  }'

{
  "id": "job_af25ef1e01c5dbb8e400",
  "object": "content",
  "type": "product_description",
  "language": "it",
  "title": "Pizza Margherita al forno a legna",
  "html": "<p>…</p>",
  "text": "…",
  "meta": { "title": "…", "description": "…" },
  "items": [],
  "ai_generated": true,
  "usage": { "price": 0.01, "currency": "EUR", "mode": "live" }
}

Väli html sisaldab ainult turvalisi tekstisilte (pealkirjad, lõigud, loendid, lingid), mitte kunagi skripte ega stiile.

Dokumendi lugemine

Loeb menüü, kataloogi, hinnakirja, visiitkaardi, flaieri või brošüüri ja tagastab veebisaidi jaoks valmis struktureeritud sisu. Tagastatakse ainult see, mis on tegelikult kirjas. Õigus: extract:write.

{
  "object": "extract",
  "kind": "menu",
  "business": { "name": "Trattoria Sole", "phone": "…", "hours": "…" },
  "language": "es",
  "sections": [
    { "title": "Pizzas", "items": [ { "name": "Margherita", "description": "…", "price": "11.50" } ] }
  ],
  "colors": ["#b5121b"],
  "usage": { "price": 0.03, "currency": "EUR", "mode": "live" }
}

Pildi loomine

Loob veebisaidi jaoks foto, illustratsiooni või logo. Pilti majutab Flixy ja failis on AI loodud meedia standardne IPTC-märgistus. Õigus: images:write.

Saldo ja konto

Tagastab teie saldo, käimasolevate tööde jaoks broneeritud summa, kasutatava summa, teie kuised kulud ja kasutatava võtme. Õigus: account:read.

{
  "object": "account",
  "balance": 48.92,
  "available": 45.92,
  "reserved": 3.00,
  "currency": "EUR",
  "spent_this_month": 12.40,
  "key": { "name": "Production server", "mode": "live", "scopes": ["sites:write", "sites:read"] },
  "limits": { "requests_per_minute": 60, "concurrent_site_jobs": 3 }
}

Kasutus ja hinnad

/v1/usage tagastab teie päringud ja summad toimingute kaupa valitud perioodil. /v1/pricing tagastab praegused tüüpilised ja miinimumhinnad teie valuutas.

Iga õnnestunud päring maksab selleks vajalikud tegelikud AI-töö kulud, korrutatuna Flixy marginaaliga, miinimumhinnaga toimingu kohta. Enne veebisaidi töö algust broneeritakse teie saldolt hinnanguline summa; täpne hind arvatakse maha lõpus ja ülejäänu vabastatakse. Ebaõnnestunud ja tagasi lükatud päringute eest ei võeta kunagi tasu.

Webhookid

Lisage oma arendajaalas oma serveri https-aadress ja valige sündmused: job.succeeded, job.failed, balance.low, topup.succeeded. Flixy saadab JSON-sündmusega POST-päringu; vastake 10 sekundi jooksul 2xx-olekuga. Ebaõnnestunud saatmisi korratakse; pidevalt ebaõnnestuv aadress peatatakse.

POST /your/webhook
Flixy-Signature: t=1762854395,v1=8f0c3b…

{
  "id": "evt_2b0a…",
  "object": "event",
  "type": "job.succeeded",
  "created_at": "2026-11-11T09:46:35Z",
  "data": { "id": "job_6902…", "type": "site", "status": "succeeded", "site_id": "691589621", "price": 0.72 }
}

Allkirja kontrollimine

Päis Flixy-Signature sisaldab ajatemplit t ja väärtust v1, mis on HMAC-SHA256 väärtusest t + "." + raw body teie webhooki saladusega. Lükake tagasi sõnumid, mis on vanemad kui 5 minutit.

import crypto from 'node:crypto';

export function verifyFlixy(rawBody, header, secret) {
  const p = Object.fromEntries(header.split(',').map((x) => x.split('=')));
  const sig = crypto.createHmac('sha256', secret).update(`${p.t}.${rawBody}`).digest('hex');
  return Math.abs(Date.now() / 1000 - Number(p.t)) < 300
    && crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(p.v1));
}

import hmac, hashlib, time

def verify_flixy(raw_body: bytes, header: str, secret: str) -> bool:
    p = dict(x.split('=', 1) for x in header.split(','))
    sig = hmac.new(secret.encode(), f"{p['t']}.".encode() + raw_body, hashlib.sha256).hexdigest()
    return abs(time.time() - int(p['t'])) < 300 and hmac.compare_digest(sig, p['v1'])

function flixy_verify(string $raw, string $header, string $secret): bool {
    parse_str(str_replace(',', '&', $header), $p);
    $sig = hash_hmac('sha256', $p['t'] . '.' . $raw, $secret);
    return abs(time() - (int)$p['t']) < 300 && hash_equals($sig, (string)$p['v1']);
}

Arveldamine

• Täiendage saldot alates 10 € oma arendajaalas kaardiga. Käibemaks lisatakse vastavalt teie riigile; iga täienduse kohta saadetakse arve.
• Lülitage sisse automaatne täiendamine, et laadida valitud summa, kui teie saldo langeb alla künnise.
• Määrake kontole kuine kulude ülempiir ja igale võtmele päevane ülempiir.
• Kui teie saldo hakkab otsa saama, saate e-kirja ja webhooki balance.low.

Täielikud tingimused: Flixy API tingimused ja kasutuspõhimõtted.

Turvalisuse kontrollnimekiri

• Hoidke võtmeid oma serveris, keskkonnamuutujates või saladuste halduris — mitte kunagi veebilehel, mobiilirakenduses ega koodirepositooriumis.
• Looge iga rakenduse jaoks üks võti ja andke sellele ainult vajalikud õigused.
• Piirake live-võtmed oma serverite IP-aadressidega ja määrake päevane ülempiir.
• Kontrollige iga webhooki allkirja ja ajatemplit.
• Kasutage iga POST-päringu jaoks idempotentsusvõtit.
• Kustutage võti kohe, kui see võib olla lekkinud, ja looge seejärel uus.
• Vaadake AI loodud sisu enne avaldamist üle ja teavitage oma kasutajaid, kui sisu on AI loodud, kui seadus seda nõuab.

Kasutuspõhimõtted

Flixy API on loodud veebisaitide ja nende sisu jaoks. See lükkab tasuta tagasi veebisaitidega mitteseotud üldised küsimused, koodi muu tarkvara jaoks, katsed muuta Flixy juhiseid ja meie põhimõtteid rikkuva sisu (ebaseaduslik, vihkav, alaealisi hõlmav seksuaalne sisu, õngitsus- või kellekski teiseks esinemise lehed, rämpspost, võltsarvustused). Lugege täielikke API tingimusi ja kasutuspõhimõtteid.

Seotud organisatsioon

Siduge oma Flixy Studio organisatsioon konsoolist (Organisatsioon). Flixy Studio konto omanik kinnitab sidumise Flixy Studiosse sisse logituna ja kumbki pool saab selle igal ajal eemaldada. Pärast sidumist:

• API saab organisatsiooni veebisaite loetleda, lugeda, muuta ja tõlkida (sites:read, sites:write);
• saate luua veebisaidi otse organisatsiooni parameetriga "destination": "organization" või teisaldada API loodud veebisaidi päringuga POST /v1/sites/{id}/transfer (tasuta), et see Flixy Studiost domeenil avaldada;
• kogu API töö arveldatakse teie API saldost: organisatsiooni krediiti ei kasutata kunagi.

curl "https://flixy.studio/v1/sites?owner=organization" \
  -H "Authorization: Bearer $FLIXY_API_KEY"

curl -X POST https://flixy.studio/v1/sites/691589621/transfer \
  -H "Authorization: Bearer $FLIXY_API_KEY"

{
  "id": "691589621",
  "object": "site",
  "owner": "organization",
  "dashboard_url": "https://flixy.studio/app/?v=sites",
  "editor_url": "https://flixy.studio/691589621"
}

Ilma seotud organisatsioonita tagastavad need päringud 409 organization_not_linked.

Muudatuste logi

• v1 — november 2026. Esimene versioon: veebisaidid, muudatused, tõlked, sisu, dokumentide lugemine, pildid, tööd, webhookid, ettemakstud saldo.

Muudatustest, mis võivad teie integratsiooni rikkuda, teatatakse e-postiga vähemalt 90 päeva ette.