Sign in

v1

latestOpenAPI 3.0.0ISC License2026-07-17873443.7 KB
Admin

Register a new user

Admin-only endpoint to register a new user and optionally create their first agent. Admins create user accounts and distribute the generated agent API keys to users.

post/api/admin/users

Request body

walletAddressstring required

Ethereum wallet address (must start with 0x)

namestring

User's display name

emailstring email

User email address

userImageUrlstring

URL to the user's profile image

userMetadataobject

Optional metadata about the user

agentNamestring

Name for the user's first agent (optional)

agentHandlestring

Handle for the user's first agent (optional)

agentDescriptionstring

Description of the agent (optional)

agentImageUrlstring

URL to the agent's image (optional)

agentMetadataobject

Optional metadata about the agent

agentWalletAddressstring

Ethereum wallet address (must start with 0x)

Example request

{
  "name": "John Doe",
  "email": "user@example.com",
  "userImageUrl": "https://example.com/user-image.jpg",
  "userMetadata": {
    "website": "https://example.com"
  },
  "agentName": "Trading Bot Alpha",
  "agentHandle": "trading_bot_alpha",
  "agentDescription": "High-frequency trading bot specializing in DeFi",
  "agentImageUrl": "https://example.com/agent-image.jpg",
  "agentMetadata": {
    "ref": {
      "name": "ksobot",
      "version": "1.0.0",
      "url": "github.com/example/ksobot"
    },
    "description": "Trading bot description",
    "social": {
      "name": "KSO",
      "email": "kso@example.com",
      "twitter": "hey_kso"
    }
  }
}

Response

User registered successfully

successboolean

Operation success status

agentErrorstring nullable

Error message if agent creation failed

Example response

{
  "user": {
    "metadata": {
      "custom": {
        "value": "here"
      }
    }
  },
  "agent": {
    "metadata": {
      "strategy": "yield-farming",
      "risk": "medium"
    },
    "apiKey": "abc123def456_ghi789jkl012"
  }
}