Bobine
GitHubV5.1.25
Reference

HTTP API

Every route of Bobine's local API (port 1903 by default), on the local network only. Each route has its bobine command. Every error answers { "detail": { "code", "message" } }.

Error codes

400
bad_request
401
unauthorized
403
forbidden
404
not_found
405
method_not_allowed
409
conflict
413
too_large
422
invalid
429
too_many_requests
500
internal_error
503
unavailable
504
timeout
507
insufficient_storage

Domains

/api/audio

GET /api/audio

List Audio Courses

GET /api/audio/programs

Catégories (programmes) réellement présentes parmi les cours audio, triées.

GET /api/audio/tracks

Toutes les pistes de tous les cours audio, à plat, avec leur contexte de cours d'origine.

GET /api/audio/tracks/{track_id}/stream

Stream Audio Track

Path

track_id integer

POST /api/audio/upload

Import multi-fichiers MP3 d'un cours, traité en arrière-plan — voir `_run_audio_files_import_job` et `GET /api/import-jobs`.

Body (multipart)

files string[]
title string
program string?
release string?

POST /api/audio/upload-zip

Import d'une archive ZIP d'un cours complet, traité en arrière-plan — voir `_run_audio_zip_import_job` et `GET /api/import-jobs`.

Body (multipart)

file string?
upload_id string?
title string
program string?
release string?

DELETE /api/audio/{course_id}

Delete Audio Course

Path

course_id integer

GET /api/audio/{course_id}

Get Audio Course

Path

course_id integer

PUT /api/audio/{course_id}

Update Audio Course

Path

course_id integer

Body (json)

title string?
program string?
release string?
background_id integer?
clear_background boolean?

PUT /api/audio/{course_id}/tracks/reorder

Réordonnancement des pistes par glisser-déposer.

Path

course_id integer

Body (json)

track_ids integer[]

PUT /api/audio/{course_id}/tracks/{track_id}

Update Audio Track

Path

course_id integer
track_id integer

Body (json)

title string?
number integer?
background_id integer?
clear_background boolean?

/api/audio-playlists

GET /api/audio-playlists

Liste toutes les playlists audio ("éditions mixées") avec le nombre de pistes et la durée totale.

POST /api/audio-playlists

Create Audio Playlist

Body (json)

name string
items object[]?

DELETE /api/audio-playlists/{playlist_id}

Delete Audio Playlist

Path

playlist_id integer

GET /api/audio-playlists/{playlist_id}

Get Audio Playlist

Path

playlist_id integer

PUT /api/audio-playlists/{playlist_id}

Update Audio Playlist

Path

playlist_id integer

Body (json)

name string
items object[]?

POST /api/audio-playlists/{playlist_id}/duplicate

Duplicate Audio Playlist

Path

playlist_id integer

/api/backgrounds

GET /api/backgrounds

List Backgrounds

POST /api/backgrounds/upload

Upload web d'un fond animé — traité en arrière-plan, voir `_run_background_import_job` et `GET /api/import-jobs`.

Body (multipart)

file string?
upload_id string?
title string?

POST /api/backgrounds/upload-zip

Import d'une archive (ZIP ou tar) de fonds animés et d'images : un fond par fichier, en une seule tâche.

Body (multipart)

file string?
upload_id string?

DELETE /api/backgrounds/{background_id}

Delete Background

Path

background_id integer

GET /api/backgrounds/{background_id}

Get Background

Path

background_id integer

PUT /api/backgrounds/{background_id}

Update Background

Path

background_id integer

Body (json)

title string?

GET /api/backgrounds/{background_id}/stream

Stream Background

Path

background_id integer

/api/config

GET /api/config

Fichiers disponibles et dossier de la copie à jour (lecture seule, jamais relue par Bobine).

POST /api/config/apply

Applique un ou plusieurs fichiers (`{"files": {"settings.json": {...}}}`) en une seule transaction.

Query

dry_run boolean?
include_machine boolean?

GET /api/config/export

Tous les fichiers d'un coup : `{"schema": 2, "files": {"settings.json": {...}, "playlists/video.json": {...}, ...}}`.

GET /api/config/export/{name}

Export Config File

Path

name string

/api/devices

GET /api/devices/audio

Audio List

POST /api/devices/audio/balance

Audio Balance

Body (json)

id string
balance number

POST /api/devices/audio/default

Audio Set Default

