Zum Artikel springen
Dokumentation

Dokumentation durchsuchen

Die Suche bleibt in diesem Browser. Suchbegriffe werden weder gesendet noch gespeichert. Füge keine Zugangsdaten ein.

Öffentlicher Suchindex wird geladen…

Tab oder Pfeiltasten zum Navigieren · Enter zum Öffnen · Esc zum Schließen
Dokumentationsverzeichnis

Animation erstellen

Generierte Referenz für POST /animations: Authentifizierung, Felder, Antworten, Fehler und sichere Nutzung.

Öffentliche BetaAPI v1 · 1.4.0Zuletzt geprüft
Auf dieser Seite

Operation

POST /animations

operationId: create_one_click_animation_v1_animations_post

Startet einen kostenpflichtigen asynchronen Auftrag. Hole zuerst Kostenvoranschlag und Zustimmung ein und speichere die zurückgegebene ID. HTTP 202 bedeutet angenommen, nicht abgeschlossen. Ist die Antwort unklar, verwende denselben Idempotency-Key, dieselbe Identität und einen unveränderten Anfragetext. Der Preis wird beim Erstellen neu berechnet; API-Kostenvoranschläge fixieren ihn nicht. max_credits und quote_id sind keine Felder des API-Anfragetexts. Beachte beim Abfragen Retry-After und prüfe Ausgaben aller Endzustände, auch fehlgeschlagener Aufträge.

Authentifizierung und Nebenwirkungen

Verwende einen serverseitigen Bearer-API-Schlüssel. Erforderliche Berechtigung: animations:write

Dies erstellt einen kostenpflichtigen Auftrag. Hole vor dem Absenden eine Freigabe ein. API-Kostenvoranschläge fixieren keinen Preis und erzwingen keine Budgetobergrenze.

Parameter

Parameter Position Typ Erforderlich Einschränkungen / Standardwert Bedeutung
Idempotency-Key header string Ja minLength: 8; maxLength: 200 Persist once per logical operation; reuse with the same credential and unchanged body. Changing credentials changes the deduplication scope.

Anfragetext (application/json)

Anfragetext erforderlich: true

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
export ExportOptions Nein {"fps":null,"frame_count":24,"output_formats":["spritesheet"],"output_height":512,"output_width":512,"transparent":{"enabled":false},"unity":{"pivot":"bottom_center","pixels_per_unit":100}} — Export after video generation. Alpha-bearing formats require an alpha_key source; compatible formats automatically enable its transparent export.
input GenerationInput Ja — — Images owned by the caller or supplied for this generation.
metadata object Nein {} — Caller metadata: simple string/number/boolean/null values, at most 4 KiB JSON. Do not store secrets.
negative_prompt string Nein "" maxLength: 4000 Optional exclusions, only when the model supports negative prompts.
prompt string Nein "" maxLength: 8000 Motion instruction; nonempty when the model requires a prompt. Keep private prompts out of logs.
selection Selection Nein {"duration_seconds":null,"mode":"full","start_seconds":0} — Interval selected after generation; full by default.
video VideoOptions Nein {"duration_seconds":null,"input_canvas":null,"model":null,"ratio":null,"resolution":null,"seed":null,"style_preset":null,"transparency":{"key_color":null,"key_selection":"auto","mode":"standard"},"watermark":null} — Model-compatible generation settings.

Vollständiges verschachteltes Schema: AnimationCreateRequest

Beispielanfrage

json
{
  "export": {
    "frame_count": 24,
    "output_formats": [
      "frames_zip"
    ],
    "output_height": 512,
    "output_width": 512
  },
  "input": {
    "first_frame": {
      "file_id": "00000000-0000-4000-8000-000000000001",
      "type": "file"
    }
  },
  "prompt": "A character runs in place, side view, fixed camera.",
  "selection": {
    "mode": "full"
  }
}

Antworten

HTTP Inhalt Bedeutung
202 TaskResponse Accepted asynchronously; poll the task ID.
400 APIErrorEnvelope Invalid input; correct the request before retrying.
401 APIErrorEnvelope Missing, expired, or revoked API key.
402 APIErrorEnvelope Insufficient credits; do not automatically purchase.
403 APIErrorEnvelope Account eligibility, account status, or key scope does not allow this operation.
404 APIErrorEnvelope Resource is unavailable, not owned, or its signature is invalid/expired.
409 APIErrorEnvelope Idempotency conflict; only IDEMPOTENCY_IN_PROGRESS is retryable with the original request.
413 APIErrorEnvelope Request or decoded image exceeds the configured limit.
415 APIErrorEnvelope Use supported image media types.
422 APIErrorEnvelope Decoded image dimensions exceed the allowed size.
429 APIErrorEnvelope Account-wide rate or queue limit; wait for Retry-After.
500 APIErrorEnvelope Internal failure; preserve the task/key and retry only when marked retryable.
503 APIErrorEnvelope Service/provider unavailable; retry only when error.retryable is true.

Antwort-Header

HTTP Header Typ Bedeutung
202 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.
429 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.
503 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.

Beispielantwort

json
{
  "created_at": "2026-08-30T00:00:00Z",
  "credits": {
    "charged": 0,
    "held": 1,
    "quoted": 1
  },
  "error": null,
  "finished_at": null,
  "id": "00000000-0000-4000-8000-000000000002",
  "metadata": {},
  "normalized_input": {},
  "object": "animation",
  "outputs": [],
  "progress": 0,
  "stage": "queued",
  "started_at": null,
  "status": "queued"
}

Weiterführende Anleitungen

Statusabfragen und Downloads · Fehler und sichere Wiederholungen

War diese Seite hilfreich?

Es werden keine Suchbegriffe, Codes oder Freitexte erfasst. Dieser Schalter steuert nur Dokumentationsinteraktionen; allgemeine Website-Analysen folgen der Datenschutzerklärung. Datenschutzerklärung

Brauchst du Hilfe? Support kontaktieren