跳转到主要内容

视频即将推出

Avala 入门

5-6 分钟 · API 密钥设置、SDK 安装、首次 API 调用

前置条件: 您需要一个 Avala 账户。在 avala.ai 注册或通过 SDK 以编程方式创建(见下文),然后在 设置 > 安全 中创建 API 密钥。
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)
就这样。以下是发生了什么以及您接下来可以做什么的逐步说明。

创建账户

您可以在 avala.ai 注册或以编程方式创建账户。SDK 的 signup 函数不需要 API 密钥——成功后会返回一个。
from avala import signup

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

获取 API 密钥

  1. 登录 Mission Control
  2. 前往 设置 > 安全
  3. 点击 创建 API 密钥,命名,选择权限范围,然后复制密钥。
API 密钥仅在创建时显示一次。在关闭对话框前将其保存到安全的地方。
将其设置为环境变量,以便所有 SDK 和 CLI 自动使用:
export AVALA_API_KEY="avk_your_api_key"

列出数据集

from avala import Client

client = Client()  # 从环境变量读取 AVALA_API_KEY

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

列出项目

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

创建导出

export = client.exports.create(project="proj_uid_here")
print(f"Export {export.uid}: {export.status}")
导出是异步运行的。使用 client.exports.get(uid) 轮询状态或使用 avala exports get <uid> 检查直到完成。

检查速率限制使用情况

SDK 从每个响应中公开速率限制头信息:
info = client.rate_limit_info
print(f"{info['remaining']}/{info['limit']} requests remaining")
print(f"Resets at: {info['reset']}")

下一步

Python SDK

异步支持、分页、错误处理和完整类型提示。

TypeScript SDK

零依赖。适用于 Node.js、Deno 和 Bun。

CLI 参考

从终端管理数据集、项目、导出和存储。

Webhook

接收数据集、导出和任务事件的实时通知。

MCP 服务器

通过 AI 助手使用 Avala,支持 Claude、Cursor 和 VS Code。

API 参考

完整的端点参考,包含请求和响应模式。