Aller au contenu principal

SDK officiels

Des SDK officiels pour cinq langages

Installez un paquet et appelez les modèles d’image, de vidéo et d’audio depuis votre propre serveur. Le SDK gère l’authentification et l’attente des résultats : vous n’écrivez que la requête et lisez la réponse.

Ce que le SDK fait pour vous

Vous écrivez un seul appel de fonction. Le SDK signe la requête, envoie vos fichiers, attend le résultat et vous le rend sous forme de données typées.

  1. Votre codeUn seul appel de fonction
  2. SDK officielSigne les requêtes, envoie les fichiers, attend les résultats
  3. Modèles d’image, de vidéo et d’audioMêmes modèles et mêmes tarifs que sur le site
Sans SDK, vous envoyez les mêmes requêtes vous-même en HTTPS. Le SDK vous épargne simplement le code répétitif.

Idéal pour

  • Services backendGénérez des médias au sein de votre propre API ou file de tâches.
  • Scripts et traitements par lotsCréez de nombreuses tâches depuis un tableur ou un job planifié.
  • Applis avec serveurGardez la clé côté serveur et envoyez les fichiers terminés à vos utilisateurs.

Démarrez en trois étapes

  1. Étape 1

    Créez une clé API

    Générez-en une dans la console et stockez-la sous SPICY_API_KEY sur votre serveur.

  2. Étape 2

    Installez le paquet

    Choisissez votre langage ci-dessous et lancez la ligne d’installation.

  3. Étape 3

    Créez une tâche, lisez le résultat

    Envoyez un prompt, attendez la tâche, puis enregistrez le fichier renvoyé.

Choisissez votre langage

Chaque SDK est publié sur le registre principal de son langage et s’appuie sur la même API. Changez d’onglet pour voir la ligne d’installation et une requête complète.

TypeScript

@spicyapi/sdk

Nécessite Node.js 22.13+

Votre serveur crée les tâches et stocke les résultats. Installer, exporter la clé, exécuter.

Installer · bash
npm install @spicyapi/sdk
export SPICY_API_KEY="injected from your secret manager"
Créer une tâche et lire le résultat · ts
import { randomUUID } from "node:crypto";
import { SpicyClient } from "@spicyapi/sdk";

const client = new SpicyClient();
const model = await client.getModel("MODEL_ID_FROM_CATALOG");
const task = await client.run(
  { model: model.model, input: { prompt: "A cinematic night portrait" } },
  { idempotencyKey: randomUUID() },
);
console.log(task.state, task.output?.assets?.[0]?.url);

Ce qui se passe après l’envoi

La génération d’images et de vidéos se poursuit après la réponse à l’appel de création. Enregistrez l’ID de la tâche, puis laissez un webhook ou une vérification de statut limitée dans le temps vous dire quand c’est terminé.

  1. createTaskEnvoyez avec une clé d’idempotence : une même génération n’est acceptée qu’une fois.
  2. taskIdLa réponse revient immédiatement pendant que la tâche continue.
  3. Webhook / recordInfoPrivilégiez un webhook signé ; gardez un polling limité pour la récupération.
  4. output.assetsDes URL directement exploitables. Copiez ce que vous voulez conserver.

Appeler depuis un navigateur ou une appli mobile

Une clé placée dans une appli cliente est une clé publique. Gardez-la sur votre serveur : @spicyapi/proxy ajoute l’identifiant aux requêtes de votre front-end, et l’appli ne le voit jamais.

  • Clé dans l’appliN’importe qui peut la lire et dépenser votre solde.
    1. Appli avec la clé à l’intérieur
    2. SpicyAPI
  • Clé sur votre serveurL’appli parle à votre serveur, et le proxy ajoute la clé.
    1. Navigateur ou téléphone
    2. Votre serveur + proxy
    3. SpicyAPI
@spicyapi/proxy
npm install @spicyapi/proxy
next.js
// app/api/spicy/proxy/route.ts
export { GET, POST } from "@spicyapi/proxy/nextjs";
export const runtime = "nodejs";

Avant la mise en ligne

  • 01Confirmer la disponibilité actuelle du modèle.
  • 02Valider les champs exacts de sa fiche.
  • 03Garder la clé API côté serveur.
  • 04Afficher l’estimation avant l’envoi.
  • 05Conserver l’ID de tâche hors de la session du navigateur.
  • 06Vérifier la signature webhook ou la limite des vérifications.
  • 07Traiter toute tâche acceptée comme non annulable.

Corriger les erreurs courantes

La plupart des problèmes du début sont l’un de ces trois-là. Chaque carte montre ce que vous voyez et l’unique chose à changer.

  • 401

    Clé API invalide

    L’API n’a reçu aucune clé valide. Définissez SPICY_API_KEY dans le même environnement que celui qui exécute votre code.

  • attente

    Tâche toujours en cours

    Une vidéo peut prendre quelques minutes. Attendez avec une limite de temps ou utilisez un webhook. Renvoyer sans la même Idempotency-Key crée une seconde tâche payante.

  • lien

    Lien de résultat expiré

    Les liens de téléchargement sont éphémères. Demandez un nouveau lien pour la tâche plutôt que de conserver l’ancien.

Questions fréquentes