Installation
Get started with pip, Poetry, or uv
Quickstart
Initialize the client and run your first API calls
Authentication
Configure your API key and secure access
API Reference
Explore all available resources and methods
Key features
Type-safe API
Built with Pydantic models for runtime validation and excellent editor support
Async support
Use
AsyncClient for high-performance concurrent operationsAutomatic pagination
Iterate through large result sets with cursor-based pagination
Built-in error handling
Comprehensive error hierarchy for authentication, rate limits, and validation
Configurable retries
Automatic retry logic with exponential backoff for transient failures
CLI included
Command-line interface for quick dataset inspection and export creation
What you can build
Dataset management
Dataset management
Create, list, and inspect annotation datasets. Filter by data type, status, or visibility. Access dataset items and sequences programmatically.
Project workflows
Project workflows
Browse annotation projects, retrieve project details, and integrate project data into your ML pipelines.
Export automation
Export automation
Create exports for datasets or projects, monitor export status, and download annotation data in standard formats.
Task tracking
Task tracking
Query annotation tasks with filters for project, status, or assignee. Monitor progress and completion rates.
Auto-labeling pipelines
Auto-labeling pipelines
Configure inference providers, create auto-label jobs, and manage batch labeling workflows.
Quality control
Quality control
Set up quality targets, compute consensus scores, and evaluate annotation quality programmatically.
Webhook integrations
Webhook integrations
Subscribe to events, manage webhook endpoints, and inspect delivery logs for real-time integrations.
Fleet management
Fleet management
Manage edge devices, recordings, events, and alerting rules for computer vision applications.
Requirements
- Python 3.9 or higher
- An Avala API key (get one here)
Next steps
Install the SDK
Follow the installation guide to add Avala to your project
Configure authentication
Set up your API key using the authentication guide
Run the quickstart
Try the quickstart examples to make your first API calls
Explore the API
Browse the API reference to discover all available resources