Files
AutoGPT/docs/content/index.md
Dmitry 0dd30e275c docs(blocks): Add AI/ML API integration guide and update LLM headers (#10402)
### Summary
Added a new documentation page and images for integrating AI/ML API with
AutoGPT, including step-by-step instructions. Updated LLM block to send
additional headers for requests to aimlapi.com. Improved provider
listing in index.md and added the new guide to mkdocs navigation. Builds
on and extends the integration work from
https://github.com/Significant-Gravitas/AutoGPT/pull/9996


### Changes 🏗️

This PR introduces official support and documentation for using **AI/ML
API** with the **AutoGPT platform**:

* 📄 **Added a new documentation page** `platform/aimlapi.md` with a
detailed step-by-step integration guide.
* 🖼️ **Added 12+ reference images** to `docs/content/imgs/aimlapi/` for
clear visual walkthrough.
* 🧠 **Updated the LLM block** (`llm.py`) to send extra headers
(`X-Project`, `X-Title`, `Referer`) in requests to `aimlapi.com` for
analytics and source attribution.
* 📚 **Improved provider listing** in `index.md` — added section about
AI/ML API models and benefits.
* 🧭 **Added the new guide to the mkdocs navigation** via `mkdocs.yml`.

---

### Checklist 📋

#### For code changes:

* [x] I have clearly listed my changes in the PR description
* [x] I have made a test plan
* [x] I have tested my changes according to the test plan:

  * [x] Successfully authenticated against `api.aimlapi.com`
  * [x] Verified requests use correct headers
* [x] Confirmed `AI Text Generator` block returns completions for all
supported models
* [x] End-to-end tested: created, saved, and ran agent with AI/ML API
successfully
  * [x] Verified outputs render correctly in the Output panel


No breaking changes introduced. Let me know if you'd like this guide
cross-referenced from other onboarding pages. 

---------

Co-authored-by: Nicholas Tindle <nicholas.tindle@agpt.co>
2025-08-13 18:25:58 +00:00

3.7 KiB

AutoGPT Documentation

Welcome to the AutoGPT Documentation.

What is the AutoGPT Platform?

The AutoGPT Platform is a groundbreaking system that revolutionizes AI utilization for businesses and individuals. It enables the creation, deployment, and management of continuous agents that work tirelessly on your behalf, bringing unprecedented efficiency and innovation to your workflows.

Key Features

  • Seamless Integration and Low-Code Workflows: Rapidly create complex workflows without extensive coding knowledge.
  • Autonomous Operation and Continuous Agents: Deploy cloud-based assistants that run indefinitely, activating on relevant triggers.
  • Intelligent Automation and Maximum Efficiency: Streamline workflows by automating repetitive processes.
  • Reliable Performance and Predictable Execution: Enjoy consistent and dependable long-running processes.

Platform Architecture

The AutoGPT Platform consists of two main components:

1. AutoGPT Server

The powerhouse of our platform, containing:

  • Source Code: Core logic driving agents and automation processes.
  • Infrastructure: Robust systems ensuring reliable and scalable performance.
  • Marketplace: A comprehensive marketplace for pre-built agents.

2. AutoGPT Frontend

The user interface where you interact with the platform:

  • Agent Builder: Design and configure your own AI agents.
  • Workflow Management: Build, modify, and optimize automation workflows.
  • Deployment Controls: Manage the lifecycle of your agents.
  • Ready-to-Use Agents: Select from pre-configured agents.
  • Agent Interaction: Run and interact with agents through a user-friendly interface.
  • Monitoring and Analytics: Track agent performance and gain insights.

Platform Components

Agents and Workflows

In the platform, you can create highly customized workflows to build agents. An agent is essentially an automated workflow that you design to perform specific tasks or processes. Create customized workflows to build agents for various tasks, including:

  • Data processing and analysis
  • Task scheduling and management
  • Communication and notification systems
  • Integration between different software tools
  • AI-powered decision making and content generation

Blocks as Integrations

Blocks represent actions and are the building blocks of your workflows, including:

  • Connections to external services
  • Data processing tools
  • AI models for various tasks
  • Custom scripts or functions
  • Conditional logic and decision-making components

You can learn more under: Build your own Blocks

Available Language Models

The platform comes pre-integrated with cutting-edge LLM providers:

License Overview

We've adopted a dual-license approach to balance open collaboration with sustainable development:

  • MIT License: The majority of the AutoGPT repository remains under this license.
  • Polyform Shield License: Applies to the new autogpt_platform folder.

This strategy allows us to share previously closed-source components, fostering a vibrant ecosystem of developers and users.

Ready to Get Started?