aethexDocs

Référence API

API Enregistrements

Lisez et gérez les enregistrements d'appels produits par les sessions vocales terminées. Chaque enregistrement est un unique fichier WAV. Les octets ne transitent jamais par l'API ; GET /recordings/{id}/audio retourne une URL de téléchargement signée de courte durée. Utilisez la portée recordings:read pour les lectures et recordings:write pour la suppression.

URL de base
https://api.aethexai.com/api/v1
Endpoints
4
Portées
recordings:readrecordings:write
GET/recordings

Parcourir tous les enregistrements du compte, du plus récent au plus ancien.

Lister les enregistrements

Retourne une liste paginée des enregistrements appartenant au compte appelant, ordonnée par created_at DESC. Chaque ligne contient : durée, taille, ID d'appel associé, et statut (ready une fois le WAV uploadé).

Chemin & Requête

2
  • offsetintegeroptionnel

    Nombre de résultats à ignorer. Doit être >= 0. Par défaut 0.

  • limitintegeroptionnel

    Nombre maximum de résultats. Doit être dans [1, 1000]. Par défaut 50.

Erreurs

3
401Non autorisé

Clé API manquante ou invalide sur la requête.

Envoyez X-API-Key: YOUR_KEY avec une clé ayant la portée recordings:read.

403Interdit

La clé API n'a pas la portée recordings:read.

Émettez une clé avec recordings:read (et recordings:write pour la suppression).

422Entité non traitable

offset est négatif ou limit est hors de [1, 1000].

Envoyez offset >= 0 et 1 <= limit <= 1000.

GET/recordings/:recording_id

Récupérer les métadonnées d'un enregistrement par ID.

Obtenir un enregistrement

Retourne un seul enregistrement par ID. Les recherches inter-comptes retournent 404. Pour télécharger l'audio, appelez GET /recordings/{id}/audio.

Chemin & Requête

1
  • recording_idstring (uuid)requis

    L'UUID de l'enregistrement.

Erreurs

4
401Non autorisé

Clé API manquante ou invalide.

Envoyez X-API-Key: YOUR_KEY.

403Interdit

La clé API n'a pas la portée recordings:read.

Émettez une clé avec recordings:read.

404Introuvable

Aucun enregistrement avec cet ID n'existe pour ce compte.

Vérifiez le recording_id dans GET /recordings.

422Entité non traitable

recording_id n'est pas un UUID valide.

Passez l'UUID exactement tel que retourné par GET /recordings.

GET/recordings/:recording_id/audio

Retourne une URL de téléchargement signée valable 1 heure pour le WAV.

Obtenir l'URL audio

Génère une URL de téléchargement signée valable 3600 secondes. Utilisez-la avec n'importe quel client HTTP ; aucun en-tête d'auth Aethex n'est nécessaire sur l'URL elle-même. Nécessite toujours la portée recordings:read pour la génération.

Chemin & Requête

1
  • recording_idstring (uuid)requis

    L'UUID de l'enregistrement.

Erreurs

5
401Non autorisé

Clé API manquante ou invalide.

Envoyez X-API-Key: YOUR_KEY sur l'appel API.

403Interdit

La clé API n'a pas la portée recordings:read.

Émettez une clé avec recordings:read.

404Introuvable

Aucun enregistrement avec cet ID n'existe pour ce compte.

Confirmez le recording_id via GET /recordings.

410URL expirée

L'URL de téléchargement a expiré (une heure après émission).

Appelez à nouveau GET /recordings/{id}/audio pour générer une nouvelle URL.

502Impossible de générer l'URL

Une défaillance transitoire a empêché la génération de l'URL signée.

Réessayez. Si cela persiste, contactez [email protected].

DELETE/recordings/:recording_id

Supprimer définitivement un enregistrement de votre compte.

Supprimer un enregistrement

Supprime définitivement un enregistrement. Après cela, il n'apparaît plus dans GET /recordings et ne peut plus être téléchargé. Nécessite la portée recordings:write.

Chemin & Requête

1
  • recording_idstring (uuid)requis

    L'UUID de l'enregistrement.

Erreurs

4
401Non autorisé

Clé API manquante ou invalide.

Envoyez X-API-Key: YOUR_KEY.

403Interdit

La clé API n'a pas la portée recordings:write.

Émettez une clé avec recordings:write (séparée de recordings:read).

404Introuvable

Aucun enregistrement avec cet ID n'existe pour ce compte.

Confirmez le recording_id via GET /recordings avant de réessayer.

422Entité non traitable

recording_id n'est pas un UUID valide.

Passez l'UUID exactement tel que retourné par GET /recordings.