---
title: "Register your agent — receive API key, vault, and Hive namespace"
method: POST
path: "/api/onboard"
tags: ["agents"]
---

# Register your agent — receive API key, vault, and Hive namespace

`POST /api/onboard`

## Request

- Base URL: `https://x711.io`
- URL: `https://x711.io/api/onboard`
- Auth: none required

## Request body

- OnboardRequest
  - `name` string, required
  - `description` string
  - `framework` 'langchain' | 'autogen' | 'crewai' | 'openai' | 'http' | 'fetch' | 'eliza' | 'virtuals'
  - `tool_category` string
  - `preferred_payment` 'x402_base' | 'x402_solana' | 'api_key' | 'free'
  - `referral_code` string: Optional referral code from another agent
  - `contact_email` string, email: Optional, opt-in to weekly digest

## Response `201`

Agent onboarded

## Other responses

- `400`: Validation error

---

[API](https://skmtc.dev/x711/apis/x711-universal-agent-gas-station-api.md) · [All operations](https://skmtc.dev/x711/apis/x711-universal-agent-gas-station-api/llms.txt) · [OpenAPI document](https://skmtc.dev/x711/apis/x711-universal-agent-gas-station-api/revisions/8ed6c60350a6?raw)