Skip to main content
POST
Create User Account

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Body

application/json
email
string
required

User's email address

Maximum string length: 64
Pattern: ^(?!.*@vast)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
Example:

"user@example.com"

username
string
required

Desired username

Maximum string length: 64
Example:

"testuser123"

password
string
required

Account password

Maximum string length: 256
Example:

"securepass123"

host_only
boolean

If true, account is restricted to host functionality only

Example:

true

parent_id
string

Parent account ID for subaccounts. Use "me" for current user.

Example:

"me"

ssh_key
string

Optional SSH public key

Maximum string length: 4096
captcha
string

Captcha token (required for non-subaccounts)

Maximum string length: 8192

Response

Account created successfully; returns formatted user object with API key

id
integer

User ID

username
string

Username

email
string

Email address

api_key
string

API key (populated for subaccounts)

key_id
integer

Active API key ID

balance
number

Account credit balance (USD)

credit
number

Promotional credit balance (USD)

email_verified
boolean

Whether the email has been verified

huggingface_cloud_sync_enabled
boolean

Whether Hugging Face cloud sync is currently enabled for this authenticated user

host_only
boolean

Whether this is a host-only account

ssh_key
string

Default SSH public key

can_pay
boolean

Whether a payment method is on file

has_billing
boolean

Whether a Stripe payment method exists