Eine Video-Infrastruktur-API für KI-Produkte

Verwenden Sie eine REST-API für Schemata, Vorschauen, Aufgaben, Rendering, Dateien und Webhooks, um Videofunktionen in Ihr Produkt und Ihre Automatisierungsflüsse einzubetten.

Schnellstart

Gehen Sie in wenigen Minuten von Vorschau zu Aufgabe, Rendering und Webhook.

1. API-Key holen
Erstellen Sie im Dashboard einen API-Key für die serverseitige Nutzung.
2. Schema übermitteln
Erstellen Sie eine temporäre Vorschau oder eine formale Aufgabe, damit die Videogenerierung in einen nachvollziehbaren Workflow kommt.
3. Ergebnisse empfangen
Starten Sie das Rendering und erhalten Sie die finale Ausgabe per Statusabfrage oder Webhook.

Empfohlener Ablauf: Vorschau oder Aufgabe erstellen -> rendern -> Status abfragen / Webhook empfangen

Code-Beispiele

Die Beispiele unten zeigen den Standardweg für eine produktionsnahe Integration.

curl -X POST 'https://renderingvideo.com/api/v1/video' \
  -H 'Authorization: Bearer sk-your-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
    "config": {
      "meta": {
        "version": "2.0.0",
        "width": 1920,
        "height": 1080,
        "fps": 30,
        "background": "#000000"
      },
      "tracks": [
        {
          "clips": [
            {
              "type": "text",
              "text": "Hello World",
              "start": 0,
              "duration": 5
            }
          ]
        }
      ]
    }
  }'

curl -X POST 'https://renderingvideo.com/api/v1/video/<taskId>/render' \
  -H 'Authorization: Bearer sk-your-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook_url": "https://your-server.com/renderingvideo-webhook",
    "num_workers": 5
  }'

Kern-APIs

Wichtige Schnittstellen für Vorschauen, Aufgaben, Rendering, Dateien und nutzungsbasierte Credits.

POST
/api/v1/video
Eine formale Aufgabe erstellen

Erstellen Sie aus einem Schema eine nachvollziehbare formale Aufgabe, ohne das Rendering sofort zu starten.

GET
/api/v1/video
Formale Aufgaben auflisten

Lesen Sie die Aufgabenliste Ihres Kontos mit Paginierung für Dashboards und Backend-Synchronisationsflüsse.

GET
/api/v1/video/:taskId
Aufgabendetails lesen

Gibt Abmessungen, Dauer, Status, Ausgabe-URLs, Metadaten und wichtige Zeitstempel für eine Aufgabe zurück.

DELETE
/api/v1/video/:taskId
Eine formale Aufgabe löschen

Löschen Sie lokale Aufgabendatensätze und versuchen Sie eine Bereinigung beim nachgelagerten Rendering-Dienst.

POST
/api/v1/video/:taskId/render
Formales Rendering auslösen

Senden Sie eine bestehende Aufgabe ins Rendering. Unterstützt `num_workers` und `webhook_url`.

POST
/api/v1/upload
Assets hochladen

Laden Sie Bild-, Video- und Audiodateien hoch, um sie in Vorschau- und Rendering-Workflows wiederzuverwenden.

GET
/api/v1/files
Assets auflisten

Durchsuchen Sie die Dateibibliothek mit Paginierung und Typfiltern für Bild, Video und Audio.

DELETE
/api/v1/files/:fileId
Ein Asset löschen

Entfernen Sie Asset-Datensätze und die gespeicherten Objekte, damit die Bibliothek sauber bleibt.

GET
/api/v1/credits
Verfügbare Credits prüfen

Lesen Sie Ihr verbleibendes Credit-Guthaben, bevor Sie ein formales Rendering starten.

POST
/api/v1/preview
Eine temporäre Vorschau erstellen

Erzeugen Sie Vorschau-Links, ohne formale Render-Credits zu verbrauchen. Vorschau-Links laufen standardmäßig nach 7 Tagen ab.

