API dokumentācija

Ievads

Flixy API ļauj jūsu programmatūrai izmantot Flixy Studio funkcijas: veidot pilnas vietnes pēc apraksta, tās rediģēt un tulkot, rakstīt vietņu saturu, nolasīt ēdienkartes, katalogus un PDF failus, kā arī veidot attēlus un logotipus. Jūs maksājat tikai par veiksmīgiem izsaukumiem no priekšapmaksas atlikuma.

Ilgi uzdevumi (vietnes izveide, rediģēšana vai tulkošana) tiek izpildīti kā uzdevumi: API atbild uzreiz, un jūs sekojat uzdevumam vai saņemat webhook. Saturs, dokumentu nolasīšana un attēli atbild tieši, parasti dažu sekunžu laikā.

Izstrādātāju konsole

Atslēgas, atlikums, papildinājumi, webhooks un izsaukumu žurnāli tiek pārvaldīti izstrādātāju konsolē vietnē dev.flixy.studio.

• Atsevišķs izstrādātāja konts. Tāpat kā citās AI platformās, jūsu izstrādātāja konts ir nošķirts no jūsu Flixy Studio konta: tam ir sava reģistrācija, pierakstīšanās un sesija. Izrakstīšanās no viena nekad neizraksta jūs no otra. Abiem varat izmantot vienu un to pašu e-pasta adresi.
• Piesaistītā organizācija. Ja izmantojat arī Flixy Studio, varat piesaistīt savu organizāciju savam izstrādātāja kontam, lai API varētu strādāt ar tās vietnēm. Skatiet Piesaistītā organizācija.
• Konta drošība. Divpakāpju verifikācija, aktīvās sesijas un datu eksports ir pieejami konsolē, sadaļā Konts.

Autentifikācija

Nosūtiet savu atslēgu katra pieprasījuma galvenē Authorization. Atslēgas sākas ar fx_live_ vai fx_test_.

Authorization: Bearer fx_live_8sJ2…

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

Katrai atslēgai ir tiesības (scopes). Izsaukums bez atbilstošām tiesībām atgriež 403 missing_scope.

Testa un live atslēgas

• Testa atslēgas (fx_test_…) ir bezmaksas. Tās atgriež reālistiskas paraugatbildes, neizmantojot AI, tāpēc varat izveidot un pārbaudīt visu integrāciju. Vietņu uzdevumi tiek pabeigti pēc dažām sekundēm ar parauga vietni.
• Live atslēgas (fx_live_…) atgriež reālus rezultātus, un par tām tiek iekasēts no jūsu atlikuma.

Katrā atbildē ir galvene Flixy-Mode: test vai Flixy-Mode: live.

Pieprasījumi un atbildes

Sūtiet JSON pamattekstus ar Content-Type: application/json (ne vairāk kā 16 MB). Atbildes ir JSON formātā. Datumi tiek norādīti ISO 8601 formātā UTC laikā. Katrai atbildei ir galvene X-Request-Id: norādiet to mūsu atbalsta dienestam, ja jums nepieciešama palīdzība saistībā ar izsaukumu.

Iestatiet Accept-Language, lai saņemtu kļūdu ziņojumus savā valodā (fr, en, es, de, it, pt, nl, ca, el, sv, no, da, fi, is, et, lv, lt, ja; pēc noklusējuma angļu).

Kļūdas

Kļūdām tiek izmantoti standarta HTTP statusa kodi, un tām vienmēr ir vienāda forma:

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

Pieprasījumu limiti

• 60 pieprasījumi minūtē vienai atslēgai (galvene X-RateLimit-Limit).
• 3 vietņu uzdevumi vienlaikus vienam kontam. Satura, dokumentu un attēlu izsaukumiem šis limits netiek piemērots.
• Kad limits ir sasniegts, API atbild ar 429 un galveni Retry-After sekundēs.

Nepieciešams vairāk? Rakstiet uz contact@flixy.studio, aprakstot savu lietošanas gadījumu.