Body (json)

id string

GET /api/devices/audio/details

Audio Details

Query

id string

PUT /api/devices/audio/meta

Nom personnalisé et masquage d'une sortie : réglages de Bobine, communs à toutes les plateformes.

Body (json)

id string
alias string?
hidden boolean?

POST /api/devices/audio/profile

Audio Profile

Body (json)

id string
index integer

POST /api/devices/audio/test

Audio Test

Body (json)

id string
channel string

POST /api/devices/audio/volume

Audio Set Volume

Body (json)

id string
volume number?
muted boolean?

GET /api/devices/bluetooth

Bluetooth Status

POST /api/devices/bluetooth/connect

Bluetooth Connect

Body (json)

address string

POST /api/devices/bluetooth/disconnect

Bluetooth Disconnect

Body (json)

address string

POST /api/devices/bluetooth/forget

Bluetooth Forget

Body (json)

address string

POST /api/devices/bluetooth/pair

Bluetooth Pair

Body (json)

address string

POST /api/devices/bluetooth/pairing/respond

Bluetooth Pairing Respond

Body (json)

address string
accept boolean

POST /api/devices/bluetooth/permission

Android : affiche sur l'appareil la demande d'autorisation « Appareils à proximité ».

POST /api/devices/bluetooth/power

Bluetooth Power

Body (json)

on boolean

POST /api/devices/bluetooth/scan

Bluetooth Scan

Body (json)

on boolean

GET /api/devices/mixer

Get Mixer

PUT /api/devices/mixer/{channel}

Modifie le mixage et/ou l'égaliseur de la musique d'une sortie radio.

Path

channel string

Body (json)

mix object?
sound object?

GET /api/devices/routing

Get Routing

PUT /api/devices/routing

Choisit (ou efface) la sortie audio d'une sortie radio, ou change son repli quand la sortie est absente.

Body (json)

channel string
sink_id string?
fallback string?
clear boolean?

GET /api/devices/status

Get Status

POST /api/devices/system-settings

Ouvre l'écran de réglages correspondant SUR la machine (pour l'écran local ou la télécommande).

Body (json)

target string

GET /api/devices/topology

Graphe machine → sorties audio, Bluetooth, Wi-Fi, Ethernet, écrans et télécommandes Bobine.

GET /api/devices/wifi

Wifi Status

POST /api/devices/wifi/confirm

Wifi Confirm

POST /api/devices/wifi/connect

Wifi Connect

Body (json)

ssid string
password string?
acknowledge_disconnect boolean?

POST /api/devices/wifi/forget

Wifi Forget

Body (json)

ssid string
acknowledge_disconnect boolean?

POST /api/devices/wifi/power

Wifi Power

Body (json)

on boolean
acknowledge_disconnect boolean?

POST /api/devices/wifi/scan

Wifi Scan

/api/diagnostics

GET /api/diagnostics/import

État de la chaîne d'import : binaires, dossiers, exécuteur et tâches.

GET /api/diagnostics/system

État de santé de Bobine : `status` (`ok`, `warning`, `critical`, ou `unknown` si une sonde n'a pas pu répondre sans qu'aucun problème soit trouvé), `problems` triés par gravité, chacun `{code, severity, message, remedy}` avec un code stable, et `checks` (chaque sonde, même saine).

/api/display

GET /api/display/state

Get Display State

PUT /api/display/state

Put Display State

Body (json)

external_count integer
source string?
resolution string?

/api/health

GET /api/health