GET
/api/v1/preview/:tempId
Vorschau-Konfiguration lesen

Sehen Sie sich das Schema an, das aktuell hinter einem temporären Vorschau-Link gespeichert ist.

DELETE
/api/v1/preview/:tempId
Vorschau-Link löschen

Entfernen Sie temporäre Vorschauen, bevor sie ablaufen.

POST
/api/v1/preview/:tempId/convert
Vorschau in Aufgabe umwandeln

Klonen Sie eine validierte Vorschau in eine formale Aufgabe, ohne sie sofort zu rendern.

POST
/api/v1/preview/:tempId/render
Vorschau umwandeln und rendern

Wandeln Sie eine Vorschau direkt in eine formale Aufgabe um und starten Sie sie sofort im Rendering.

Webhook-Benachrichtigungen
Entwickelt, um Render-Ergebnisse zurück in Ihre eigenen Systeme zu senden.

Wenn Sie bei einer Render-Anfrage `webhook_url` übergeben, sendet RenderingVideo beim Abschluss oder Fehlschlag der Aufgabe eine POST-Anfrage an Ihren Endpunkt. Das passt zu Datenbank-Updates, Produkt-Callbacks oder Folgeaktionen von Agenten. Die aktuellen Ereignisse sind `completed` und `failed`.

{
  "taskId": "abc123def456",
  "renderTaskId": "rt_002",
  "status": "completed",
  "videoUrl": "https://storage.../videos/abc123.mp4",
  "error": null,
  "timestamp": "2026-03-23T10:00:00.000Z"
}

Integrations-Tools

Verwenden Sie SDKs, um RenderingVideo schneller in bestehende Dienste einzubinden.

Node.js SDK
npm install @renderingvideo/sdk
import { RenderingVideo } from '@renderingvideo/sdk';

const client = new RenderingVideo({ apiKey: 'sk-xxx' });
const task = await client.video.create({
  meta: {
    version: '2.0.0',
    width: 1920,
    height: 1080,
    fps: 30,
    background: '#000000',
  },
  tracks: [...],
});
const render = await client.video.render(task.taskId, {
  webhook_url: 'https://your-server.com/renderingvideo-webhook',
});
console.log(render.status);
Auf GitHub ansehen
Python SDK
pip install renderingvideo
from renderingvideo import Client

client = Client(api_key="sk-xxx")
task = client.video.create({
    "meta": {
        "version": "2.0.0",
        "width": 1920,
        "height": 1080,
        "fps": 30,
        "background": "#000000"
    },
    "tracks": [...]
})

render = client.video.render(
    task.task_id,
    webhook_url="https://your-server.com/renderingvideo-webhook"
)
print(render.status)
Auf GitHub ansehen
PHP SDK
composer require renderingvideo/php-sdk
use RenderingVideo\Client;

$client = new Client('sk-xxx');
$task = $client->video->create([
    'meta' => [
        'version' => '2.0.0',
        'width' => 1920,
        'height' => 1080,
        'fps' => 30,
        'background' => '#000000'
    ],
    'tracks' => [...]
]);

$render = $client->video->render(
    $task->task_id,
    ['webhook_url' => 'https://your-server.com/webhook']
);
echo $render->status;
Auf GitHub ansehen

Authentifizierung

Alle serverseitigen API-Anfragen benötigen einen API-Key.

Unterstützte Authentifizierungsmethoden

Authorization Header (empfohlen)

Authorization: Bearer sk-your-api-key

Authorization: Token

Authorization: Token sk-your-api-key

X-API-Key Header

X-API-Key: sk-your-api-key

Query-Parameter (nur Debugging, nicht für Produktion)

?api_key=sk-your-api-key

Sicherheitshinweis: API-Keys gehören nur auf Ihren Server. Geben Sie sie niemals in Client-Code, Browser-Bundles oder öffentlichen Repositories preis.

Bereit zur Integration?

Binden Sie Vorschauen, formale Aufgaben, Rendering und Ergebnis-Callbacks in Ihr eigenes Produkt und Ihren Workflow ein.