Saltar al contenido principal
El Python SDK requiere Python 3.9+.

​
Instalación

pip install avala

​
Inicio rápido

from avala import Client

client = Client(api_key="your-api-key")

# List all datasets
datasets = client.datasets.list()
for dataset in datasets:
    print(dataset.name, dataset.uid)

​
Crear una cuenta

La función signup crea una nueva cuenta de Avala y devuelve una API key. No requiere autenticación. 
from avala import signup

result = signup(
    email="dev@acme.com",
    password="SecurePass123!",
    first_name="Jane",       # optional
    last_name="Doe",         # optional
)

print(f"User: {result.user.email}")
print(f"API Key: {result.api_key}")
También está disponible una variante asíncrona: 
from avala import async_signup

result = await async_signup(email="dev@acme.com", password="SecurePass123!")

​
Autenticación

El SDK se autentica usando su API key de Avala, que se envía a través del encabezado X-Avala-Api-Key en cada solicitud. Puede proporcionar la clave directamente o dejar que el SDK la lea del entorno. Opción 1: Pasar la clave directamente 
from avala import Client

client = Client(api_key="your-api-key")
Opción 2: Usar una variable de entorno 
export AVALA_API_KEY="your-api-key"

from avala import Client

# Automatically reads AVALA_API_KEY from the environment
client = Client()

​
Soporte async

El SDK incluye un cliente completamente asíncrono construido sobre httpx. Use AsyncClient para E/S sin bloqueo en aplicaciones asíncronas. 
import asyncio
from avala import AsyncClient

async def main():
    client = AsyncClient(api_key="your-api-key")

    datasets = await client.datasets.list()
    for dataset in datasets:
        print(dataset.name)

    # Always close the client when done, or use it as a context manager
    await client.close()

asyncio.run(main())
Usando el context manager asíncrono: 
import asyncio
from avala import AsyncClient

async def main():
    async with AsyncClient() as client:
        datasets = await client.datasets.list()
        for dataset in datasets:
            print(dataset.name)

asyncio.run(main())

​
Trabajar con datasets

El Python SDK es actualmente solo lectura para datasets — puede listar, obtener y explorar elementos pero no crear ni eliminar datasets. Use la REST API para subidas y mutaciones.

​
Listar datasets

datasets = client.datasets.list()

for dataset in datasets:
    print(f"{dataset.name} ({dataset.uid})")
    print(f"  Items: {dataset.item_count}")
    print(f"  Created: {dataset.created_at}")

​
Obtener un dataset

dataset = client.datasets.get("550e8400-e29b-41d4-a716-446655440000")

print(dataset.name)
print(dataset.slug)
print(dataset.item_count)

​
Trabajar con proyectos

​
Listar proyectos

projects = client.projects.list()

for project in projects:
    print(f"{project.name} ({project.uid})")
    print(f"  Status: {project.status}")
    print(f"  Created: {project.created_at}")

​
Obtener un proyecto

project = client.projects.get("770a9600-a40d-63f6-c938-668877660000")

print(project.name)
print(project.status)

​
Trabajar con tareas

​
Listar tareas

tasks = client.tasks.list(project="770a9600-a40d-63f6-c938-668877660000", status="pending")

for task in tasks:
    print(f"{task.uid} — {task.name} ({task.status})")

​
Obtener una tarea

task = client.tasks.get("990c1800-b62f-85a8-e150-880099880000")

print(task.name)
print(task.status)

​
Trabajar con exportaciones

El Python SDK soporta operaciones CRUD completas para agentes, webhooks, configuraciones de almacenamiento, proveedores de inferencia, objetivos de calidad, configuración de consenso y organizaciones. Los datasets y proyectos son actualmente solo lectura — use la REST API para mutaciones en esos recursos.

​
Crear una exportación

export = client.exports.create(project="770a9600-a40d-63f6-c938-668877660000")

print(f"Export started: {export.uid}")
print(f"Status: {export.status}")

​
Consultar hasta completar

import time

export = client.exports.create(project="770a9600-a40d-63f6-c938-668877660000")

while export.status != "completed":
    time.sleep(2)
    export = client.exports.get(export.uid)
    print(f"Status: {export.status}")

print(f"Download: {export.download_url}")

​
Trabajar con organizaciones

​
Listar organizaciones

orgs = client.organizations.list()
for org in orgs:
    print(f"{org.name} ({org.slug})")

​
Crear una organización

org = client.organizations.create(name="My Team", visibility="private", industry="technology")
print(f"Created: {org.name} ({org.uid})")

​
Gestionar miembros

members = client.organizations.list_members("my-team")
for member in members:
    print(f"{member.full_name} - {member.role}")

​
Trabajar con slices

