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>
2.6 KiB
AutoGPT Platform External API Guide
The AutoGPT Platform provides an External API that allows you to programmatically interact with agents, blocks, the store, and more.
API Documentation
Full API documentation with interactive examples is available at:
https://backend.agpt.co/external-api/docs
This Swagger UI documentation includes all available endpoints, request/response schemas, and allows you to try out API calls directly.
Authentication Methods
The External API supports two authentication methods:
1. API Keys
API keys are the simplest way to authenticate. Generate an API key from your AutoGPT Platform account settings and include it in your requests:
GET /external-api/v1/blocks
X-API-Key: your_api_key_here
API keys are ideal for:
- Server-to-server integrations
- Personal scripts and automation
- Backend services
2. OAuth 2.0 (Single Sign-On)
For applications that need to act on behalf of users, use OAuth 2.0. This allows users to authorize your application to access their AutoGPT resources.
OAuth is ideal for:
- Third-party applications
- "Sign in with AutoGPT" (SSO, Single Sign-On) functionality
- Applications that need user-specific permissions
See the SSO Integration Guide for complete OAuth implementation details.
Available Scopes
When using OAuth, request only the scopes your application needs:
| Scope | Description |
|---|---|
IDENTITY |
Read user ID, e-mail, and timezone |
EXECUTE_GRAPH |
Run agents |
READ_GRAPH |
Read agent run results |
EXECUTE_BLOCK |
Run individual blocks |
READ_BLOCK |
Read block definitions |
READ_STORE |
Access the agent store |
USE_TOOLS |
Use platform tools |
MANAGE_INTEGRATIONS |
Create and update user integrations |
READ_INTEGRATIONS |
Read user integration status |
DELETE_INTEGRATIONS |
Remove user integrations |
Quick Start
Using an API Key
# List available blocks
curl -H "X-API-Key: YOUR_API_KEY" \
https://backend.agpt.co/external-api/v1/blocks
Using OAuth
- Register an OAuth application (contact platform administrator)
- Implement the OAuth flow as described in the SSO Guide
- Use the obtained access token:
curl -H "Authorization: Bearer agpt_xt_..." \
https://backend.agpt.co/external-api/v1/blocks
Support
For issues or questions about API integration:
- Open an issue on GitHub
- Check the Swagger documentation