Skip to main content

VIDEO COMING SOON

Getting Started with Avala

5-6 min • API key setup, SDK installation, first API call

Prerequisites: You need an Avala account. Sign up at avala.ai or create one programmatically with the SDK (see below), then create an API key under Settings > Security.
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)
That’s it. Below is a step-by-step walkthrough of what’s happening and what you can do next.

​
Create an Account

You can sign up at avala.ai or create an account programmatically. The SDK signup function does not require an API key — it returns one on success. 
from avala import signup

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

​
Get Your API Key

  1. Log in to Mission Control.
  2. Go to Settings > Security.
  3. Click Create API Key, give it a name, select scopes, and copy the key.
API keys are shown only once at creation time. Store it somewhere secure before closing the dialog.
Set it as an environment variable so all SDKs and the CLI pick it up automatically: 
export AVALA_API_KEY="avk_your_api_key"

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

​
List Projects

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

​
Create an Export

export = client.exports.create(project="proj_uid_here")
print(f"Export {export.uid}: {export.status}")
Exports run asynchronously. Poll the status with client.exports.get(uid) or use avala exports wait <uid> in the CLI to block until completion. Pass -o json to any CLI command for machine-readable output.

​
Check Rate Limit Usage

The SDKs expose rate limit headers from every response: 
info = client.rate_limit_info
print(f"{info['remaining']}/{info['limit']} requests remaining")
print(f"Resets at: {info['reset']}")

​
Next Steps

Python SDK

Async support, pagination, error handling, and full type hints.

TypeScript SDK

Zero dependencies. Works in Node.js, Deno, and Bun.

CLI Reference

Manage datasets, projects, exports, and storage from your terminal.

Webhooks

Receive real-time notifications for dataset, export, and task events.

MCP Server

Use Avala with Claude, Cursor, and VS Code through AI assistants.

API Reference

Full endpoint reference with request and response schemas.