Saltar al contenido principal

VIDEO PRÓXIMAMENTE

Comenzando con Avala

5-6 min • Configuración de API key, instalación del SDK, primera llamada a la API

Requisitos previos: Necesita una cuenta de Avala. Regístrese en avala.ai o cree una de forma programática con el SDK (ver a continuación), luego cree una API key en Configuración > Seguridad.
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)
Eso es todo. A continuación se presenta un recorrido paso a paso de lo que está sucediendo y lo que puede hacer después.

​
Crear una cuenta

Puede registrarse en avala.ai o crear una cuenta de forma programática. La función signup del SDK no requiere una API key — devuelve una al completarse exitosamente. 
from avala import signup

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

​
Obtener su API Key

  1. Inicie sesión en Mission Control.
  2. Vaya a Configuración > Seguridad.
  3. Haga clic en Crear API Key, asígnele un nombre, seleccione los alcances y copie la clave.
Las API keys se muestran solo una vez al momento de su creación. Guárdela en un lugar seguro antes de cerrar el diálogo.
Configúrela como variable de entorno para que todos los SDKs y el CLI la detecten automáticamente: 
export AVALA_API_KEY="avk_your_api_key"

​
Listar datasets

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")

​
Listar proyectos

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

​
Crear una exportación

export = client.exports.create(project="proj_uid_here")
print(f"Export {export.uid}: {export.status}")
Las exportaciones se ejecutan de forma asíncrona. Consulte el estado con client.exports.get(uid) o verifique avala exports get <uid> hasta que se complete.

​
Verificar uso de límite de tasa

Los SDKs exponen los encabezados de límite de tasa de cada respuesta: 
info = client.rate_limit_info
print(f"{info['remaining']}/{info['limit']} requests remaining")
print(f"Resets at: {info['reset']}")

​
Próximos pasos

Python SDK

Soporte async, paginación, manejo de errores y type hints completos.

TypeScript SDK

Cero dependencias. Funciona en Node.js, Deno y Bun.

Referencia del CLI

Gestione datasets, proyectos, exportaciones y almacenamiento desde su terminal.

Webhooks

Reciba notificaciones en tiempo real para eventos de dataset, exportación y tareas.

Servidor MCP

Use Avala con Claude, Cursor y VS Code a través de asistentes de IA.

Referencia de la API

Referencia completa de endpoints con esquemas de solicitud y respuesta.