Démarrage rapide

Ce tutoriel vous guide pour envoyer votre première vidéo à l’API Gaard Vision et récupérer le résultat de classification. À la fin, vous disposerez d’un appel API fonctionnel que vous pourrez adapter à votre intégration.

Prérequis

• Un compte Gaard avec accès API
• curl installé sur votre machine
• Un fichier vidéo à classifier (MP4 ou MOV)

1. Obtenir votre jeton API

   Créez un jeton API dans l’application Gaard à Paramètres > Plateforme > Intégrations.

   Une fois le jeton obtenu, exportez-le en tant que variable d’environnement pour que les commandes de ce tutoriel puissent le référencer :

   terminal

   export API_KEY="your-api-token"

2. Obtenir une vidéo d’exemple

   Si vous n’avez pas de fichier vidéo sous la main, téléchargez notre clip d’exemple ou récupérez-en un depuis le dataset VIRAT.

   video.mp4

   Enregistrez le fichier vidéo dans votre répertoire de travail. Les exemples ci-dessous supposent que le fichier s’appelle video.mp4.

3. Envoyer une vidéo pour classification

   L’endpoint de classification accepte une requête POST multipart/form-data. Vous envoyez le fichier vidéo en tant que champ de formulaire avec -F, et non comme une charge utile JSON.

Mode asynchrone (par défaut)

Par défaut, la classification s’exécute de manière asynchrone. L’API accepte la vidéo et renvoie un identifiant que vous utilisez pour interroger le résultat.

Optionnel

Clonez le dépôt gaard-api-docs pour accéder aux scripts utilitaires affichés dans l’onglet bash.

curlbash

terminal

curl -X POST https://vision.gaard.ai/api/classify \
  -H "Authorization: Bearer $API_KEY" \
  -F "video=@video.mp4"

La réponse contient l’identifiant de classification et un horodatage :

{
  "id": "66436fc66d24ab9cf81140eb",
  "accepted_at": "2024-05-14T16:05:58.444Z"
}

Utilisez la valeur id pour récupérer le résultat :

curlbash

terminal

curl https://vision.gaard.ai/api/result/66436fc66d24ab9cf81140eb \
  -H "Authorization: Bearer $API_KEY"

Si la classification est encore en cours de traitement, interrogez cet endpoint à nouveau après quelques secondes jusqu’à ce que le résultat soit disponible.

Mode synchrone

Si vous préférez attendre le résultat en une seule requête, ajoutez ?sync=true. L’API bloque jusqu’à ce que la classification soit terminée et renvoie directement le résultat complet.

curlbash

terminal

curl -X POST "https://vision.gaard.ai/api/classify?sync=true" \
  -H "Authorization: Bearer $API_KEY" \
  -F "video=@video.mp4"

Ajout de métadonnées (optionnel)

Vous pouvez joindre un fichier JSON de métadonnées en même temps que la vidéo pour fournir un contexte supplémentaire, comme les identifiants de site et de caméra. Créez un fichier nommé metadata.json :

{
  "site_id": "134188",
  "camera_id": "VI01"
}

Puis incluez-le dans la requête comme second champ de formulaire :

curlbash

terminal

curl -X POST https://vision.gaard.ai/api/classify \
  -H "Authorization: Bearer $API_KEY" \
  -F "video=@video.mp4" \
  -F "metadata=@metadata.json"

Et ensuite

Maintenant que vous avez classifié une vidéo avec succès, explorez le reste de l’API :

• Endpoints — référence complète des endpoints pour classifier, récupérer, annoter et supprimer
• Structure de la réponse — comprendre les champs d’une réponse de classification
• Résultat de classification — types de résultats, statuts et exemples détaillés
• Métadonnées — le format complet des métadonnées et les champs disponibles
• Webhooks — recevoir les résultats asynchrones par webhook au lieu d’interroger l’API