Account

Manage your account profile and credit balance.

Sign up

POST /v1/signup (No authentication required)

Creates a new account and issues your first API key. The raw key is shown once in the response and cannot be recovered, so copy it immediately.

Rate-limited to 3 signups per IP per day.

curl

curl -s -X POST "https://api.effect.ai/v1/signup" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "email": "you@acme.com"
  }'

Response 201

{
  "key": "eff_live_dGhpcyBpcyBhIHRlc3Qga2V5IGZvciBkb2Nz",
  "accountId": "01JQKX3Z8VFNWRB2TGHM4Y5P6A",
  "name": "Acme Corp"
}

Field	Description
`key`	Your API key. Store this securely, shown once only
`accountId`	Unique account identifier
`name`	Account display name

Request fields

Field	Required	Constraints
`name`	Yes	Max 100 characters
`email`	No	Must be a valid email address if provided

Get account

GET /v1/account

Returns your account details and current credit balance.

curl

curl -s "https://api.effect.ai/v1/account" \
  -H "Authorization: Bearer eff_live_YOUR_KEY"

Response 200

{
  "id": "01JQKX3Z8VFNWRB2TGHM4Y5P6A",
  "name": "Acme Corp",
  "email": "you@acme.com",
  "status": "active",
  "createdAt": 1750000000000,
  "credits": {
    "balance": "25000000",
    "currency": "EFFECT",
    "lamportsPerEffect": 1000000
  }
}

Field	Description
`email`	`null` when no email is set
`status`	`"active"` or `"suspended"` (suspended accounts cannot authenticate)
`credits.balance`	Current balance in lamports (divide by `lamportsPerEffect` to get EFFECT)
`credits.currency`	Always `"EFFECT"`
`credits.lamportsPerEffect`	Conversion rate, where 1 EFFECT = 1,000,000 lamports

The balance above ("25000000") equals 25 EFFECT.

Update account

PATCH /v1/account

Updates your account name and/or email. Only fields present in the body are changed. A body with neither field returns 400 invalid_request.

Update name

curl

curl -s -X PATCH "https://api.effect.ai/v1/account" \
  -H "Authorization: Bearer eff_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Corp (updated)"}'

Update email

curl

curl -s -X PATCH "https://api.effect.ai/v1/account" \
  -H "Authorization: Bearer eff_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "new@acme.com"}'

Clear email

curl

curl -s -X PATCH "https://api.effect.ai/v1/account" \
  -H "Authorization: Bearer eff_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": ""}'

Response 200

{
  "id": "01JQKX3Z8VFNWRB2TGHM4Y5P6A",
  "name": "Acme Corp (updated)",
  "email": "new@acme.com",
  "status": "active",
  "createdAt": 1750000000000,
  "credits": {
    "balance": "25000000",
    "currency": "EFFECT",
    "lamportsPerEffect": 1000000
  }
}

Field	Constraints
`name`	Max 100 characters
`email`	Must be a valid email, or `""` to clear it