Vidéos

GET/v1/videos

Lister les vidéos, des plus récentes aux plus anciennes (pagination par curseur)

Permission videos:read

Paramètres de requête

Réponse 200 · Page de vidéos

curl https://api.vidoum.com/v1/videos \
  -H "Authorization: Bearer $VIDOUM_API_KEY"

GET/v1/videos/{id}

Une vidéo, avec ses qualités et ses sous-titres

Permission videos:read

Paramètres de chemin

Réponse 200 · Vidéo

curl https://api.vidoum.com/v1/videos/ID \
  -H "Authorization: Bearer $VIDOUM_API_KEY"

PATCH/v1/videos/{id}

Modifier le titre, la description ou la référence externe

Permission videos:write

Paramètres de chemin

Corps de la requête

Réponse 200 · Vidéo

curl -X PATCH https://api.vidoum.com/v1/videos/ID \
  -H "Authorization: Bearer $VIDOUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Séance 3 — La cellule",
    "description": "Chapitre 2, partie 1",
    "externalRef": "lesson:42"
  }'

DELETE/v1/videos/{id}

Supprimer une vidéo et ses fichiers (les copies en cache sont bloquées d’abord)

Permission videos:write

Paramètres de chemin

Réponse 204 · Supprimé

curl -X DELETE https://api.vidoum.com/v1/videos/ID \
  -H "Authorization: Bearer $VIDOUM_API_KEY"

POST/v1/videos/{id}/retry

Relancer l’encodage d’une vidéo en échec

Permission videos:writeIdempotency-Key accepté

Paramètres de chemin

Réponse 200 · Vidéo en file d’encodage

curl -X POST https://api.vidoum.com/v1/videos/ID/retry \
  -H "Authorization: Bearer $VIDOUM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

POST/v1/videos/{id}/complete

Alias de compatibilité de POST /v1/uploads/{id}/complete pour l’envoi en cours de la vidéo

Permission uploads:writeIdempotency-Key accepté

Paramètres de chemin

Corps de la requête

Réponse 200 · Vidéo en file d’encodage

curl -X POST https://api.vidoum.com/v1/videos/ID/complete \
  -H "Authorization: Bearer $VIDOUM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "parts": [
      {
        "partNumber": 1,
        "etag": "\"3858f62230ac3c91\""
      }
    ]
  }'

GET/v1/videos/{id}/thumbnail

Redirection (302) vers une URL de la miniature valable 10 minutes ; 404 si la lecture est désactivée

Permission videos:read

Paramètres de chemin

Réponse 302 · Redirection vers l’image de la miniature

curl https://api.vidoum.com/v1/videos/ID/thumbnail \
  -H "Authorization: Bearer $VIDOUM_API_KEY"

POST/v1/videos/{id}/captions

URL d’envoi signée pour un fichier de sous-titres WebVTT (vidéos prêtes)

Permission videos:write

Paramètres de chemin

Corps de la requête

Réponse 201 · Envoi de sous-titres

curl -X POST https://api.vidoum.com/v1/videos/ID/captions \
  -H "Authorization: Bearer $VIDOUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "language": "fr",
    "size": 734003200
  }'

DELETE/v1/videos/{id}/captions/{language}

Supprimer un fichier de sous-titres

Permission videos:write

Paramètres de chemin

Réponse 204 · Supprimé

curl -X DELETE https://api.vidoum.com/v1/videos/ID/captions/fr \
  -H "Authorization: Bearer $VIDOUM_API_KEY"