​
Listar slices

slices = client.slices.list("my-org")
for s in slices:
    print(f"{s.name}: {s.item_count} items")

​
Explorar elementos del dataset

​
Listar elementos de un dataset

items = client.datasets.list_items("my-org", "my-dataset")
for item in items:
    print(f"{item.uid}: {item.key}")

​
Listar secuencias

sequences = client.datasets.list_sequences("my-org", "my-dataset")
for seq in sequences:
    print(f"{seq.uid}: {seq.key} ({seq.number_of_frames} frames)")

​
Type hints

El SDK está completamente tipado. Todos los objetos de respuesta son modelos Pydantic con anotaciones de tipo completas, proporcionándole autocompletado y verificación de tipos de forma inmediata. 
from avala.types import Dataset, Project, Export, Task

def process_dataset(dataset: Dataset) -> None:
    print(dataset.name)        # str
    print(dataset.uid)         # str
    print(dataset.item_count)  # int
    print(dataset.created_at)  # Optional[datetime]

def process_task(task: Task) -> None:
    print(task.uid)            # str
    print(task.name)           # Optional[str]
    print(task.status)         # Optional[str]
    print(task.project)        # Optional[str]

​
Manejo de errores

El SDK lanza excepciones tipadas para que pueda manejar diferentes modos de fallo con precisión. 
from avala import Client
from avala.errors import (
    AvalaError,
    NotFoundError,
    RateLimitError,
    ValidationError,
)

client = Client()

try:
    dataset = client.datasets.get("nonexistent")
except NotFoundError as e:
    print(f"Dataset not found: {e.message}")
except RateLimitError as e:
    print(f"Rate limited. Retry after {e.retry_after} seconds.")
except ValidationError as e:
    print(f"Invalid request: {e.message}")
    for detail in e.details:
        print(f"  - {detail}")
except AvalaError as e:
    # Catch-all for any other Avala API error
    print(f"API error ({e.status_code}): {e.message}")
ExcepciónDescripción
AvalaErrorExcepción base para todos los errores de la API de Avala.
AuthenticationErrorAPI key inválida o faltante (HTTP 401).
NotFoundErrorEl recurso solicitado no existe (HTTP 404).
RateLimitErrorHa excedido el límite de tasa de la API (HTTP 429). Incluye un atributo retry_after.
ValidationErrorLa carga de la solicitud falló en la validación (HTTP 400/422). Incluye un atributo details con errores a nivel de campo.
ServerErrorEl servidor devolvió un error interno (HTTP 5xx).

​
Paginación

Los métodos de listado devuelven un objeto CursorPage. Puede iterar directamente sobre los elementos o controlar la paginación manualmente. 
# Iterate through items on the current page
for dataset in client.datasets.list():
    print(dataset.name)

# Manual pagination — control page size and access cursor
page = client.datasets.list(limit=10)
for dataset in page.items:
    print(dataset.name)

# Fetch the next page
if page.has_more:
    next_page = client.datasets.list(limit=10, cursor=page.next_cursor)

​
Gestión de flotas

La gestión de flotas está en vista previa. Las APIs descritas aquí pueden cambiar.
El namespace fleet proporciona acceso al registro de dispositivos, grabaciones, eventos, reglas y alertas. 
# List online devices
devices = client.fleet.devices.list(status="online")

# Create a timeline event on a recording
event = client.fleet.events.create(
    recording_id="rec_abc123",
    timestamp="2026-01-15T10:30:00Z",
    type="anomaly",
    label="Gripper force spike",
    metadata={"force_n": 45.2}
)

# Create a recording rule
rule = client.fleet.rules.create(
    name="High Latency Alert",
    condition={"type": "threshold", "topic": "/diagnostics/latency", "field": "data.value", "operator": "gt", "value": 100},
    actions=[{"type": "tag", "value": "high-latency"}, {"type": "notify", "channel_id": "ch_your_channel_id"}]
)
Consulte la guía del Panel de flota para ejemplos completos.

​
Configuración

Puede personalizar el comportamiento del cliente en el momento de la inicialización. 
from avala import Client

client = Client(
    api_key="your-api-key",
    base_url="https://api.avala.ai/api/v1",  # Default
    timeout=60,        # Request timeout in seconds (default: 30)
    max_retries=3,     # Number of retries on transient errors (default: 2)
)
ParámetroTipoValor por defectoDescripción
api_keystrVariable de entorno AVALA_API_KEYSu API key de Avala.
base_urlstrhttps://api.avala.ai/api/v1La URL base de la API.
timeoutfloat30Tiempo de espera de solicitud en segundos.
max_retriesint2Número de reintentos automáticos en fallos transitorios (5xx, timeouts).