|
1 | | -# aiXplain SDK |
| 1 | +# aiXplain Agents SDK |
2 | 2 |
|
3 | | -<div align="center"> |
4 | | - <img src="assets/aixplain-brandmark-line.png" alt="aiXplain logo" title="aiXplain" height="132" width="85"/> |
5 | | - <br> |
6 | | - <br> |
| 3 | +**Build and deploy autonomous AI agents on production-grade infrastructure, instantly.** |
7 | 4 |
|
8 | | - [](https://www.python.org/downloads/) |
9 | | - [](http://www.apache.org/licenses/LICENSE-2.0) |
10 | | - [](https://badge.fury.io/py/aiXplain) |
| 5 | +--- |
11 | 6 |
|
12 | | - **The professional AI SDK for developers and enterprises** |
13 | | -</div> |
| 7 | +## aiXplain agents |
14 | 8 |
|
15 | | -## 📖 API Reference |
| 9 | +aiXplain Agents SDK gives developers Python and REST APIs to build, run, and deploy autonomous multi-step agents on [AgenticOS](https://docs.aixplain.com/getting-started/agenticos). Agents include built-in memory for short- and long-term context (opt-in), and adapt at runtime by planning steps, selecting tools and models, running code, and refining outputs until tasks are complete. |
16 | 10 |
|
17 | | -- **Complete documentation:** |
18 | | - - [Python](https://docs.aixplain.com/api-reference/python/) |
19 | | - - [Swift](https://docs.aixplain.com/api-reference/swift/) |
| 11 | +aiXplain agents include micro-agents for runtime policy enforcement and access control, plus proprietary meta-agents like Evolver for self-improvement. |
20 | 12 |
|
| 13 | +With one API key, access 900+ vendor-agnostic models, tools, and integrations in the aiXplain Marketplace with consolidated billing, and swap assets without rewriting pipelines. |
21 | 14 |
|
22 | | -## 🚀 Overview |
| 15 | +### Why aiXplain for developers |
23 | 16 |
|
24 | | -The aiXplain SDK is a comprehensive Python library that empowers developers to integrate cutting-edge AI capabilities into their applications with ease. Access thousands of AI models, build custom pipelines, and deploy intelligent solutions at scale. |
| 17 | +- **Autonomy** — agents plan and adapt at runtime instead of following fixed workflows. |
| 18 | +- **Delegation** — route complex work to specialized subagents during execution. |
| 19 | +- **Policy enforcement** — apply runtime guardrails with Inspector and Bodyguard on every run. |
| 20 | +- **Observability** — inspect step-level traces, tool calls, and outcomes for debugging. |
| 21 | +- **Portability** — swap models and tools without rewriting application logic. |
| 22 | +- **Flexible deployment** — run the same agent definition serverless or private. |
25 | 23 |
|
26 | | -### ✨ Key Features |
| 24 | +<div align="center"> |
| 25 | + <img src="docs/assets/aixplain-workflow-teamagent.png" alt="aiXplain team-agent runtime flow" title="aiXplain"/> |
| 26 | +</div> |
27 | 27 |
|
28 | | -- **🔍 Discover**: Access 35,000+ ready-to-use AI models across multiple domains |
29 | | -- **⚡ Benchmark**: Compare AI systems using comprehensive datasets and metrics |
30 | | -- **🛠️ Design**: Create and deploy custom AI pipelines with our visual designer |
31 | | -- **🎯 FineTune**: Enhance pre-trained models with your data for optimal performance |
| 28 | +## AgenticOS |
32 | 29 |
|
| 30 | +AgenticOS is the runtime behind aiXplain Agents. It orchestrates multi-step execution, routes model and tool calls with fallback policies, enforces governance at runtime, records step-level traces, and supports both serverless and private deployment. |
| 31 | + |
| 32 | +<div align="center"> |
| 33 | + <img src="docs/assets/aixplain-agentic-os-architecture.png" alt="aiXplain AgenticOS architecture" title="aiXplain"/> |
| 34 | +</div> |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +## Quick start |
33 | 39 |
|
34 | | -## 📦 Installation |
35 | 40 | ```bash |
36 | 41 | pip install aixplain |
37 | 42 | ``` |
38 | 43 |
|
39 | | -## 🔑 Authentication |
40 | | -```bash |
41 | | -export TEAM_API_KEY=your_api_key_here |
| 44 | +Get your API key from your [aiXplain account](https://console.aixplain.com/settings/keys). |
| 45 | + |
| 46 | +<details open> |
| 47 | + <summary><strong>v2 (default)</strong></summary> |
| 48 | + |
| 49 | +### Create and run your first agent (v2) |
| 50 | + |
| 51 | +```python |
| 52 | +from aixplain import Aixplain |
| 53 | + |
| 54 | +aix = Aixplain(api_key="<AIXPLAIN_API_KEY>") |
| 55 | + |
| 56 | +search_tool = aix.Tool.get("tavily/tavily-web-search/tavily") |
| 57 | + |
| 58 | +agent = aix.Agent( |
| 59 | + name="Research agent", |
| 60 | + description="Answers questions with concise web-grounded findings.", |
| 61 | + instructions="Use the search tool when needed and cite key findings.", |
| 62 | + tools=[search_tool], |
| 63 | +) |
| 64 | +agent.save() |
| 65 | + |
| 66 | +result = agent.run(query="Summarize the latest AgenticOS updates.") |
| 67 | +print(result.data.output) |
42 | 68 | ``` |
43 | 69 |
|
44 | | -## 🏃♂️ Quick Start |
| 70 | +### Build a multi-agent team (v2) |
| 71 | + |
45 | 72 | ```python |
46 | | -agent = AgentFactory.create( |
47 | | - name="Google Search Agent", |
48 | | - description="A search agent", |
49 | | - instructions="Use Google Search to answer queries.", |
50 | | - tools=[ |
51 | | - # Google Search (Serp) |
52 | | - AgentFactory.create_model_tool("692f18557b2cc45d29150cb0")]) |
| 73 | +from aixplain import Aixplain |
| 74 | + |
| 75 | +aix = Aixplain(api_key="<AIXPLAIN_API_KEY>") |
| 76 | +search_tool = aix.Tool.get("tavily/tavily-web-search/tavily") |
| 77 | + |
| 78 | +planner = aix.Agent( |
| 79 | + name="Planner", |
| 80 | + instructions="Break requests into clear subtasks." |
| 81 | +) |
| 82 | + |
| 83 | +researcher = aix.Agent( |
| 84 | + name="Researcher", |
| 85 | + instructions="Find and summarize reliable sources.", |
| 86 | + tools=[search_tool], |
| 87 | +) |
| 88 | + |
| 89 | +team_agent = aix.Agent( |
| 90 | + name="Research team", |
| 91 | + instructions="Delegate work to subagents, then return one final answer.", |
| 92 | + subagents=[planner, researcher], |
| 93 | +) |
| 94 | +team_agent.save() |
| 95 | + |
| 96 | +response = team_agent.run(query="Compare top open-source agent frameworks in 5 bullets.") |
| 97 | +print(response.data.output) |
| 98 | +``` |
| 99 | + |
| 100 | +</details> |
53 | 101 |
|
54 | | -response = agent.run("What's the latest AI news?").data.output |
55 | | -print(response) |
| 102 | +<details> |
| 103 | + <summary><strong>v1 (legacy)</strong></summary> |
56 | 104 |
|
57 | | -agent.deploy() |
| 105 | +### Create and run your first agent (v1) |
| 106 | + |
| 107 | +```python |
| 108 | +from aixplain.factories import AgentFactory, ModelFactory |
| 109 | + |
| 110 | +weather_tool = ModelFactory.get("66f83c216eb563266175e201") |
| 111 | + |
| 112 | +agent = AgentFactory.create( |
| 113 | + name="Weather Agent", |
| 114 | + description="Answers weather queries.", |
| 115 | + instructions="Use the weather tool to answer user questions.", |
| 116 | + tools=[weather_tool], |
| 117 | +) |
| 118 | + |
| 119 | +result = agent.run("What is the weather in Liverpool, UK?") |
| 120 | +print(result["data"]["output"]) |
58 | 121 | ``` |
59 | 122 |
|
60 | | -## 🔗 Platform Links |
61 | | -- **Platform**: [platform.aixplain.com](https://platform.aixplain.com) |
62 | | -- **Discover**: [platform.aixplain.com/discover](https://platform.aixplain.com/discover) |
63 | | -- **Docs**: [docs.aixplain.com/](https://docs.aixplain.com/) |
64 | | -- **Support**: [GitHub Issues](https://github.com/aixplain/aiXplain/issues) |
| 123 | +You can still access legacy docs at [docs.aixplain.com/1.0](https://docs.aixplain.com/1.0/). |
| 124 | + |
| 125 | +</details> |
| 126 | + |
| 127 | +--- |
| 128 | + |
| 129 | +## Data handling and deployment |
| 130 | + |
| 131 | +aiXplain applies runtime governance and enterprise controls by default: |
| 132 | + |
| 133 | +- **No data retained by default** — agent memory is opt-in (short-term and long-term). |
| 134 | +- **SOC 2 Type II certified** — enterprise security and compliance posture. |
| 135 | +- **Runtime policy enforcement** — Inspector and Bodyguard govern every agent execution. |
| 136 | +- **Sovereign deployment options** — serverless or private (on-prem, VPC, and air-gapped). |
| 137 | +- **Encryption** — TLS 1.2+ in transit and encrypted storage at rest. |
| 138 | + |
| 139 | +Learn more at [aiXplain Security](https://aixplain.com/security/) and [Sovereignty](https://aixplain.com/sovereignty/). |
| 140 | + |
| 141 | +--- |
| 142 | + |
| 143 | +## Pricing |
| 144 | + |
| 145 | +Start free, then scale with usage-based pricing. |
| 146 | + |
| 147 | +- **Pay as you go** — prepaid usage with no surprise overage bills. |
| 148 | +- **Subscription plans** — reduce effective consumption-based rates. |
| 149 | +- **Custom enterprise pricing** — available for advanced scale and deployment needs. |
| 150 | + |
| 151 | +Learn more at [aiXplain Pricing](https://aixplain.com/pricing/). |
| 152 | + |
| 153 | +--- |
| 154 | + |
| 155 | +## Community & support |
| 156 | + |
| 157 | +- **Documentation:** [docs.aixplain.com](https://docs.aixplain.com) |
| 158 | +- **Example agents**: [https://github.com/aixplain/cookbook](https://github.com/aixplain/cookbook) |
| 159 | +- **Learn how to build agents**: [https://academy.aixplain.com/student-registration/](https://academy.aixplain.com/student-registration/) |
| 160 | +- **Meet us in Discord:** [discord.gg/aixplain](https://discord.gg/aixplain) |
| 161 | +- **Talk with our team:** [care@aixplain.com](mailto:care@aixplain.com) |
| 162 | + |
| 163 | +--- |
| 164 | + |
| 165 | +## License |
| 166 | + |
| 167 | +This project is licensed under the Apache License 2.0. See the [`LICENSE`](LICENSE) file for details. |
0 commit comments