# AutoGPT Onboarding API

**Canonical:** https://apis.io/apis/autogpt/autogpt-onboarding-api/  
**Provider:** AutoGPT — https://apis.io/providers/autogpt/  
**Base URL:** https://backend.agpt.co/external-api  
**Documentation:** https://agpt.co/docs/platform/api-and-integrations/api-guide

AutoGPT Onboarding API is one of 41 APIs that [AutoGPT](https://apis.io/providers/autogpt/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Onboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The onboarding API from AutoGPT — 14 operation(s) for onboarding.

## Operations (15)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/onboarding` | Onboarding state |
| PATCH | `/api/onboarding` | Update onboarding state |
| GET | `/api/onboarding/agents` | Recommended onboarding agents |
| DELETE | `/api/onboarding/brain-dump` | Discard Brain Dump |
| POST | `/api/onboarding/brain-dump/finalize` | Finalize Brain Dump |
| GET | `/api/onboarding/brain-dump/intro` | Get Brain Dump Intro |
| POST | `/api/onboarding/brain-dump/intro/complete` | Complete Brain Dump Greeting |
| POST | `/api/onboarding/brain-dump/parts` | Upload Brain Dump Part |
| GET | `/api/onboarding/brain-dump/recommended-providers` | Get Brain Dump Recommended Providers |
| GET | `/api/onboarding/brain-dump/recording` | Download Brain Dump Recording |
| GET | `/api/onboarding/brain-dump/status` | Get Brain Dump Status |
| GET | `/api/onboarding/completed` | Check if onboarding is completed |
| POST | `/api/onboarding/profile` | Submit onboarding profile |
| POST | `/api/onboarding/reset` | Reset onboarding progress |
| POST | `/api/onboarding/step` | Complete onboarding step |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/autogpt/refs/heads/main/openapi/autogpt-onboarding-api-openapi.yml
- **Documentation** — https://agpt.co/docs/platform/api-and-integrations/api-guide
- **APIReference** — https://backend.agpt.co/external-api/docs
- **Sandbox** — https://raw.githubusercontent.com/api-evangelist/autogpt/refs/heads/main/sandbox/autogpt-sandbox.yml
- **Documentation** — https://agpt.co/docs

## Other AutoGPT APIs (12)

- [AutoGPT Analytics API](https://apis.io/apis/autogpt/autogpt-analytics-api/)
- [AutoGPT Auth Email API](https://apis.io/apis/autogpt/autogpt-auth-email-api/)
- [AutoGPT Blocks API](https://apis.io/apis/autogpt/autogpt-blocks-api/)
- [AutoGPT Briefings API](https://apis.io/apis/autogpt/autogpt-briefings-api/)
- [AutoGPT Copilot Webhooks API](https://apis.io/apis/autogpt/autogpt-copilot-webhooks-api/)
- [AutoGPT Graphs API](https://apis.io/apis/autogpt/autogpt-graphs-api/)
- [AutoGPT Health API](https://apis.io/apis/autogpt/autogpt-health-api/)
- [AutoGPT Home API](https://apis.io/apis/autogpt/autogpt-home-api/)
- [AutoGPT Integrations API](https://apis.io/apis/autogpt/autogpt-integrations-api/)
- [AutoGPT Meta API](https://apis.io/apis/autogpt/autogpt-meta-api/)
- [AutoGPT Monitoring API](https://apis.io/apis/autogpt/autogpt-monitoring-api/)
- [AutoGPT Platform Linking API](https://apis.io/apis/autogpt/autogpt-platform-linking-api/)

## Tags

Onboarding

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/autogpt/autogpt-onboarding-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/autogpt/.