Centre d’aide

Générer des sites par API

Créez une clé API, lancez une génération avec POST /v1/sites, interrogez le statut jusqu'à ready, puis récupérez l'URL publique et une capture.

Mis à jour 4 min de lecture
Sur cette page
  1. Avant de commencer
  2. 1. Créer une clé API
  3. 2. S'authentifier
  4. 3. Lancer une génération
  5. 4. Interroger jusqu'à « ready »
  6. 5. Modifier, annuler ou supprimer
  7. Les erreurs
  8. Essayer dans le navigateur
  9. Pour aller plus loin

L'API développeur permet à votre propre application de créer des sites FromScratch sans ouvrir le chat : vous envoyez une description (et éventuellement des fichiers de référence), FromScratch construit le site, le publie et renvoie son URL publique et une capture d'écran. C'est ainsi que des agences, des annuaires ou des outils d'automatisation génèrent des sites en série.

Avant de commencer

  • L'API développeur est incluse dans les offres Starter et Pro. Avec l'offre Gratuite, la page Développeur affiche « Le mode développeur est réservé aux offres payantes ».
  • Les générations consomment vos crédits, exactement comme dans le chat (Comment fonctionnent les crédits).
  • Les sites créés par API sont des projets normaux : vous les retrouvez sur votre page d'accueil, vous pouvez les ouvrir, discuter avec l'agent et republier.

1. Créer une clé API

  1. Ouvrez le menu utilisateur et cliquez sur Développeur. La page Mode développeur s'ouvre.
  2. Dans Clés API, saisissez un nom (« Nom de la clé (Production, Zapier…) ») et cliquez sur + Générer.
  3. Copiez la clé tout de suite : « Nouvelle clé — copiez-la maintenant, elle ne sera plus affichée ». Les clés commencent par fs_live_. FromScratch n'en garde qu'une empreinte : il ne peut pas vous la réafficher.
  4. Chaque clé indique sa dernière utilisation. Révoquer la coupe immédiatement : les applications qui l'utilisent cessent de fonctionner.

Attention

traitez une clé comme un mot de passe. Gardez-la sur votre serveur (dans une variable d'environnement), jamais dans une page web, une application mobile ou un dépôt public. En cas de fuite, révoquez-la et générez-en une nouvelle.

2. S'authentifier

Chaque requête envoie la clé dans l'en-tête Authorization. L'URL de base est https://from-scratch.app.

curl https://from-scratch.app/v1/models \
  -H "Authorization: Bearer $FS_API_KEY"

GET /v1/models liste les identifiants de modèle utilisables dans le champ model (l'un est marqué is_default).

3. Lancer une génération

POST /v1/sites attend du multipart/form-data :

Champ Obligatoire Contenu
prompt oui La description du site à construire.
name non Nom du projet (sinon dérivé du prompt).
template non Modèle de départ (défaut : auto).
folder non Un chemin de dossier comme paris/barbiers, créé s'il n'existe pas — le projet y apparaît sur votre page d'accueil.
model non Un identifiant de modèle tiré de GET /v1/models.
files non Fichiers de référence (images, PDF, données…), jusqu'à 20, 15 Mo maximum chacun. Ils sont ajoutés au projet et fournis à l'agent.
curl -X POST https://from-scratch.app/v1/sites \
  -H "Authorization: Bearer $FS_API_KEY" \
  -F prompt="Un site d'une page pour Fade Factory, un barbier à Lyon : prestations avec prix, horaires, formulaire de demande de rendez-vous" \
  -F folder="lyon/barbiers" \
  -F files=@logo.png \
  -F files=@tarifs.pdf

La réponse arrive immédiatement, avec le statut 202 et un identifiant de job :

{"id": "6f1c…", "status": "queued", "url": null, "screenshot_url": null}

4. Interroger jusqu'à « ready »

GET /v1/sites/{id} renvoie le job. Son status passe par queued → building → publishing → capturing → ready, ou se termine en error ou cancelled. Interrogez toutes les 10 à 15 secondes : une génération prend des minutes, pas des secondes.

curl https://from-scratch.app/v1/sites/6f1c… \
  -H "Authorization: Bearer $FS_API_KEY"

À ready, le job contient :

  • url — l'adresse publique du site publié ;
  • screenshot_url — une capture PNG (au mieux : elle peut valoir null si la capture n'a pas été possible) ;
  • project_id, folder, error (en cas d'échec) et cost (jetons utilisés, crédits débités).

GET /v1/sites/{id}/screenshot renvoie directement l'image PNG.

Note

les générations par API se font d'une traite : il n'y a pas de plan étape par étape à valider, et le site est publié automatiquement à la fin.

5. Modifier, annuler ou supprimer

  • POST /v1/sites/{id}/amend — prompt (+ files facultatifs) : l'agent modifie le site existant, puis il est republié. Interrogez à nouveau le même identifiant.
  • POST /v1/sites/{id}/cancel — arrête une génération en queued ou building.
  • DELETE /v1/sites/{id} — supprime définitivement le site publié, son espace de travail et toutes ses données.
  • GET /v1/published?folder=paris — tous vos sites publiés (créés par API ou dans l'application), éventuellement filtrés sous un chemin de dossier.

Les erreurs

Code Signification
400 Prompt vide, ou modèle inconnu.
401 Clé absente, invalide ou révoquée.
403 Compte indisponible, ou votre offre n'inclut pas l'API développeur.
404 Aucun job de ce nom pour votre compte.
409 Une génération est déjà en cours (amend), ou rien à annuler.
413 Un fichier dépasse 15 Mo.

Essayer dans le navigateur

La page Développeur contient l'Explorateur d'API — testez chaque endpoint : collez votre clé en haut, remplissez les paramètres, cliquez sur ▶ Envoyer, et utilisez Poll jusqu'à ready pour suivre un job en direct. Générations récentes liste vos derniers jobs avec un lien Voir ↗.

Pour aller plus loin

Cette page vous a-t-elle aidé ?