Zum Hauptinhalt springen

Offizielle SDKs

Offizielle SDKs für fünf Sprachen

Installieren Sie ein Paket und rufen Sie Bild-, Video- und Audiomodelle von Ihrem eigenen Server aus auf. Das SDK übernimmt Authentifizierung und Warten auf Ergebnisse – Sie schreiben nur die Anfrage und lesen die Antwort.

Was das SDK für Sie übernimmt

Sie schreiben einen einzigen Funktionsaufruf. Das SDK signiert die Anfrage, lädt Ihre Dateien hoch, wartet auf das Ergebnis und liefert es als typisierte Daten zurück.

  1. Ihr CodeEin Funktionsaufruf
  2. Offizielles SDKSigniert Anfragen, lädt Dateien hoch, wartet auf Ergebnisse
  3. Bild-, Video- und AudiomodelleDieselben Modelle und Preise wie auf der Website
Ohne SDK senden Sie dieselben Anfragen selbst per HTTPS. Das SDK erspart Ihnen nur den Boilerplate.

Ideal für

  • Backend-DiensteMedien direkt in Ihrer eigenen API oder Job-Queue erzeugen.
  • Skripte und Batch-JobsViele Tasks aus einer Tabelle oder einem geplanten Job anlegen.
  • Apps mit ServerDer Schlüssel bleibt auf dem Server, fertige Dateien gehen an die Nutzer.

In drei Schritten loslegen

  1. Schritt 1

    API-Schlüssel anlegen

    Erstellen Sie ihn in der Konsole und legen Sie ihn als SPICY_API_KEY auf Ihrem Server ab.

  2. Schritt 2

    Paket installieren

    Wählen Sie unten Ihre Sprache und führen Sie die Installationszeile aus.

  3. Schritt 3

    Task erstellen, Ergebnis lesen

    Prompt senden, auf den Task warten und die gelieferte Datei speichern.

Ihre Sprache wählen

Jedes SDK erscheint in der Haupt-Registry seiner Sprache und spricht dieselbe API. Wechseln Sie die Tabs für die Installationszeile und eine vollständige Anfrage.

TypeScript

@spicyapi/sdk

Benötigt Node.js 22.13+

Ihr Server erstellt Aufgaben und speichert Ergebnisse. Installieren, Schlüssel exportieren, ausführen.

Installieren · bash
npm install @spicyapi/sdk
export SPICY_API_KEY="injected from your secret manager"
Task erstellen und Ergebnis lesen · 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);

Was nach dem Absenden passiert

Bild- und Videogenerierung läuft weiter, nachdem der Create-Aufruf geantwortet hat. Speichern Sie die Task-ID und lassen Sie sich per Webhook oder zeitlich begrenzter Statusabfrage melden, wann der Task fertig ist.

  1. createTaskMit Idempotency-Key senden; dieselbe Generierung wird nur einmal angenommen.
  2. taskIdDie Antwort kommt sofort zurück, während der Task weiterläuft.
  3. Webhook / recordInfoZuerst der signierte Webhook; Polling nur zur Wiederherstellung.
  4. output.assetsSofort nutzbare URLs. Kopieren Sie, was Sie behalten wollen.

Aufruf aus Browser oder Mobile-App

Ein in einer Client-App eingebauter Schlüssel kann von Nutzern ausgelesen werden. Halten Sie ihn auf Ihrem Server: @spicyapi/proxy ergänzt die Zugangsdaten bei Anfragen Ihres Frontends, sodass die App sie nie erhält.

  • Schlüssel in der AppJeder kann ihn auslesen und Ihr Guthaben verbrauchen.
    1. App mit eingebautem Schlüssel
    2. SpicyAPI
  • Schlüssel auf Ihrem ServerDie App spricht mit Ihrem Server, der Proxy ergänzt den Schlüssel.
    1. Browser oder Smartphone
    2. Ihr Server + 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";

Vor dem Livegang

  • 01Aktuelle Modellverfügbarkeit bestätigen.
  • 02Exakte Felder der Modellseite validieren.
  • 03API-Schlüssel nur serverseitig halten.
  • 04Schätzung vor dem Absenden zeigen.
  • 05taskId außerhalb der Browser-Sitzung speichern.
  • 06Webhook-Signatur oder Abfragegrenze prüfen.
  • 07Angenommene Aufträge als nicht abbrechbar behandeln.

Häufige Fehler beheben

Die meisten Anfangsprobleme sind eines dieser drei. Jede Karte zeigt, was Sie sehen und was Sie ändern müssen.

  • 401

    Ungültiger API-Schlüssel

    Bei der API kam kein oder ein falscher Schlüssel an. Setzen Sie SPICY_API_KEY in derselben Umgebung, in der Ihr Code läuft.

  • Warten

    Task läuft noch

    Videos können einige Minuten dauern. Warten Sie mit Zeitlimit oder nutzen Sie einen Webhook. Ein erneutes Senden ohne denselben Idempotency-Key erzeugt einen zweiten kostenpflichtigen Task.

  • Link

    Ergebnislink abgelaufen

    Download-Links sind nur kurz gültig. Fordern Sie für den Task einen frischen Link an, statt den alten zu speichern.

Häufige Fragen