API-skjölun

Inngangur

Flixy API gerir hugbúnaðinum þínum kleift að nota eiginleika Flixy Studio: búa til fullbúna vefi út frá lýsingu, breyta þeim og þýða, skrifa efni fyrir vefi, lesa matseðla, vörulista og PDF-skjöl og búa til myndir og lógó. Þú greiðir aðeins fyrir vel heppnuð köll, af fyrirframgreiddri inneign.

Löng verkefni (að búa til, breyta eða þýða vef) keyra sem verk: API-ið svarar strax og þú fylgist með verkinu eða færð webhook. Efni, lestur skjala og myndir svara beint, yfirleitt á nokkrum sekúndum.

Forritarastjórnborð

Lyklum, inneign, áfyllingum, webhooks og kallaskrám er stjórnað í forritarastjórnborðinu á dev.flixy.studio.

• Sérstakur forritarareikningur. Eins og á öðrum gervigreindarverkvöngum er forritarareikningurinn þinn aðskilinn frá Flixy Studio-reikningnum þínum: hann hefur eigin nýskráningu, innskráningu og lotu. Ef þú skráir þig út úr öðrum skráist þú aldrei út úr hinum. Þú getur notað sama netfang fyrir báða.
• Tengd skipulagsheild. Ef þú notar líka Flixy Studio geturðu tengt skipulagsheildina þína við forritarareikninginn þinn svo API-ið geti unnið með vefi hennar. Sjá Tengd skipulagsheild.
• Öryggi reiknings. Tveggja þrepa staðfesting, virkar lotur og gagnaútflutningur eru í boði í stjórnborðinu, undir Reikningur.

Auðkenning

Sendu lykilinn þinn í hausnum Authorization í hverri beiðni. Lyklar byrja á fx_live_ eða fx_test_.

Authorization: Bearer fx_live_8sJ2…

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

Hver lykill hefur heimildir (scopes). Kall án réttrar heimildar skilar 403 missing_scope.

Prófunar- og raunlyklar

• Prófunarlyklar (fx_test_…) eru ókeypis. Þeir skila raunhæfum dæmum um svör án þess að nota gervigreind, svo þú getur smíðað og prófað alla samþættinguna. Vefverkum lýkur eftir nokkrar sekúndur með dæmivef.
• Raunlyklar (fx_live_…) skila raunverulegum niðurstöðum og eru rukkaðir af inneigninni þinni.

Hvert svar inniheldur hausinn Flixy-Mode: test eða Flixy-Mode: live.

Beiðnir og svör

Sendu JSON-meginmál með Content-Type: application/json (16 MB að hámarki). Svör eru á JSON-sniði. Dagsetningar nota ISO 8601 í UTC. Hvert svar er með hausinn X-Request-Id: gefðu þjónustuverinu okkar hann ef þú þarft aðstoð vegna kalls.

Stilltu Accept-Language til að fá villuboð á þínu tungumáli (fr, en, es, de, it, pt, nl, ca, el, sv, no, da, fi, is, et, lv, lt, ja; enska sjálfgefið).

Villur

Villur nota stöðluð HTTP-stöðukóða og hafa alltaf sama form:

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

Hraðatakmörk

• 60 beiðnir á mínútu á hvern lykil (haus X-RateLimit-Limit).
• 3 vefverk samtímis á hvern aðgang. Köll fyrir efni, skjöl og myndir falla ekki undir þetta takmark.
• Þegar takmarki er náð svarar API-ið 429 með hausnum Retry-After í sekúndum.

Þarftu meira? Skrifaðu á contact@flixy.studio og lýstu notkunartilvikinu þínu.

Örugg endurtekning (idempotency)

Netvillur gerast. Bættu hausnum Idempotency-Key (8 til 100 stafir, til dæmis þitt eigið pöntunarnúmer) við hvaða POST sem er: ef þú sendir sömu beiðni aftur innan 24 klukkustunda skilar API-ið fyrsta svarinu — með hausnum Idempotent-Replayed: true — og framkvæmir aldrei né rukkar verkið tvisvar.

Verk

Að búa til, breyta og þýða vef tekur frá um 30 sekúndum upp í 3 mínútur. Þessir endapunktar svara 202 Accepted með verki. Fylgstu með því á 5 sekúndna fresti eða bíddu eftir atburðinum job.succeeded / job.failed í gegnum 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 er queued, running, succeeded eða failed. Verk sem mistekst er aldrei rukkað og error þess útskýrir ástæðuna.

Búa til vef

Býr til fullbúinn vef út frá lýsingu. Heimild: 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']);

Sækja vef

Skilar vefnum, stöðu hans og síðum hans. Bættu við include=html til að fá allt HTML hverrar síðu (Flixy hýsir myndirnar). Heimild: 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>…" }
}

Bættu owner=developer eða owner=organization við listann til að sía eftir eiganda. Vefir tengdrar skipulagsheildar skila einnig dashboard_url og editor_url, til að opna þá í Flixy Studio.

Breyta vef

Framkvæmir breytingu sem lýst er á venjulegu máli, eins og í Flixy-ritlinum. Hver breyting býr til nýja útgáfu. Heimild: 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"}'

Þýða vef

Þýðir hverja síðu vefsins — leiðsögn, hnappa, eyðublöð, myndalýsingar, titil og lýsingu fyrir leitarvélar — og heldur hönnun, myndum, tenglum, verðum og samskiptaupplýsingum. Heimild: sites:write.

Skrifa vefefni

Skrifar efni sem ætlað er til birtingar á vef eða til sendingar frá fyrirtæki til viðskiptavina þess. Svarar beint. Heimild: 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" }
}