Idempotence

Tīkla kļūdas gadās. Pievienojiet galveni Idempotency-Key (no 8 līdz 100 rakstzīmēm, piemēram, savu pasūtījuma ID) jebkuram POST: ja 24 stundu laikā atkārtoti nosūtāt to pašu pieprasījumu, API atgriež pirmo atbildi — ar galveni Idempotent-Replayed: true — un nekad neizpilda un neiekasē darbu divreiz.

Uzdevumi

Vietnes izveide, rediģēšana un tulkošana aizņem no aptuveni 30 sekundēm līdz 3 minūtēm. Šie galapunkti atbild ar 202 Accepted un uzdevumu. Pārbaudiet to ik pēc 5 sekundēm vai gaidiet notikumu job.succeeded / job.failed ar webhook.

{
  "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 ir queued, running, succeeded vai failed. Par neizdevušos uzdevumu nekad netiek iekasēts, un tā error paskaidro iemeslu.

Izveidot vietni

Izveido pilnu vietni pēc apraksta. Tiesības: 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']);

Iegūt vietni

Atgriež vietni, tās statusu un lapas. Pievienojiet include=html, lai saņemtu katras lapas pilnu HTML (attēlus mitina Flixy). Tiesības: 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>…" }
}

Pievienojiet sarakstam owner=developer vai owner=organization, lai filtrētu pēc īpašnieka. Piesaistītas organizācijas vietnes atgriež arī dashboard_url un editor_url, lai tās atvērtu Flixy Studio.

Rediģēt vietni

Veic vienkāršā valodā aprakstītas izmaiņas, kā Flixy redaktorā. Katras izmaiņas izveido jaunu versiju. Tiesības: 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"}'

Tulkot vietni

Iztulko katru vietnes lapu — navigāciju, pogas, veidlapas, attēlu aprakstus, virsrakstu un aprakstu meklētājprogrammām —, saglabājot dizainu, attēlus, saites, cenas un kontaktinformāciju. Tiesības: sites:write.

Rakstīt tīmekļa saturu

Raksta saturu, kas paredzēts publicēšanai vietnē vai ko uzņēmums sūta saviem klientiem. Atbild tieši. Tiesības: 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" }
}

Laukā html ir tikai droši teksta tagi (virsraksti, rindkopas, saraksti, saites), nekad skripti vai stili.

Nolasīt dokumentu

Nolasa ēdienkarti, katalogu, cenrādi, vizītkarti, skrejlapu vai brošūru un atgriež strukturētu saturu, kas gatavs vietnei. Tiek atgriezts tikai tas, kas patiešām ir uzrakstīts. Tiesības: 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" }
}

Izveidot attēlu

Izveido fotoattēlu, ilustrāciju vai logotipu vietnei. Attēlu mitina Flixy, un failā ir standarta IPTC marķējums AI ģenerētiem multivides materiāliem. Tiesības: images:write.

Atlikums un konts

Atgriež jūsu atlikumu, notiekošajiem uzdevumiem rezervēto summu, pieejamo summu, mēneša izdevumus un izmantoto atslēgu. Tiesības: 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 }
}

Lietojums un cenas

/v1/usage atgriež jūsu izsaukumus un summas pa darbībām noteiktā periodā. /v1/pricing atgriež pašreizējās tipiskās un minimālās cenas jūsu valūtā.

Katrs veiksmīgs izsaukums maksā tam nepieciešamā AI darba patiesās izmaksas, kas reizinātas ar Flixy uzcenojumu, ar minimālo cenu par darbību. Pirms vietnes uzdevuma sākuma jūsu atlikumā tiek rezervēta aplēstā summa; precīzā cena tiek iekasēta beigās, un atlikusī daļa tiek atbrīvota. Neizdevušies un noraidīti izsaukumi nekad netiek iekasēti.

Webhook

