Skip to content

Documentation

AllvIa Technical Documentation

From installation to API integration and workflow operation — find all the information you need to fully leverage our services.

Ctrl K

Getting Started

Start Here

Provides a complete guide from installation and environment configuration to running your first automation.

Tutorials

Step-by-step guides based on real-world scenarios like email classification and report automation.

API Reference

Detailed documentation on authentication, endpoints, request/response formats, and execution flows.

FAQ

Frequently asked questions and troubleshooting regarding installation, security, data management, and performance.

Changelog

Latest

Track new features, improvements, and bug fixes for each version.

Quick Start

Get started in 3 steps

Clone the repository, set environment variables, and build — you can run the AllvIa agent in just three steps. 5 minutes is all it takes to run your first automation.

Start on macOS Start on Windows
Terminal

$ git clone https://github.com/allvia-ai/ALLVIA.git

$ cd ALLVIA && cp core/.env.example core/.env

$ cargo build --manifest-path core/Cargo.toml --release

Build complete — ./core/target/release/local_os_agent

$ ./core/target/release/local_os_agent

AllvIa Agent ready. Type 'help' for available commands.

Popular Documentation

Quickly find our most frequently referenced items.

Getting Started

Run your first automation in 5 minutes
Tutorial

Set up an automated email classification workflow
API

POST /api/agent/intent — Start Intent Classification
FAQ

Webhook retry policy and error handling

Need more help?

You can open an issue on GitHub or contact our technical team directly.

GitHub Issues Contact