mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-01-30 09:28:19 -05:00
a318832414
<!-- Clearly explain the need for these changes: -->
gitbook branch has changes that need synced to dev
### Changes 🏗️
Pull changes from gitbook into dev
<!-- Concisely describe all of the changes made in this pull request:
-->
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Migrates documentation to GitBook and removes the old MkDocs setup.
>
> - Removes MkDocs configuration and infra: `docs/mkdocs.yml`,
`docs/netlify.toml`, `docs/overrides/main.html`,
`docs/requirements.txt`, and JS assets (`_javascript/mathjax.js`,
`_javascript/tablesort.js`)
> - Updates `docs/content/contribute/index.md` to describe GitBook
workflow (gitbook branch, editing, previews, and `SUMMARY.md`)
> - Adds GitBook navigation file `docs/platform/SUMMARY.md` and a new
platform overview page `docs/platform/what-is-autogpt-platform.md`
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
e7e118b5a8. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Updated contribution guide for new documentation platform and workflow
* Added new platform overview and navigation documentation
* **Chores**
* Removed MkDocs configuration and related dependencies
* Removed deprecated JavaScript integrations and deployment overrides
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
140 lines
4.4 KiB
Markdown
140 lines
4.4 KiB
Markdown
|
||
# 🧠 Running AI/ML API with AutoGPT
|
||
|
||
Follow these steps to connect **AI/ML API** with the **AutoGPT** platform for high-performance AI text generation.
|
||
|
||
---
|
||
|
||
## ✅ Prerequisites
|
||
|
||
1. Make sure you have gone through and completed the [AutoGPT Setup Guide](https://docs.agpt.co/platform/getting-started/), and AutoGPT is running locally at `http://localhost:3000`.
|
||
2. You have an **API key** from [AI/ML API](https://aimlapi.com/app/keys?utm_source=autogpt&utm_medium=github&utm_campaign=integration).
|
||
|
||
---
|
||
|
||
## ⚙️ Setup Steps
|
||
|
||
### 1. Start AutoGPT Locally
|
||
|
||
Follow the official guide:
|
||
[📖 AutoGPT Getting Started Guide](https://docs.agpt.co/platform/getting-started/)
|
||
|
||
Make sure AutoGPT is running and accessible at:
|
||
[http://localhost:3000](http://localhost:3000)
|
||
|
||
> 💡 Keep AutoGPT running in a terminal or Docker throughout the session.
|
||
|
||
|
||
|
||
---
|
||
|
||
### 2. Open the Visual Builder
|
||
|
||
Open your browser and go to:
|
||
[http://localhost:3000/build](http://localhost:3000/build)
|
||
|
||
Or click **“Build”** in the navigation bar.
|
||
|
||
|
||
|
||
---
|
||
|
||
### 3. Add an AI Text Generator Block
|
||
|
||
1. Click the **"Blocks"** button on the left sidebar.
|
||
|
||
|
||
|
||
2. In the search bar, type `AI Text Generator`.
|
||
3. Drag the block into the canvas.
|
||
|
||
|
||
|
||
---
|
||
|
||
### 4. Select an AI/ML API Model
|
||
|
||
Click the AI Text Generator block to configure it.
|
||
|
||
In the **LLM Model** dropdown, select one of the supported models from AI/ML API:
|
||
|
||
|
||
|
||
| Model ID | Speed | Reasoning Quality | Best For |
|
||
| ---------------------------------------------- | ------ | ----------------- | ------------------------ |
|
||
| `Qwen/Qwen2.5-72B-Instruct-Turbo` | Medium | High | Text-based tasks |
|
||
| `nvidia/llama-3.1-nemotron-70b-instruct` | Medium | High | Analytics and reasoning |
|
||
| `meta-llama/Llama-3.3-70B-Instruct-Turbo` | Low | Very High | Complex multi-step tasks |
|
||
| `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` | Low | Very High | Deep reasoning |
|
||
| `meta-llama/Llama-3.2-3B-Instruct-Turbo` | High | Medium | Fast responses |
|
||
|
||
> ✅ These models are available via OpenAI-compatible API from [AI/ML API](https://aimlapi.com/app/?utm_source=autogpt&utm_medium=github&utm_campaign=integration)
|
||
|
||
---
|
||
|
||
### 5. Configure the Prompt and API Key
|
||
|
||
Inside the **AI Text Generator** block:
|
||
|
||
1. Enter your prompt text in the **Prompt** field.
|
||
2. Enter your **AI/ML API Key** in the designated field.
|
||
|
||
🔐 You can get your key from:
|
||
[https://aimlapi.com/app/keys/](https://aimlapi.com/app/keys?utm_source=autogpt&utm_medium=github&utm_campaign=integration)
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
---
|
||
|
||
### 6. Save Your Agent
|
||
|
||
Click the **“Save”** button at the top-right of the builder interface:
|
||
|
||
1. Give your agent a name (e.g., `aimlapi_test_agent`).
|
||
2. Click **“Save Agent”** to confirm.
|
||
|
||
|
||
|
||
> 💡 Saving allows reuse, scheduling, and chaining in larger workflows.
|
||
|
||
---
|
||
|
||
### 7. Run Your Agent
|
||
|
||
From the workspace:
|
||
|
||
1. Press **“Run”** next to your saved agent.
|
||
2. The request will be sent to the selected AI/ML API model.
|
||
|
||
|
||
|
||
---
|
||
|
||
### 8. View the Output
|
||
|
||
1. Scroll to the **AI Text Generator** block.
|
||
2. Check the **Output** panel below it.
|
||
3. You can copy, export, or pass the result to further blocks.
|
||
|
||
|
||
|
||
---
|
||
|
||
## 🔄 Expand Your Agent
|
||
|
||
Now that AI/ML API is connected, expand your workflow by chaining additional blocks:
|
||
|
||
* 🔧 **Tools** – fetch URLs, call APIs, scrape data
|
||
* 🧠 **Memory** – retain context across interactions
|
||
* ⚙️ **Actions / Chains** – create full pipelines
|
||
|
||
---
|
||
|
||
🎉 You’re now generating AI responses using enterprise-grade models from **AI/ML API** in **AutoGPT**!
|