Savā izstrādātāja zonā pievienojiet sava servera https adresi un izvēlieties notikumus: job.succeeded, job.failed, balance.low, topup.succeeded. Flixy nosūta POST ar JSON notikumu; atbildiet ar 2xx statusu 10 sekunžu laikā. Neizdevušās piegādes tiek atkārtotas; adrese, kas turpina kļūdīties, tiek apturēta.

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 }
}

Pārbaudiet parakstu

Galvenē Flixy-Signature ir laikspiedols t un v1 — t + "." + raw body HMAC-SHA256, kas aprēķināts ar jūsu webhook noslēpumu. Noraidiet ziņojumus, kas vecāki par 5 minūtēm.

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']);
}

Rēķini

• Papildiniet savu atlikumu no 10 € savā izstrādātāja zonā ar karti. PVN tiek pievienots atbilstoši jūsu valstij; par katru papildinājumu tiek nosūtīts rēķins.
• Ieslēdziet automātisko papildināšanu, lai papildinātu izvēlētu summu, kad jūsu atlikums nokrītas zem sliekšņa.
• Iestatiet mēneša izdevumu limitu kontam un dienas limitu katrai atslēgai.
• Kad jūsu atlikums kļūst mazs, jūs saņemat e-pastu un balance.low webhook.

Pilni noteikumi: Flixy API noteikumi un lietošanas politika.

Drošības kontrolsaraksts

• Glabājiet atslēgas savā serverī, vides mainīgajos vai noslēpumu pārvaldniekā — nekad ne tīmekļa lapā, mobilajā lietotnē vai koda repozitorijā.
• Izveidojiet vienu atslēgu katrai lietojumprogrammai un piešķiriet tai tikai nepieciešamās tiesības.
• Ierobežojiet live atslēgas ar savu serveru IP adresēm un iestatiet dienas limitu.
• Pārbaudiet katra webhook parakstu un laikspiedolu.
• Izmantojiet idempotences atslēgu katram POST.
• Nekavējoties izdzēsiet atslēgu, ja tā varētu būt nopludināta, un pēc tam izveidojiet jaunu.
• Pārskatiet AI ģenerētu saturu pirms tā publicēšanas un informējiet savus lietotājus, ka saturs ir ģenerēts ar AI, ja to pieprasa likums.

Lietošanas politika

Flixy API ir paredzēta vietnēm un to saturam. Tā bez maksas noraida ar vietnēm nesaistītus vispārīgus jautājumus, kodu citai programmatūrai, mēģinājumus mainīt Flixy instrukcijas un saturu, kas pārkāpj mūsu politiku (nelikumīgu, naidīgu, seksuāla rakstura saturu ar nepilngadīgajiem, pikšķerēšanas vai uzdošanās lapas, surogātpastu, viltotas atsauksmes). Izlasiet pilnos API noteikumus un lietošanas politiku.

Piesaistītā organizācija

Piesaistiet savu Flixy Studio organizāciju konsolē (Organizācija). Flixy Studio konta īpašnieks apstiprina piesaisti, esot pierakstījies Flixy Studio, un jebkura no pusēm to var jebkurā laikā noņemt. Pēc piesaistes:

• API var uzskaitīt, lasīt, rediģēt un tulkot organizācijas vietnes (sites:read, sites:write);
• varat izveidot vietni tieši organizācijā ar "destination": "organization" vai pārvietot API izveidotu vietni ar POST /v1/sites/{id}/transfer (bez maksas), lai to publicētu domēnā no Flixy Studio;
• viss API darbs tiek iekasēts no jūsu API atlikuma: organizācijas kredīti nekad netiek izmantoti.

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"
}

Bez piesaistītas organizācijas šie izsaukumi atgriež 409 organization_not_linked.

Izmaiņu žurnāls

• v1 — 2026. gada novembris. Pirmā versija: vietnes, izmaiņas, tulkojumi, saturs, dokumentu nolasīšana, attēli, uzdevumi, webhook, priekšapmaksas atlikums.

Par izmaiņām, kas var traucēt jūsu integrāciju, tiek paziņots pa e-pastu vismaz 90 dienas iepriekš.