🧠 Arklex AI · Agent-First Framework
Build, deploy, and scale intelligent AI agents with enterprise-grade reliability
🚀 Quick Start • 📚 Documentation • 💡 Examples
🚀 Get Started in 5 Minutes
Install & Setup
# Install
pip install arklex
# Create .env file
echo "OPENAI_API_KEY=your_key_here" > .env
# Clone the repository (required if you want to run example/test scripts)
git clone https://github.com/arklexai/Agent-First-Organization.git
cd Agent-First-Organization
pip install -e .
# Test your API keys (recommended)
python test_api_keys.py
# Create your first agent
python create.py \
--config ./examples/customer_service/customer_service_config.json \
--output-dir ./examples/customer_service \
--llm_provider openai \
--model gpt-4o
# Run agent
python run.py \
--input-dir ./examples/customer_service \
--llm_provider openai \
--model gpt-4o
# For evaluation and testing, you can also use the model API server:
# 1. Start the model API server (defaults to OpenAI with "gpt-4o-mini" model):
python model_api.py --input-dir ./examples/customer_service
# 2. Run evaluation (in a separate terminal):
python eval.py --model_api http://127.0.0.1:8000/eval/chat \
--config "examples/customer_service/customer_service_config.json" \
--documents_dir "examples/customer_service" \
--model "claude-3-haiku-20240307" \
--llm_provider "anthropic" \
--task "all"
📺 Learn by Example
▶️ Build a Customer Service Agent in 20 Minutes
👉 Explore the full tutorial: Customer Service Agent Walkthrough
⚡ Key Features
- 🚀 90% Faster Development — Deploy agents in days, not months
- 🧠 Agent-First Design — Purpose-built for multi-agent orchestration
- 🔌 Model Agnostic — OpenAI, Anthropic, Gemini, and more
- 📊 Built-in Evaluation — Comprehensive testing suite
- 🛡️ Enterprise Security — Authentication and rate limiting
- ⚡ Production Ready — Monitoring, logging, auto-scaling
🏗️ Architecture
graph TB
A[Task Graph] --> B[Orchestrator]
B --> C[Workers]
B --> D[Tools]
C --> E[RAG Worker]
C --> F[Database Worker]
C --> G[Custom Workers]
D --> I[API Tools]
D --> J[External Tools]
Core Components:
- Task Graph — Declarative DAG workflows
- Orchestrator — Runtime engine with state management
- Workers — RAG, database, web automation
- Tools — Shopify, HubSpot, Google Calendar integrations
💡 Use Cases
| Domain | Capabilities |
|---|---|
| Customer service for e-commerce | RAG chatbots, ticket routing, support workflows |
| E-commerce such as shopify sales and customer | Order management, inventory tracking, recommendations |
| Business Process | Scheduling, CRM operations, document processing |
📚 Examples
| Example | Description | Complexity |
|---|---|---|
| Customer Service | RAG-powered support | ⭐⭐ |
| Shopify Integration | E-commerce management | ⭐⭐⭐ |
| HubSpot CRM | Contact management | ⭐⭐⭐ |
| Calendar Booking | Scheduling system | ⭐⭐ |
| Human-in-the-Loop | Interactive workflows | ⭐⭐⭐⭐ |
🔧 Configuration
Requirements: Python 3.10+, API keys
# Required: Choose one or more LLM providers
OPENAI_API_KEY=your_key_here
# OR ANTHROPIC_API_KEY=your_key_here
# OR GOOGLE_API_KEY=your_key_here
# Optional: Enhanced features
MILVUS_URI=your_milvus_uri
MYSQL_USERNAME=your_username
TAVILY_API_KEY=your_tavily_key
Testing API Keys:
After adding your API keys to the .env file, run the test script to verify they work correctly:
# Test all configured API keys
python test_api_keys.py
# Test specific providers only
python test_api_keys.py --providers openai gemini
python test_api_keys.py --providers openai anthropic
📖 Documentation
- 📚 Full Documentation
- 🚀 Quick Start
- 🛠️ API Reference
- 🏗️ Architecture
- 🚀 Deployment
🤝 Community
- 🐛 Report Issues
- 💬 Discord
- 📧 Email Support
📄 License
Arklex AI is released under the MIT License. See LICENSE for details.
This means you can:
- ✅ Use Arklex AI for commercial projects
- ✅ Modify and distribute the code
- ✅ Use it in proprietary applications
- ✅ Sell applications built with Arklex AI
The only requirement is that you include the original license and copyright notice.
🙏 Acknowledgments
Thanks to all our contributors and the open-source community for making this project possible!
🌟 Contributors
🤝 Open Source Dependencies
Arklex AI builds on the shoulders of giants:
- LangChain — LLM framework and tooling
- FastAPI — Modern web framework
- Pydantic — Data validation
- SQLAlchemy — Database ORM
- Milvus — Vector database
- And many more...
Made with ❤️ by the Arklex AI Team
Website • Documentation • GitHub • Discord • LinkedIn
1 maintainer
Release files for arklex 0.1.21
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| arklex-0.1.21.tar.gz | 5.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| arklex-0.1.21-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 6.2 MB
Release files / arklex-0.1.21.tar.gz
| Download URL | arklex-0.1.21.tar.gz |
|---|---|
| Size | 5.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
976bd03cec25abcdf72ec82be41fcf060c8fe5ab3b4e900f55d2976ab4d7b426
|
|
BLAKE2b-256 checksum How to use checksums |
bdf44e4f524aedd1444a66ce610a53d00db50467b0fd0b861f9a05b91b6e7b0d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 9, 2026.
Transparency logRelease files / arklex-0.1.21-py3-none-any.whl
| Download URL | arklex-0.1.21-py3-none-any.whl |
|---|---|
| Size | 287.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a3825fd7377820eea255e1fd563ea586450779094d5b467a35394e99cc06bbd9
|
|
BLAKE2b-256 checksum How to use checksums |
cd6a49880b6ed02fe86dafdcfc87d27b54efee0533248889e3dd3783cee8ce3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 9, 2026.
Transparency log