Contrôle de santé lisible par machine, consommé par le chien de garde `bobine-watchdog` (redémarrage auto d'un composant mort) et par toute supervision externe.

/api/import-jobs

GET /api/import-jobs

File d'attente des imports en direct : uploads web ET dossiers surveillés confondus, triés par ordre de création.

DELETE /api/import-jobs/{job_id}

Annule immédiatement une tâche d'importation en cours ou en attente, interrompt FFmpeg le cas échéant et supprime les fichiers temporaires.

Path

job_id string

/api/logs

GET /api/logs

Journaux en JSON stable, du plus récent au plus ancien.

Query

source string?
level string?
since string?
limit integer?

DELETE /api/logs/activity

Supprime des logs d'activité : par identifiants précis (sélection dans le tableau), les `limit` plus récents (purge), ou tout si aucun des deux n'est fourni (bouton "vider").

Query

ids integer[]?
limit integer?

GET /api/logs/activity

Log d'activité filtrable.

Query

event_type string?
limit integer?

GET /api/logs/activity/event-types

List Activity Event Types

DELETE /api/logs/technical

Vide le log technique.

GET /api/logs/technical

Log technique brut : erreurs backend, échecs de lecture, etc.

Query

lines integer?

GET /api/logs/technical/download

Téléchargement du log technique complet.

/api/media

GET /api/media

Médias de toutes les bibliothèques avec leur identifiant de lecture, filtrés et paginés.

Query

kind string?
video | playlist | audio | audio\-playlist | background | radio\-track | radio\-playlist
q string?
limit integer?
offset integer?

/api/metrics

GET /api/metrics/dashboard

Tableau de bord unifié des métriques club et télémétrie matérielle.

Query

period string?
7d | 30d | this_month | all
channel string?
all | cable | network

GET /api/metrics/hardware/history

Historique temporel d'une métrique matérielle (1h, 6h, 24h, 7j, 30j, mois en cours, tout l'historique conservé) avec statistiques et points échantillonnés.

Query

metric string?
period string?
1h | 6h | 24h | 7d | 30d | this_month | all

GET /api/metrics/ratings

Liste les évaluations récentes.

Query

video_id integer?
channel string?
limit integer?

POST /api/metrics/ratings

Enregistre l'évaluation 5 étoiles d'un cours vidéo.

Body (json)

video_id integer
rating integer
channel string?
source string?

POST /api/metrics/sessions/end

Clôture manuellement une session de lecture.

Body (json)

session_id integer
position_seconds number?
completed boolean?

POST /api/metrics/sessions/start

Démarre manuellement une session de lecture.

Body (json)

video_id integer
channel string?
launch_type string?
total_duration_seconds number?

/api/playback

DELETE /api/playback/interrupted

Abandonne la lecture interrompue du canal sans la relancer.

Query

channel string?

GET /api/playback/interrupted

Dernière action différée en attente de reprise/relance explicite depuis l'interface, POUR UN CANAL DONNÉ.

Query

channel string?

POST /api/playback/interrupted/resume

Relance l'action différée du canal : reprise à la position exacte pour une interruption par programmation, relance depuis zéro de la cible reportée par le mode coach.

Query

channel string?

GET /api/playback/state

Snapshot ponctuel de l'état de lecture d'UN canal (utile au premier rendu, avant connexion WebSocket).

Query

channel string?

POST /api/playback/{channel}/{action}

Commande de lecture d'un canal (`cable`, `network`) ; corps JSON : les paramètres de la commande WebSocket.

Path

channel string
action string

/api/playlists

GET /api/playlists

Liste toutes les playlists avec le nombre d'éléments, la durée totale et une miniature de repli (1er élément en ayant une).

POST /api/playlists

Crée une nouvelle playlist avec ses éléments.

Body (json)

name string
items object[]?

DELETE /api/playlists/{playlist_id}

Supprime la playlist (les éléments associés sont supprimés en cascade).

Path

playlist_id integer

GET /api/playlists/{playlist_id}

Détails d'une playlist avec ses éléments ordonnés et les métadonnées des vidéos associées.

Path

playlist_id integer

PUT /api/playlists/{playlist_id}

Met à jour le nom et/ou les éléments d'une playlist (remplace proprement la liste ordonnée des éléments).

Path

playlist_id integer

Body (json)

name string
items object[]?

POST /api/playlists/{playlist_id}/duplicate

Duplique une playlist existante (copie le nom en y ajoutant " (copie)" et clone ses éléments).

Path

playlist_id integer

/api/radio

GET /api/radio/albums

Albums dérivés par regroupement (album_artist, album).

GET /api/radio/announcement-rules

List Rules

POST /api/radio/announcement-rules

Create Rule

Body (json)

rule_type string
every_n_tracks | every_x_minutes | fixed_times
n_tracks integer?
interval_minutes integer?
times_of_day string[]?
enabled boolean?
target string?

DELETE /api/radio/announcement-rules/{rule_id}

Delete Rule

Path

rule_id integer

PUT /api/radio/announcement-rules/{rule_id}

Update Rule

Path

rule_id integer

Body (json)

rule_type string
every_n_tracks | every_x_minutes | fixed_times
n_tracks integer?
interval_minutes integer?
times_of_day string[]?
enabled boolean?
target string?

