Passer au contenu
FreshApp Demo

API OUVERTE

Générez depuis votre propre code

Utilisez les modèles du site depuis votre serveur. Créez une génération avec une clé API, suivez-la jusqu’à la fin et téléchargez ses fichiers.

Lire la documentation de l’APIGérer les clés API

L’API ne dépense que des crédits payants : un pack de crédits payant ou un abonnement payant actif la débloque. Gardez vos clés sur votre serveur.

EXEMPLE DE REQUÊTE

Créer votre première génération

export API_ORIGIN='https://demo.freshapp.ai'
export API_KEY='sk_YOUR_API_KEY'

curl --fail-with-body "$API_ORIGIN/api/v1/generations" \
  -H "Authorization: Bearer $API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: order-1001' \
  -d '{"model":"seed-audio-1.0","input":{"prompt":"Un phare sur une falaise à l’aube, mer calme, lumière douce."}}'

# Read it every 5 to 10 seconds until its status ends.
curl --fail-with-body "$API_ORIGIN/api/v1/generations/GENERATION_ID" \
  -H "Authorization: Bearer $API_KEY"

# A delivered output's url is a signed link: no key needed.
curl --fail-with-body -o result "OUTPUT_URL"

Définissez d’abord API_KEY avec votre clé. Envoyez une nouvelle Idempotency-Key à chaque nouvelle requête, et la même quand vous renvoyez cette requête.

FONCTIONNEMENT

Trois étapes de la requête au fichier

  1. Créer une génération

    Envoyez un identifiant de modèle et son entrée avec votre clé API et une Idempotency-Key. La réponse est la génération, en file d’attente, avec les crédits qu’elle réserve.

  2. La suivre

    Lisez la génération toutes les 5 à 10 secondes jusqu’à ce qu’elle réussisse, réussisse en partie, échoue ou soit annulée. Ce qu’elle n’a pas utilisé revient au règlement.

  3. Télécharger les fichiers

    Chaque sortie livrée renvoie vers son fichier sur ce site. Les liens qu’obtient une clé sont signés et s’ouvrent pendant une heure sans la clé.

PERMISSIONS ET LIMITES

Des clés qui ne font que ce que vous autorisez

  • Une clé est soit en lecture seule (elle liste, lit et télécharge), soit autorisée à générer (elle crée et annule), et une liste d’adresses IP autorisées peut la lier à vos serveurs.

  • Une requête réserve au plus 150 crédits, la requête la plus chère des modèles activés ; le réglage de la clé ou le max_credits de la requête ne peuvent que l’abaisser.

  • Une clé dépense au plus 5 000 crédits par jour UTC, et toutes les clés d’un compte ensemble 10 000, sauf si vous fixez d’autres limites sur la page des clés API.

  • Par clé et par compte : 20 créations et annulations et 240 lectures et téléchargements par minute, et au plus 2 générations en cours à la fois.

FICHIERS

Le fichier OpenAPI et un client TypeScript

Le fichier OpenAPI 3.1 décrit chaque opération, l’entrée de chaque modèle activé et chaque code d’erreur. Le client TypeScript n’a besoin de rien d’autre : il garde la même Idempotency-Key d’une tentative à l’autre et suit une génération jusqu’au bout, et le hook React s’en sert pour interroger l’API.

Lire la documentation de l’APIFichier OpenAPI 3.1Client TypeScriptHook React de suivi

FAQ

Questions sur l’API