Une API d'infrastructure vidéo pour les produits IAInfrastructure vidéo

Utilisez une API REST unique pour les schémas, les aperçus, les tâches, le rendu, les fichiers et les webhooks afin d'intégrer des capacités vidéo dans vos flux produit et d'automatisation.

Démarrage rapide

Passez de l'aperçu à la tâche, au rendu et au webhook en quelques minutes.

1. Obtenir une clé API
Créez une clé API pour un usage côté serveur depuis votre tableau de bord.
2. Soumettre un schéma
Créez un aperçu temporaire ou une tâche formelle pour que la génération vidéo entre dans un workflow traçable.
3. Recevoir les résultats
Déclenchez le rendu et récupérez le résultat final via le polling d'état ou des webhooks.

Flux recommandé : aperçu ou création de tâche -> rendu -> interrogation de l'état / réception du webhook

Exemples de code

Les exemples ci-dessous illustrent le chemin standard d'une intégration de type production.

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
  }'

API principales

Interfaces clés pour les aperçus, les tâches, le rendu, les fichiers et les crédits basés sur l'utilisation.

POST
/api/v1/video
Créer une tâche formelle

Créez une tâche formelle traçable à partir d'un schéma sans lancer immédiatement le rendu.

GET
/api/v1/video
Lister les tâches formelles

Consultez la liste des tâches de votre compte avec une pagination adaptée aux tableaux de bord et aux flux de synchronisation backend.

GET
/api/v1/video/:taskId
Lire les détails d'une tâche

Renvoie les dimensions, la durée, le statut, les URL de sortie, les métadonnées et les horodatages clés d'une tâche.

DELETE
/api/v1/video/:taskId
Supprimer une tâche formelle

Supprimez les enregistrements locaux de la tâche et tentez un nettoyage sur le service de rendu amont.

POST
/api/v1/video/:taskId/render
Déclencher le rendu formel

Envoyez une tâche existante vers le rendu. Prend en charge `num_workers` et `webhook_url`.

POST
/api/v1/upload
Téléverser des ressources

Téléversez des fichiers image, vidéo et audio pour les réutiliser dans les workflows d'aperçu et de rendu.

GET
/api/v1/files
Lister les ressources

Parcourez la bibliothèque de fichiers avec des filtres de pagination et de type pour l'image, la vidéo et l'audio.

DELETE
/api/v1/files/:fileId
Supprimer une ressource

Supprimez les enregistrements de ressources et leurs objets stockés pour garder la bibliothèque propre.

GET
/api/v1/credits
Vérifier les crédits disponibles

Lisez votre solde de crédits restant avant de déclencher le rendu formel.

POST
/api/v1/preview
Créer un aperçu temporaire

Générez des liens d'aperçu sans consommer de crédits de rendu formel. Les liens d'aperçu expirent par défaut après 7 jours.

GET
/api/v1/preview/:tempId
Lire la configuration d'aperçu

Inspectez le schéma actuellement stocké derrière un lien d'aperçu temporaire.

DELETE
/api/v1/preview/:tempId
Supprimer le lien d'aperçu

Supprimez les aperçus temporaires avant leur expiration.

POST
/api/v1/preview/:tempId/convert
Convertir l'aperçu en tâche

Clonez un aperçu validé en tâche formelle sans lancer le rendu tout de suite.

POST
/api/v1/preview/:tempId/render
Convertir l'aperçu et lancer le rendu

Transformez un aperçu directement en tâche formelle et envoyez-le immédiatement au rendu.

Notifications Webhook
Conçu pour renvoyer les résultats de rendu dans vos propres systèmes.

Lorsque vous fournissez `webhook_url` dans une requête de rendu, RenderingVideo envoie une requête POST à votre point de terminaison lorsque la tâche se termine ou échoue. Cela convient aux mises à jour de base de données, aux callbacks de produit ou aux actions de suivi d'agents. Les événements actuels sont `completed` et `failed`.

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

Outils d'intégration

Utilisez les SDK pour connecter RenderingVideo plus rapidement à vos services existants.

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);
Voir sur GitHub
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)
Voir sur GitHub
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;
Voir sur GitHub

Authentification

Toutes les requêtes API côté serveur nécessitent une clé API.

Méthodes d'authentification prises en charge

En-tête Authorization (recommandé)

Authorization: Bearer sk-your-api-key

Authorization: Token

Authorization: Token sk-your-api-key

En-tête X-API-Key

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

Paramètre de requête (débogage uniquement, pas pour la production)

?api_key=sk-your-api-key

Note de sécurité : les clés API doivent rester uniquement sur votre serveur. Ne les exposez jamais dans le code client, les bundles navigateur ou les dépôts publics.

Prêt à intégrer ?

Intégrez les aperçus, les tâches formelles, le rendu et les callbacks de résultat dans votre propre produit et workflow.