Zum Inhalt springen
API-Referenz
API-Referenz

HeyGen Video Text zu Video

Erzeuge ein 5 bis 15 Sekunden langes Video mit Ton aus Text, optional mit Referenzbildern, -videos oder -audio als Vorgabe.

Markdown anzeigen
01

Übersicht

Verwenden Sie den Endpunkt „Text zu Video" mit einem unterstützten Modell. Verwenden Sie die zurückgegebene Task-ID, um den Status abzurufen, oder geben Sie callback_url für die unten dokumentierten Zustellungen an.

Schnellstart

  1. Erstellen Sie einen API-Schlüssel und setzen Sie ihn als RUNAPI_API_KEY.
  2. Wählen Sie ein unterstütztes Modell und senden Sie eine POST-Anfrage, deren Body dem Schema dieses Modells entspricht.
  3. Speichern Sie die zurückgegebene Task-ID und fragen Sie den Status ab, bis ein Endzustand erreicht ist, oder verarbeiten Sie die unten dokumentierten Callbacks.

Endpunkt

POST /api/v1/heygen_video/text_to_video
Basis-URL
https://runapi.ai
API-Version
v1
Authentifizierung
Authorization: Bearer YOUR_API_TOKEN
02

Unterstützte Modelle

Öffnen Sie eine Modellseite für aktuelle Preise, Ratenlimits und Details zur kommerziellen Nutzung.

03

Anfrage-Schema

JSON-Body

Felder und zulässige Werte hängen vom ausgewählten Modell ab. Wenn angegeben, empfängt callback_url die unten dokumentierten Task-Zustellungen.

heygen-video-110 Felder
aspect_ratiostring
Optional

Seitenverhältnis des erzeugten Videos; adaptive folgt dem ersten Referenzbild oder -video und ist nur mit Referenzmedien bei 480p oder 768p verfügbar.

Zulässige Werte: adaptive, 21:9, 16:9, 4:3, 1:1, 3:4, 9:16
callback_urlstring
Optional

Webhook-URL für asynchrone Benachrichtigungen.

duration_secondsinteger
Optional

Dauer des generierten Videos in Sekunden.

Zulässige Werte: 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 Standard: 5
modelstring
Erforderlich

Modell-Slug.

output_resolutionstring
Optional

Auflösung des erzeugten Videos; 1080p und 2k unterstützen nur 16:9 und 9:16.

Zulässige Werte: 480p, 768p, 1080p, 2k Standard: 768p
promptstring
Erforderlich

Prompt zur Videogenerierung, der Szene, Dialog und Ton beschreibt.

Bereich: 1 - 16000
reference_audio_urlsarray
Optional

Öffentliche HTTPS-URLs der Referenz-Audios, jeweils bis zu 32 MB; erfordert Referenzbilder oder -videos.

Elementlimit: 3
reference_image_urlsarray
Optional

Öffentliche HTTPS-URLs der Referenzbilder, jeweils bis zu 16 MB; insgesamt bis zu 12 Referenzdateien aus Bildern, Videos und Audios.

Elementlimit: 9
reference_video_urlsarray
Optional

Öffentliche HTTPS-URLs der Referenzvideos mit Seitenverhältnis zwischen 1:4 und 4:1, jeweils bis zu 32 MB; nur die ersten 5 Sekunden jedes Videos werden verwendet.

Elementlimit: 3
seedinteger
Optional

Zufallswert für reproduzierbare Generierung.

Bereich: 0 - 4294967295

Bedingte Regeln

Diese Anforderungen gelten, wenn alle aufgeführten Bedingungen zutreffen.

  1. Wenn reference_audio_urls present
    Erforderlich
    Nicht akzeptiert
  2. Wenn reference_image_urls absent, reference_video_urls absent
    Erforderlich
    Nicht akzeptiert
  3. Wenn output_resolution = 1080p
    Erforderlich
    Nicht akzeptiert
  4. Wenn output_resolution = 2k
    Erforderlich
    Nicht akzeptiert
04

Annahme erstellen

HTTP 202

POST /api/v1/heygen_video/text_to_video

Antwort-Schema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    },
    "task_replayed": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "status"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "id": "tsk_reference_demo",
  "status": "processing"
}
05

Abfrage wird verarbeitet

HTTP 200

GET /api/v1/heygen_video/text_to_video/:id

Antwort-Schema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "id": "tsk_reference_demo",
  "status": "processing"
}
06

