Skip to content

Accounts

Create account

Create a new account. Returns the account details and your first API key.

POST /v1/accounts

Authentication: None required.

Request body

FieldTypeRequiredDescription
emailstringYesAccount email address
namestringNoDisplay name

CLI

Terminal window
skytale signup alice@example.com --name Alice

curl

Terminal window
curl -X POST https://api.skytale.sh/v1/accounts \
-H "Content-Type: application/json" \
-d '{"email": "alice@example.com", "name": "Alice"}'

Response 200

{
"account": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "alice@example.com",
"name": "Alice",
"plan_tier": "free"
},
"api_key": "sk_live_a1b2c3d4e5f6..."
}

The api_key field contains the full key — save it immediately. It will not be shown again.

Errors

StatusErrorCause
400email is requiredMissing or empty email field

Get current account

Retrieve the authenticated account’s details.

GET /v1/accounts/me

Authentication: Required (API key or JWT).

CLI

Terminal window
skytale account

curl

Terminal window
curl https://api.skytale.sh/v1/accounts/me \
-H "Authorization: Bearer sk_live_a1b2c3d4..."

Response 200

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "alice@example.com",
"name": "Alice",
"plan_tier": "free"
}

Errors

StatusErrorCause
401missing authorization headerNo auth header provided
401invalid or revoked api keyAPI key not found or revoked
404Not foundAccount does not exist