GET /api/radio/announcements

List Announcements

POST /api/radio/announcements/play-now

Déclenchement manuel — toujours en mode « duck » (fondu immédiat, la musique continue).

Body (json)

announcement_id integer?
target string?

POST /api/radio/announcements/upload

Import synchrone (un seul fichier + description obligatoire) : pas de job d'arrière-plan, contrairement aux morceaux — le traitement ffprobe/ffmpeg d'un unique fichier reste rapide.

Body (multipart)

file string
description string

POST /api/radio/announcements/upload-batch

Import groupé (plusieurs fichiers ou dossier entier) : traité en arrière-plan comme les morceaux — voir GET /api/import-jobs.

Body (multipart)

files string[]

DELETE /api/radio/announcements/{announcement_id}

Delete Announcement

Path

announcement_id integer

PUT /api/radio/announcements/{announcement_id}

Update Announcement

Path

announcement_id integer

Body (json)

description string?
enabled boolean?

GET /api/radio/announcements/{announcement_id}/stream

Flux audio d'un rappel.

Path

announcement_id integer

GET /api/radio/artists

Artistes dérivés par regroupement (album_artist sinon artist).

GET /api/radio/default-playlist

Ambiance par défaut de chaque sortie radio.

PUT /api/radio/default-playlist

Choisit l'ambiance par défaut d'UNE sortie radio (démarrage automatique, fin de fenêtre de planning, bascule de la sortie câblée sur Radio).

Body (json)

channel string
playlist_id integer?

GET /api/radio/playlists

List Playlists

POST /api/radio/playlists

Create Playlist

Body (json)

name string
track_ids integer[]?

DELETE /api/radio/playlists/{playlist_id}

Delete Playlist

Path

playlist_id integer

GET /api/radio/playlists/{playlist_id}

Get Playlist

Path

playlist_id integer

PUT /api/radio/playlists/{playlist_id}

Update Playlist

Path

playlist_id integer

Body (json)

name string
track_ids integer[]?

DELETE /api/radio/playlists/{playlist_id}/default