Abfrage abgeschlossen

HTTP 200

GET /api/v1/heygen_video/text_to_video/:id

Antwort-Schema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "usage": {
      "properties": {
        "cost": {
          "type": "number"
        }
      },
      "required": [
        "cost"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "videos": {
      "items": {
        "properties": {
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "status",
    "videos",
    "usage"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "id": "tsk_reference_demo",
  "status": "completed",
  "usage": {
    "cost": 0.05
  },
  "videos": [
    {
      "url": "https://file.runapi.ai/reference-video.mp4"
    }
  ]
}
07

Abfrage fehlgeschlagen

HTTP 200

GET /api/v1/heygen_video/text_to_video/:id

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Task processing failed.",
  "id": "tsk_reference_demo",
  "status": "failed"
}
08

Kunden-Callback: abgeschlossen

HTTP 200

POST callback_url

Antwort-Schema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "usage": {
      "properties": {
        "cost": {
          "type": "number"
        }
      },
      "required": [
        "cost"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "videos": {
      "items": {
        "properties": {
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "status",
    "videos",
    "usage"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "id": "tsk_reference_demo",
  "status": "completed",
  "usage": {
    "cost": 0.05
  },
  "videos": [
    {
      "url": "https://file.runapi.ai/reference-video.mp4"
    }
  ]
}
09

Kunden-Callback: fehlgeschlagen

HTTP 200

POST callback_url

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "properties": {
            "code": {
              "type": "string"
            },
            "limit_cents": {
              "type": "integer"
            },
            "message": {
              "type": "string"
            },
            "reset_at": {
              "format": "date-time",
              "type": [
                "string",
                "null"
              ]
            },
            "used_cents": {
              "type": "integer"
            },
            "window": {
              "enum": [
                "1h",
                "1d",
                "7d",
                "daily",
                "weekly",
                "monthly",
                "lifetime"
              ],
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object",
          "unevaluatedProperties": false
        }
      ]
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": {
    "code": "generation_failed",
    "message": "Task processing failed."
  },
  "id": "tsk_reference_demo",
  "status": "failed"
}
10

Fehler

HTTP 401

POST /api/v1/heygen_video/text_to_video

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Authentication required"
}
11

Fehler

HTTP 401

GET /api/v1/heygen_video/text_to_video/:id

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Authentication required"
}
12

Fehler

HTTP 400

POST /api/v1/heygen_video/text_to_video

Antwort-Schema
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Für Menschen lesbare Fehlermeldung.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Menschenlesbare Validierungszusammenfassung.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validierungsmeldungen nach öffentlichem Anforderungsfeld gegliedert, mit einem Array menschenlesbarer Zeichenketten für jedes Feld.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Antwortbeispiel

JSON 
{
  "error": "model must be one of: heygen-video-1"
}
13

Fehler

HTTP 402

POST /api/v1/heygen_video/text_to_video

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Insufficient balance"
}
14

Fehler

HTTP 429

POST /api/v1/heygen_video/text_to_video

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "API key credit limit exceeded"
}
15

Fehler

HTTP 409

POST /api/v1/heygen_video/text_to_video

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "The request uses features that are not supported for the selected model"
}
16

Fehler

HTTP 429

POST /api/v1/heygen_video/text_to_video

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Rate limit reached. Please retry later."
}
17

Fehler

HTTP 503

POST /api/v1/heygen_video/text_to_video

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Service under maintenance, please try again later"
}
18

Fehler

HTTP 504

POST /api/v1/heygen_video/text_to_video

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "The request timed out"
}
19

Fehler

HTTP 404

GET /api/v1/heygen_video/text_to_video/:id

Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Task with id 'tsk_reference_demo' not found"
}
20

Generierte Code-Beispiele

Verwende cURL direkt oder installiere ein SDK für deine Programmiersprache. Jedes Beispiel übermittelt die in dieser Referenz gezeigte validierte Anfrage.

Installieren

Shell 
pip install runapi-heygen-video
PYTHON 
import os
from runapi.heygen_video import HeyGenVideoClient

client = HeyGenVideoClient(api_key=os.environ["RUNAPI_API_KEY"])
task = client.text_to_video.create(
  model="heygen-video-1",
  prompt="A plant supervisor in a plain grey coat stands beside a conveyor line and speaks to camera.",
  aspect_ratio="16:9",
  output_resolution="768p"
)