Integrations

Documentation de l'API et du SDK ScreenApp

L'API ScreenApp vous permet de transcrire, de résumer et d'analyser automatiquement le contenu vidéo et audio

Choisir la bonne version de l’API

L’application actuelle utilise l’API /app/api/v1. Les intégrations plus anciennes peuvent utiliser le service distinct api.screenapp.io/v2. Leurs endpoints, identifiants et flux d’import ne sont pas interchangeables.

Avant de modifier une intégration existante, identifiez son URL de base et la génération de compte concernée. Pour une intégration historique, consultez sa référence v2 et confirmez avec ScreenApp que la migration est prise en charge.

Créer une clé pour l’application actuelle

Ouvrez Paramètres > API dans l’application actuelle. Créez une clé nommée avec les scopes les plus restreints possibles et enregistrez-la quand elle s’affiche. Traitez-la comme un secret et révoquez-la si elle est exposée. Vérifiez le contexte personnel ou d’équipe associé à la clé.

Les scopes publics actuels sont files:read and files:upload.

Lire le contexte de votre compte

Définissez SCREENAPP_API_KEY en privé dans votre environnement. Ne la placez pas dans du HTML côté client et ne la committez pas dans un dépôt.

curl --fail-with-body "https://screenapp.io/app/api/v1/me"   -H "x-api-key: $SCREENAPP_API_KEY"

Importer un fichier

Utilisez une clé avec la permission d’import. Remplacez le nom du fichier local par le vôtre.

curl --fail-with-body "https://screenapp.io/app/api/v1/videos"   -H "x-api-key: $SCREENAPP_API_KEY"   -F "file=@recording.mp4"

La réponse contient l’identifiant du nouveau fichier. Le traitement se poursuit en arrière-plan. Interrogez GET /app/api/v1/videos/{id} jusqu’à ce que transcriptStatus vaille ready, puis appelez GET /app/api/v1/videos/{id}/transcript.

Les imports directs par l’API actuelle ont une limite de corps de requête de 512 MB. C’est une limite de l’API uniquement : les imports dans l’application n’ont pas de limite de taille de fichier fixe. Le même endpoint videos accepte aussi un objet JSON avec une url publique au lieu d’envoyer des octets locaux.

Lire les enregistrements

  • GET /app/api/v1/videos liste les enregistrements de l’espace de la clé.
  • GET /app/api/v1/videos/{id} renvoie le statut et les métadonnées.
  • GET /app/api/v1/videos/{id}/transcript renvoie la transcription quand elle est prête.

Utilisez la permission de lecture pour ces requêtes. Une clé absente ou invalide renvoie 401, un scope insuffisant renvoie 403 et une limitation de débit renvoie 429. Respectez Retry-After quand il est fourni. Une transcription demandée avant d’être prête peut renvoyer 409.

Intégrer un enregistreur

L’intégration a sa propre configuration et une restriction de domaine. Suivez intégrer un enregistreur. N’exposez jamais une clé REST privée comme jeton d’intégration.

Ces exemples décrivent le contrat actuel de l’API. Vérifiez-les dans le compte et l’environnement que vous comptez utiliser avant de remplacer une intégration historique qui fonctionne.