Passer au contenu principal

VIDÉO À VENIR

Démarrer avec Avala

5-6 min • Configuration de la clé API, installation du SDK, premier appel API

Prérequis : Vous avez besoin d’un compte Avala. Inscrivez-vous sur avala.ai ou créez-en un par programmation avec le SDK (voir ci-dessous), puis créez une clé API dans Paramètres > Sécurité.
pip install avala

from avala import Client

client = Client(api_key="avk_your_api_key")

for dataset in client.datasets.list():
    print(dataset.name, dataset.item_count)
C’est tout. Ci-dessous, un guide étape par étape de ce qui se passe et de ce que vous pouvez faire ensuite.

​
Créer un compte

Vous pouvez vous inscrire sur avala.ai ou créer un compte par programmation. La fonction signup du SDK ne nécessite pas de clé API — elle en retourne une en cas de succès. 
from avala import signup

result = signup(email="dev@acme.com", password="SecurePass123!")
print(f"API Key: {result.api_key}")

​
Obtenir votre clé API

  1. Connectez-vous à Mission Control.
  2. Allez dans Paramètres > Sécurité.
  3. Cliquez sur Créer une clé API, donnez-lui un nom, sélectionnez les portées et copiez la clé.
Les clés API ne sont affichées qu’une seule fois lors de la création. Stockez-la dans un endroit sécurisé avant de fermer la boîte de dialogue.
Définissez-la comme variable d’environnement pour que tous les SDKs et le CLI la récupèrent automatiquement : 
export AVALA_API_KEY="avk_your_api_key"

​
Lister les jeux de données

from avala import Client

client = Client()  # reads AVALA_API_KEY from env

for dataset in client.datasets.list():
    print(f"{dataset.name} — {dataset.item_count} items")

​
Lister les projets

for project in client.projects.list():
    print(f"{project.name} ({project.status})")

​
Créer un export

export = client.exports.create(project="proj_uid_here")
print(f"Export {export.uid}: {export.status}")
Les exports s’exécutent de manière asynchrone. Interrogez le statut avec client.exports.get(uid) ou vérifiez avala exports get <uid> jusqu’à la fin.

​
Vérifier l’utilisation du quota de requêtes

Les SDKs exposent les en-têtes de limitation de débit de chaque réponse : 
info = client.rate_limit_info
print(f"{info['remaining']}/{info['limit']} requests remaining")
print(f"Resets at: {info['reset']}")

​
Prochaines étapes

Python SDK

Support asynchrone, pagination, gestion des erreurs et annotations de type complètes.

TypeScript SDK

Zéro dépendance. Fonctionne dans Node.js, Deno et Bun.

Référence CLI

Gérez les jeux de données, projets, exports et le stockage depuis votre terminal.

Webhooks

Recevez des notifications en temps réel pour les événements de jeux de données, exports et tâches.

Serveur MCP

Utilisez Avala avec Claude, Cursor et VS Code via les assistants IA.

Référence API

Référence complète des endpoints avec les schémas de requêtes et réponses.