Allt du behöver för att lägga till Flixys AI i din produkt. Bas-URL: https://flixy.studio/v1
REST · JSONBearer-nycklarAsynkrona jobbSignerade webhooks18 språk
Introduktion
Med Flixy API kan din programvara använda Flixy Studios funktioner: skapa kompletta webbplatser utifrån en beskrivning, redigera och översätta dem, skriva webbplatsinnehåll, läsa menyer, kataloger och PDF-filer samt skapa bilder och logotyper. Du betalar bara för lyckade anrop, från ett förbetalt saldo.
Långa uppgifter (skapa, redigera eller översätta en webbplats) körs som jobb: API:et svarar direkt och du följer jobbet eller tar emot en webhook. Innehåll, dokumentläsning och bilder svarar direkt, vanligtvis inom några sekunder.
Börja i ditt utvecklarutrymme: en kostnadsfri testnyckel skapas så snart du öppnar det.
Utvecklarkonsol
Nycklar, saldo, påfyllningar, webhooks och anropsloggar hanteras i utvecklarkonsolen på dev.flixy.studio.
Ett separat utvecklarkonto. Precis som på andra AI-plattformar är ditt utvecklarkonto skilt från ditt Flixy Studio-konto: det har egen registrering, inloggning och session. Att logga ut från det ena loggar aldrig ut dig från det andra. Du kan använda samma e-postadress för båda.
Länkad organisation. Om du också använder Flixy Studio kan du länka din organisation till ditt utvecklarkonto, så att API:et kan arbeta med dess webbplatser. Se Länkad organisation.
Kontosäkerhet. Tvåstegsverifiering, aktiva sessioner och dataexport finns i konsolen under Konto.
Autentisering
Skicka din nyckel i headern Authorization i varje förfrågan. Nycklar börjar med fx_live_ eller fx_test_.
Din nyckel är hemlig. Anropa API:et endast från din server: förfrågningar som skickas från en webbläsare nekas, så att en nyckel aldrig hamnar på en webbsida eller i en mobilapp.
Varje nyckel har rättigheter (scopes). Ett anrop utan rätt scope returnerar 403 missing_scope.
Parameter
Typ
Beskrivning
sites:read
scope
Läsa webbplatser och deras HTML.
sites:write
scope
Skapa, redigera och översätta webbplatser.
content:write
scope
Skriva webbplatsinnehåll.
extract:write
scope
Läsa bilder och PDF-dokument.
images:write
scope
Skapa bilder och logotyper.
account:read
scope
Läsa saldo och användning.
Test- och livenycklar
Testnycklar (fx_test_…) är kostnadsfria. De returnerar realistiska exempelsvar utan att använda AI, så att du kan bygga och testa hela din integration. Webbplatsjobb slutförs efter några sekunder med en exempelwebbplats.
Livenycklar (fx_live_…) returnerar verkliga resultat och debiteras från ditt saldo.
Varje svar innehåller headern Flixy-Mode: test eller Flixy-Mode: live.
Förfrågningar och svar
Skicka JSON-kroppar med Content-Type: application/json (högst 16 MB). Svaren är i JSON. Datum anges enligt ISO 8601 i UTC. Varje svar har en X-Request-Id-header: ge den till vår support om du behöver hjälp med ett anrop.
Ange Accept-Language för att få felmeddelanden på ditt språk (fr, en, es, de, it, pt, nl, ca, el, sv, no, da, fi, is, et, lv, lt, ja; engelska som standard).
Fel
Fel använder vanliga HTTP-statuskoder och har alltid samma form:
{
"error": {
"type": "billing_error",
"code": "insufficient_balance",
"message": "Insufficient balance: top up your developer account…",
"request_id": "req_5c1f0a9e2b7d4c11"
}
}
Status
Typ
Betydelse
400
invalid_request_error
Ogiltig JSON eller header.
401
authentication_error
Saknad, ogiltig eller raderad nyckel.
402
billing_error
Otillräckligt saldo, månadstak eller nyckelns dagstak har nåtts.
403
permission_error
Saknad scope, IP-adress inte tillåten, kontot avstängt eller anrop från en webbläsare.
404
not_found_error
Okänd webbplats, okänt jobb eller okänd endpoint.
409
conflict_error
Ett jobb körs redan på den här webbplatsen.
422
invalid_request_error
Ogiltig parameter, eller förfrågan nekad av användningspolicyn (off_topic, content_policy). Debiteras inte.
429
rate_limit_error
För många förfrågningar eller samtidiga jobb. Vänta den tid som anges i Retry-After.
5xx
api_error
Tillfälligt problem hos oss. Försök igen med samma idempotensnyckel. Debiteras inte.
Anropsgränser
60 förfrågningar per minut per nyckel (headern X-RateLimit-Limit).
3 webbplatsjobb samtidigt per konto. Anrop för innehåll, dokument och bilder omfattas inte av denna gräns.
När en gräns nås svarar API:et 429 med en Retry-After-header i sekunder.
Behöver du mer? Skriv till contact@flixy.studio och beskriv ditt användningsfall.
Idempotens
Nätverksfel förekommer. Lägg till en Idempotency-Key-header (8 till 100 tecken, till exempel ditt eget order-ID) i varje POST: om du skickar samma förfrågan igen inom 24 timmar returnerar API:et det första svaret — med headern Idempotent-Replayed: true — och kör eller debiterar aldrig arbetet två gånger.
Jobb
Att skapa, redigera och översätta en webbplats tar från cirka 30 sekunder till 3 minuter. Dessa endpoints svarar 202 Accepted med ett jobb. Följ det var 5:e sekund eller vänta på händelsen job.succeeded / job.failed via webhook.
Returnerar webbplatsen, dess status och dess sidor. Lägg till include=html för att få den fullständiga HTML-koden för varje sida (bilderna lagras hos Flixy). Scope: sites:read.
Lägg till owner=developer eller owner=organization i listan för att filtrera efter ägare. Webbplatser i en länkad organisation returnerar också dashboard_url och editor_url, för att öppna dem i Flixy Studio.
Redigera en webbplats
POST/v1/sites/{id}/edits
Genomför en ändring som beskrivs på vanligt språk, som i Flixy-redigeraren. Varje ändring skapar en ny version. Scope: sites:write.
Parameter
Typ
Beskrivning
instructionobligatorisk
string
Ändringen som ska göras (4 till 3000 tecken), t.ex. ”Lägg till en prissida med tre erbjudanden” eller ”Använd ett mörkgrönt tema”.
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"}'
Översätt en webbplats
POST/v1/sites/{id}/translations
Översätter varje sida på webbplatsen — navigering, knappar, formulär, bildbeskrivningar, titel och beskrivning för sökmotorer — och behåller designen, bilderna, länkarna, priserna och kontaktuppgifterna. Scope: sites:write.
Parameter
Typ
Beskrivning
languageobligatorisk
string
Målspråk: fr, en, es, de, it, pt, nl, ca, el, sv, no, da, fi, is, et, lv, lt, ja.
Skriv webbinnehåll
POST/v1/content
Skriver innehåll avsett att publiceras på en webbplats eller skickas av ett företag till dess kunder. Svarar direkt. Scope: content:write.
Fältet html innehåller endast säkra texttaggar (rubriker, stycken, listor, länkar), aldrig skript eller stilar.
Läs ett dokument
POST/v1/extract
Läser en meny, en katalog, en prislista, ett visitkort, ett flygblad eller en broschyr och returnerar strukturerat innehåll redo för en webbplats. Endast det som faktiskt står skrivet returneras. Scope: extract:write.
Parameter
Typ
Beskrivning
file
string
Filen kodad i base64 (JPEG, PNG, WebP, GIF eller PDF, högst 10 MB).
url
string
Eller en offentlig https-adress till filen.
kind
string
auto (standard), menu, catalog, business_card, brochure, price_list, flyer.
Skannade PDF-filer utan text kan inte läsas: skicka i stället en bild av varje sida.
Skapa en bild
POST/v1/images
Skapar ett foto, en illustration eller en logotyp för en webbplats. Bilden lagras hos Flixy och bär inuti filen den standardiserade IPTC-märkningen för AI-genererade medier. Scope: images:write.
Parameter
Typ
Beskrivning
promptobligatorisk
string
Beskrivning av bilden (4 till 800 tecken).
kind
string
photo (standard), illustration eller logo.
aspect
string
16:9 (standard), 1:1, 4:3, 3:4, 9:16.
business
string
Företagets sammanhang, för att matcha stilen.
brand
string
Varumärkesnamn för en logotyp.
Saldo och konto
GET/v1/account
Returnerar ditt saldo, beloppet som reserverats för pågående jobb, det tillgängliga beloppet, dina månatliga utgifter och den nyckel som används. Scope: account:read.
/v1/usage returnerar dina anrop och belopp per åtgärd under en period. /v1/pricing returnerar aktuella typiska priser och minimipriser i din valuta.
Varje lyckat anrop kostar den verkliga kostnaden för det AI-arbete som krävdes multiplicerad med Flixys marginal, med ett minimum per åtgärd. Innan ett webbplatsjobb startar reserveras ett uppskattat belopp på ditt saldo; det exakta priset debiteras i slutet och resten frigörs. Misslyckade och nekade anrop debiteras aldrig.
Webhooks
Lägg till en https-adress till din server i ditt utvecklarutrymme och välj händelser: job.succeeded, job.failed, balance.low, topup.succeeded. Flixy skickar en POST med en JSON-händelse; svara med en 2xx-status inom 10 sekunder. Misslyckade leveranser görs om; en adress som fortsätter att misslyckas pausas.
Headern Flixy-Signature innehåller en tidsstämpel t och v1, HMAC-SHA256 av t + "." + raw body med din webhook-hemlighet. Avvisa meddelanden som är äldre än 5 minuter.
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'])
Förvara nycklar på din server, i miljövariabler eller en hemlighetshanterare — aldrig på en webbsida, i en mobilapp eller i ett kodförråd.
Skapa en nyckel per applikation och ge den endast de scopes den behöver.
Begränsa livenycklar till dina servrars IP-adresser och ställ in ett dagstak.
Verifiera varje webhooks signatur och tidsstämpel.
Använd en idempotensnyckel för varje POST.
Radera en nyckel omedelbart om den kan ha exponerats och skapa sedan en ny.
Granska AI-genererat innehåll innan du publicerar det, och informera dina användare när innehåll är AI-genererat om lagen kräver det.
Användningspolicy
Flixy API är gjort för webbplatser och deras innehåll. Det nekar, utan debitering, allmänna frågor som inte rör webbplatser, kod för annan programvara, försök att ändra Flixys instruktioner och innehåll som bryter mot vår policy (olagligt, hatiskt, sexuellt innehåll som involverar minderåriga, nätfiske- eller identitetsstöldsidor, spam, falska recensioner). Läs hela API-villkoren och användningspolicyn.
Länkad organisation
POST/v1/sites/{id}/transfer
Länka din Flixy Studio-organisation från konsolen (Organisation). Ägaren till Flixy Studio-kontot godkänner länken när hen är inloggad i Flixy Studio, och båda parter kan ta bort den när som helst. När den är länkad:
API:et kan lista, läsa, redigera och översätta organisationens webbplatser (sites:read, sites:write);
du kan skapa en webbplats direkt i organisationen med "destination": "organization", eller flytta en webbplats som skapats via API:et med POST /v1/sites/{id}/transfer (kostnadsfritt), för att publicera den på en domän från Flixy Studio;
allt API-arbete debiteras ditt API-saldo: organisationens krediter används aldrig.
Utan en länkad organisation returnerar dessa anrop 409 organization_not_linked.
Ändringslogg
v1 — november 2026. Första versionen: webbplatser, ändringar, översättningar, innehåll, dokumentläsning, bilder, jobb, webhooks, förbetalt saldo.
Ändringar som kan bryta din integration meddelas via e-post minst 90 dagar i förväg.
Vi respekterar din integritet. Flixy Studio använder endast strikt nödvändiga cookies (inloggning, säkerhet, språk). Vår besöksstatistik är anonym och använder inga cookies. Cookiepolicy