Reiturinn html inniheldur aðeins örugg textamerki (fyrirsagnir, málsgreinar, lista, tengla), aldrei skriftur eða stíla.

Lesa skjal

Les matseðil, vörulista, verðskrá, nafnspjald, dreifimiða eða bækling og skilar skipulögðu efni tilbúnu fyrir vef. Aðeins það sem raunverulega stendur skrifað er skilað. Heimild: 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" }
}

Búa til mynd

Býr til ljósmynd, teikningu eða lógó fyrir vef. Flixy hýsir myndina og hún ber í skránni staðlaða IPTC-merkingu fyrir miðlunarefni búið til með gervigreind. Heimild: images:write.

Inneign og aðgangur

Skilar inneign þinni, upphæðinni sem er frátekin fyrir verk í gangi, tiltækri upphæð, mánaðarlegum útgjöldum þínum og lyklinum sem er í notkun. Heimild: 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 }
}

Notkun og verð

/v1/usage skilar köllum þínum og upphæðum eftir aðgerðum yfir tímabil. /v1/pricing skilar núgildandi dæmigerðum verðum og lágmarksverðum í þínum gjaldmiðli.

Hvert vel heppnað kall kostar raunkostnað þeirrar gervigreindarvinnu sem það krafðist, margfaldaðan með álagningu Flixy, með lágmarksverði á hverja aðgerð. Áður en vefverk hefst er áætluð upphæð tekin frá af inneigninni þinni; nákvæmt verð er dregið frá í lokin og afgangurinn losaður. Köll sem mistakast eða er hafnað eru aldrei rukkuð.

Webhooks

Bættu https-slóð netþjónsins þíns við á forritarasvæðinu þínu og veldu atburðina: job.succeeded, job.failed, balance.low, topup.succeeded. Flixy sendir POST með JSON-atburði; svaraðu með 2xx-stöðu innan 10 sekúndna. Sendingar sem mistakast eru reyndar aftur; slóð sem bregst ítrekað er sett í bið.

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

Staðfesta undirskriftina

Hausinn Flixy-Signature inniheldur tímastimpil t og v1, HMAC-SHA256 af t + "." + raw body með webhook-leyndarmálinu þínu. Hafnaðu skilaboðum sem eru eldri en 5 mínútna.

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

Reikningsfærsla

• Fylltu á inneignina frá 10 € á forritarasvæðinu þínu, með korti. VSK er bætt við eftir landi þínu; reikningur er sendur fyrir hverja áfyllingu.
• Kveiktu á sjálfvirkri áfyllingu til að fylla á valda upphæð þegar inneignin fer undir viðmiðunarmörk.
• Settu mánaðarlegt útgjaldahámark fyrir aðganginn og daglegt hámark fyrir hvern lykil.
• Þú færð tölvupóst og balance.low-webhook þegar inneignin þín er að verða lág.

Allir skilmálar: Skilmálar og notkunarstefna Flixy API.

Gátlisti um öryggi

• Geymdu lykla á netþjóninum þínum, í umhverfisbreytum eða leyndarmálastjóra — aldrei á vefsíðu, í farsímaappi eða í kóðageymslu.
• Búðu til einn lykil fyrir hvert forrit og gefðu honum aðeins þær heimildir sem hann þarf.
• Takmarkaðu raunlykla við IP-tölur netþjóna þinna og settu daglegt hámark.
• Staðfestu undirskrift og tímastimpil hvers webhooks.
• Notaðu idempotency-lykil fyrir hvert POST.
• Eyddu lykli strax ef hann gæti hafa komist í hendur annarra og búðu svo til nýjan.
• Yfirfarðu efni búið til með gervigreind áður en þú birtir það, og upplýstu notendur þína þegar efni er búið til með gervigreind, þar sem lög krefjast þess.

Notkunarstefna

Flixy API er gert fyrir vefi og efni þeirra. Það hafnar, án gjalds, almennum spurningum sem tengjast ekki vefjum, kóða fyrir annan hugbúnað, tilraunum til að breyta fyrirmælum Flixy og efni sem brýtur gegn stefnu okkar (ólöglegt efni, hatursefni, kynferðislegt efni sem varðar börn, vefveiðar eða síður sem villa á sér heimildir, ruslpóstur, falsaðar umsagnir). Lestu API-skilmálana og notkunarstefnuna í heild.

Tengd skipulagsheild

Tengdu Flixy Studio-skipulagsheildina þína úr stjórnborðinu (Skipulagsheild). Eigandi Flixy Studio-reikningsins samþykkir tenginguna á meðan hann er skráður inn í Flixy Studio og hvor aðili sem er getur fjarlægt hana hvenær sem er. Þegar tengingin er komin á:

• API-ið getur listað, lesið, breytt og þýtt vefi skipulagsheildarinnar (sites:read, sites:write);
• þú getur búið til vef beint í skipulagsheildinni með "destination": "organization", eða fært vef sem API-ið bjó til með POST /v1/sites/{id}/transfer (ókeypis), til að birta hann á léni úr Flixy Studio;
• öll vinna API-sins er gjaldfærð af API-inneigninni þinni: inneign skipulagsheildarinnar er aldrei notuð.

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

Án tengdrar skipulagsheildar skila þessi köll 409 organization_not_linked.

Breytingaskrá

• v1 — nóvember 2026. Fyrsta útgáfa: vefir, breytingar, þýðingar, efni, lestur skjala, myndir, verk, webhooks, fyrirframgreidd inneign.

Breytingar sem gætu brotið samþættinguna þína eru tilkynntar með tölvupósti að minnsta kosti 90 dögum fyrirfram.