Retire le statut « par défaut » (plus aucune playlist d'ambiance).

Path

playlist_id integer

PUT /api/radio/playlists/{playlist_id}/default

Désigne la playlist d'ambiance par défaut : une seule à la fois, garantie applicativement.

Path

playlist_id integer

POST /api/radio/playlists/{playlist_id}/tracks

Ajoute un morceau à la fin de la playlist (bouton « ajouter à la playlist » depuis la vue Morceaux).

Path

playlist_id integer

Body (json)

track_id integer

GET /api/radio/sound

Réglages de son courants d'UNE sortie radio (réseau par défaut) : même valeur que le champ `sound` de l'état diffusé, pour les clients sans WebSocket.

Query

channel string?

PUT /api/radio/sound

Modifie les réglages de son d'UNE sortie radio.

Query

channel string?

GET /api/radio/state

Snapshot ponctuel de l'état d'UNE sortie radio.

Query

channel string?

GET /api/radio/tags

List Tags

POST /api/radio/tags

Create Tag

Body (json)

name string

DELETE /api/radio/tags/{tag_id}

Delete Tag

Path

tag_id integer

PUT /api/radio/tags/{tag_id}

Rename Tag

Path

tag_id integer

Body (json)

name string

GET /api/radio/tracks

Liste filtrable des morceaux (vue « Morceaux » + filtres artiste/album/ genre/tag des autres vues).

Query

q string?
artist string?
album string?
genre string?
tag string?

POST /api/radio/tracks/upload

Import multi-fichiers de morceaux (tous formats audio), traité en arrière-plan — voir GET /api/import-jobs.

Body (multipart)

files string[]

POST /api/radio/tracks/upload-zip

Import d'une archive ZIP de morceaux, traité en arrière-plan.

Body (multipart)

file string?
upload_id string?

DELETE /api/radio/tracks/{track_id}

Delete Track

Path

track_id integer

GET /api/radio/tracks/{track_id}

Get Track

Path

track_id integer

PUT /api/radio/tracks/{track_id}

Édition manuelle des métadonnées et des tags.

Path

track_id integer

Body (json)

title string?
artist string?
album string?
album_artist string?
track_number integer?
disc_number integer?
year integer?
genre string?
tags string[]?

GET /api/radio/tracks/{track_id}/cover

Pochette d'un morceau radio (JPEG normalisé, extrait ID3 ou uploadé).

Path

track_id integer

POST /api/radio/tracks/{track_id}/cover

Pochette fournie manuellement : remplace la pochette existante.

Path

track_id integer

Body (multipart)

file string

GET /api/radio/tracks/{track_id}/stream

Flux audio d'un morceau radio.

Path

track_id integer

POST /api/radio/{output}/{action}

Commande d'une sortie radio (`cable`, `network`) ; même contrat que `/api/playback/{channel}/{action}`.

Path

output string
action string

/api/schedule

GET /api/schedule

Liste des programmations, filtrable par canal de diffusion.

Query

channel string?

POST /api/schedule

Create Schedule

Body (json)

target_type string
video | playlist | radio_playlist
target_id integer
channel string?
schedule_type string
once | recurring
run_at string?
days_of_week integer[]?
time_of_day string?
active boolean?
end_time string?
is_24_7 boolean?

GET /api/schedule/next

Prochaine occurrence active à venir, récurrence et overrides résolus, pour le bloc « prochain cours » de l'écran d'attente.

Query

channel string?

GET /api/schedule/occurrences

Occurrences résolues (récurrence + overrides) dans [start, end], pour les vues planning calendrier/liste.

Query

start string
end string
channel string?

DELETE /api/schedule/{schedule_id}

Delete Schedule

Path

schedule_id integer

GET /api/schedule/{schedule_id}

Get Schedule

Path

schedule_id integer

PUT /api/schedule/{schedule_id}

Update Schedule

Path

schedule_id integer

Body (json)

target_type string
video | playlist | radio_playlist
target_id integer
channel string?
schedule_type string
once | recurring
run_at string?
days_of_week integer[]?
time_of_day string?
active boolean?
end_time string?
is_24_7 boolean?

POST /api/schedule/{schedule_id}/overrides

Create Override

Path

schedule_id integer

Body (json)

occurrence_date string
action string
cancelled | replaced
replacement_target_type string?
video | playlist | radio_playlist
replacement_target_id integer?

DELETE /api/schedule/{schedule_id}/overrides/{override_id}

Delete Override

Path

schedule_id integer
override_id integer

/api/settings

GET /api/settings

Get Settings

PUT /api/settings

Update Settings

Body (json)

wait_time_between_courses integer?
volume_default integer?
audio_chain_timer_seconds integer?
radio_announcement_fade_ms integer?
logs_retention_days integer?
default_coach_background_id integer?
theme string?
theme_mode string?
language string?
active_logo string?
update_channel string?
wired_display_mode string?
display_mode_setting string?
auto_update_enabled string?
auto_update_time string?
auto_web_rendition string?
media_native string?
update_tor string?
update_tor_proxy string?
simplified_ui string?

GET /api/settings/backup/export

Exporte une archive ZIP de sauvegarde contenant.

POST /api/settings/backup/restore

Restaure une sauvegarde depuis une archive ZIP uploadée.

Body (multipart)

file string

GET /api/settings/display-output

Sortie active des deux canaux : câblé (écran du Wyse) et réseau (tout autre appareil du LAN).

PUT /api/settings/display-output

Bascule un canal (câblé ou réseau) entre kiosk et cinéma, indépendamment de l'autre.

Body (json)

channel string
output string

GET /api/settings/laptop-lid

Vérifie si la machine a un capot et renvoie le réglage actuel.

POST /api/settings/laptop-lid

Active ou désactive la mise en veille à la fermeture du capot.

Body (json)

prevent_sleep boolean

POST /api/settings/logs/purge

Purge manuelle des journaux d'activité et historiques de métriques.

Query

retention_days integer?

GET /api/settings/media-native

État réel du composant audio natif : désactivé, actif, en repli ou absent.

POST /api/settings/open-path

Ouvre un dossier de données Bobine dans le gestionnaire de fichiers natif de l'OS (xdg-open, explorer, open).

Body (json)

path string

GET /api/settings/storage

Indicateur de capacité de stockage : espace disque du volume qui héberge les médias (total / utilisé / libre) et empreinte propre de l'application (somme des dossiers de médias).

GET /api/settings/system

Charge CPU, GPU, RAM, Températures, Puissance (W), Modèles des composants et Runtime.

POST /api/settings/system/reset

Réinitialisation complète : force le rechargement de tous les écrans connectés puis redémarre le kiosk et le backend.

POST /api/settings/system/reset-data

Remise à zéro d'usine : médias, journaux et base de données.

Body (json)

confirm string

POST /api/settings/system/restart

Redémarrage simple (sans effacer de données), par exemple pour appliquer un changement de langue.

POST /api/settings/system/uninstall

Remise à zéro complète de la machine.

Body (json)

confirm string

/api/storage

GET /api/storage/advisor/format

Système de fichiers conseillé selon l'OS hôte et les OS qui brancheront le support.

Query

host string?
others string?
media string?
legacy boolean?

GET /api/storage/format/active

Format Active

POST /api/storage/format/execute

Format Execute

Body (json)

key string
token string?
fs string
label string
confirm string?
acknowledged boolean?

DELETE /api/storage/format/jobs/{job_id}

Annule AVANT le point de non-retour (aucun effacement n'a eu lieu) ; refusé ensuite.

Path

job_id string

GET /api/storage/format/jobs/{job_id}

Format Job

Path

job_id string

POST /api/storage/format/plan

Plan de formatage : n'écrit RIEN.

Body (json)

key string
travels string[]?

GET /api/storage/portable

Portable

POST /api/storage/portable/{device_id}/mount

Portable Mount

Path

device_id string

POST /api/storage/portable/{device_id}/unmount

Portable Unmount

Path

device_id string

PUT /api/storage/settings

Valeurs par défaut des réglages de longévité (supports non enregistrés et nouveaux supports).

Body (json)

read_only boolean?
noatime boolean?
noexec boolean?
standby_minutes integer?
smart_monitor boolean?
auto_mount_library boolean?

GET /api/storage/status

Status

GET /api/storage/volumes

Volumes

GET /api/storage/volumes/{key}/browse

Browse

Path

key string

Query

path string?
offset integer?
limit integer?
show_hidden boolean?
media_only boolean?

POST /api/storage/volumes/{key}/eject

Eject

Path

key string

POST /api/storage/volumes/{key}/export

Copie de médias locaux vers le support : remontage en écriture temporaire et explicite, puis retour en lecture seule.

Path

key string

Body (json)

kind string
ids integer[]
dest string?

GET /api/storage/volumes/{key}/health

Health

Path

key string

Query

refresh boolean?

POST /api/storage/volumes/{key}/import

Copie vérifiée vers le stockage local puis importeur existant ; suivi par `GET /api/import-jobs`.

Path

key string

Body (json)

entries object[]
kind string
force boolean?

POST /api/storage/volumes/{key}/index

« Utiliser comme extension » : indexe les médias sélectionnés sans les copier (lecture directe, lecture seule).

Path

key string

Body (json)

entries object[]
kind string
force boolean?

DELETE /api/storage/volumes/{key}/library

Unregister Library

Path

key string

Query

purge boolean?

POST /api/storage/volumes/{key}/library

Register Library

Path

key string

Body (json)

nickname string?

POST /api/storage/volumes/{key}/mount

Mount

Path

key string

Body (json)

mode string?

PUT /api/storage/volumes/{key}/settings

Update Volume Settings

Path

key string

Body (json)

read_only boolean?
noatime boolean?
noexec boolean?
standby_minutes integer?
smart_monitor boolean?
auto_mount_library boolean?

POST /api/storage/volumes/{key}/trim

Trim

Path

key string

POST /api/storage/volumes/{key}/unmount

Unmount

Path

key string

/api/time

GET /api/time

Retourne l'heure serveur en millisecondes Unix.

/api/updates

POST /api/updates/_android-callback

Rappel interne (boucle locale uniquement, jamais exposé au delà de 127.0.0.1 par la configuration réseau du profil Android) : `UpdateManager.

Body (json)

status string
message string?
percent integer?

POST /api/updates/acknowledge

Acquitte le cycle de mise à jour courant.

POST /api/updates/apply

Déclenche la mise à jour du système en tâche de fond.

GET /api/updates/check

Vérifie la disponibilité d'une nouvelle release officielle sur GitHub, en respectant le canal choisi dans Réglages → Mises à jour (Stable, Bêta ou Canary).

Query

refresh boolean?

GET /api/updates/status

État courant (ou dernier connu) du pipeline de mise à jour.

POST /api/updates/store/complete

Build Google Play : installe la mise à jour téléchargée (l'application redémarre).

POST /api/updates/store/open

Build Google Play : ouvre la fiche de l'application dans Google Play.

POST /api/updates/store/start

Build Google Play : lance la mise à jour par Google Play (téléchargement en arrière-plan).

POST /api/updates/tor-check

Vérifie par le service de contrôle de Tor que les mises à jour sortiraient bien par Tor.

Body (json)

proxy string?

/api/uploads

POST /api/uploads

Create Upload

Body (json)

filename string
size integer
fingerprint string?

DELETE /api/uploads/{upload_id}

Cancel Upload

Path

upload_id string

GET /api/uploads/{upload_id}

Get Upload

Path

upload_id string

PATCH /api/uploads/{upload_id}

Append Chunk

Path

upload_id string

/api/videos

GET /api/videos

Récupère la liste des vidéos de la bibliothèque avec filtres et tris.

Query

search string?
program string?
release string?
sort_by string?
imported_at | title | duration
order string?
asc | desc

GET /api/videos/programs

Catégories (programmes) réellement présentes dans la bibliothèque, triées.

POST /api/videos/upload

Upload une vidéo en HTTP et enregistre une tâche d'import suivie en arrière-plan (normalisation automatique si requise) — voir `_run_video_import_job` et `GET /api/import-jobs`.

Body (multipart)

file string?
upload_id string?
title string?
program string?
release string?
description string?
subtitles string[]?

POST /api/videos/upload-zip

Import d'une archive (ZIP ou tar) de vidéos : un cours par fichier, en une seule tâche.

Body (multipart)

file string?
upload_id string?

DELETE /api/videos/{video_id}

Supprime physiquement les fichiers de la vidéo et de sa miniature, puis supprime son entrée en BDD.

Path

video_id integer

GET /api/videos/{video_id}

Récupère les détails d'une vidéo spécifique.

Path

video_id integer

PUT /api/videos/{video_id}

Met à jour les métadonnées modifiables d'une vidéo (titre, programme, release).

Path

video_id integer

Body (json)

title string?
program string?
release string?
description string?

GET /api/videos/{video_id}/chapters

List Chapters

Path

video_id integer

PUT /api/videos/{video_id}/chapters

Remplace tous les chapitres du cours (liste vide = les supprimer).

Path

video_id integer

Body (json)

chapters object[]

GET /api/videos/{video_id}/chapters/export

Chapitres au format d'import JSON (téléchargeable).

Path

video_id integer

POST /api/videos/{video_id}/chapters/from-file

Lit les chapitres incorporés à la vidéo (MKV, MP4) et remplace ceux du cours.

Path

video_id integer

POST /api/videos/{video_id}/chapters/import

Importe un fichier de chapitres (.json, .vtt ou texte « 05:00 Titre ») et remplace ceux du cours.

Path

video_id integer

Body (multipart)

file string

POST /api/videos/{video_id}/normalize

Déclenche manuellement la normalisation d'une vidéo si elle n'est pas Direct Play.

Path

video_id integer

GET /api/videos/{video_id}/stream

Flux d'une vidéo, avec négociation de la version lisible.

Path

video_id integer

Query

profile string?
accept string?

GET /api/videos/{video_id}/subtitles

Liste les pistes de sous-titres associées à une vidéo.

Path

video_id integer

POST /api/videos/{video_id}/subtitles

Importe un fichier .srt ou .vtt pour une vidéo, le convertit en WebVTT si nécessaire et l'enregistre.

Path

video_id integer

Body (multipart)

file string
language_code string?
language_label string?

DELETE /api/videos/{video_id}/subtitles/{subtitle_id}

Supprime une piste de sous-titres sur disque et en base.

Path

video_id integer
subtitle_id integer

GET /api/videos/{video_id}/subtitles/{subtitle_id}/vtt

Sert le fichier WebVTT pour les balises HTML5 <track> avec les bons en-têtes CORS et Content-Type.

Path

video_id integer
subtitle_id integer

PUT /api/videos/{video_id}/thumbnail

Miniature manuelle.

Path

video_id integer

Body (multipart)

file string

DELETE /api/videos/{video_id}/web-rendition

Delete Web Rendition

Path

video_id integer

POST /api/videos/{video_id}/web-rendition

Lance la production de la version « lisible partout » (H.264 8 bits, ≤ 1080p, AAC) — suivie via `GET /api/import-jobs`, état dans `web_status`.

Path

video_id integer