Client Libraries
REST API
Use the API directly from any language with HTTP requests.
OpenAPI
Generate your own client from the OpenAPI specification.
Python
Sync and async support. Full type hints. Python 3.9+.
TypeScript
Fully typed. Zero dependencies. Works in Node.js, Deno, and Bun.
Quick Comparison
| Feature | REST API | OpenAPI | Python | TypeScript |
|---|---|---|---|---|
| Install | Direct HTTP | Code generation | pip install avala | npm install @avala/sdk |
| Async | Any | Varies | Sync + Async | Async |
| Type Safety | N/A | Generated types | Full type hints | Full TypeScript types |
| Auto Retries | Manual | Varies | Yes | Yes |
| Pagination | Manual | Varies | Built-in iterators | Built-in iterators |
| Dependencies | N/A | Varies | httpx, pydantic | None (native fetch) |
Environment Variables
All SDKs respect the following environment variables, so you can configure them once and use them across your entire stack.| Variable | Description | Default |
|---|---|---|
AVALA_API_KEY | Your Avala API key for authentication. Used automatically if no key is passed to the client constructor. | None (required) |
AVALA_BASE_URL | Override the default API base URL. Useful for self-hosted deployments or development environments. | https://server.avala.ai/api/v1 |
Authentication
All requests to the Avala API must include your API key in theX-Avala-Api-Key header. You can find your API key in the Avala dashboard under Settings > API Keys.
MCP Integration
Use Avala with AI assistants like Claude, Cursor, and VS Code through the Model Context Protocol. The@avala/mcp-server package exposes your datasets, projects, and exports as tools that AI assistants can call directly.