Auboz API

User & API Keys

Endpoints for managing user profile and API keys.

Get Profile

GET /v1/user/me

Returns the current user's profile and credit balance.

Scope: user:read

Response
{
  "id": "uuid",
  "email": "user@example.com",
  "name": "John Doe",
  "phone": "+14155552671",
  "creditsBalance": 9500
}

Update Profile

PATCH /v1/user/me

Update user profile fields (currently phone number).

Scope: user:write

Request Body
{
  "phone": "+14155552671"
}

Get Credit Balance

GET /v1/user/me/credits

Returns detailed credit balance breakdown.

Scope: user:read

List API Keys

GET /v1/user/me/api-keys

Returns metadata for all API keys (not the key values).

Scope: user:read

Rate limit: 100 req/min (all plans)

Response
[
  {
    "id": "uuid",
    "name": "Production Backend",
    "display_key": "sk_a1b2...x9z0",
    "scopes": ["kb:read", "kb:write"],
    "last_used_at": "2026-03-09T10:00:00Z",
    "created_at": "2026-03-01T00:00:00Z"
  }
]

Create API Key

POST /v1/user/me/api-keys

Creates a new API key. The full key is returned once in the response.

Scope: user:write

Rate limit: 100 req/min (all plans)

Request Body
{
  "name": "Production Backend",
  "scopes": ["kb:read", "kb:write", "chat:write"]
}
Response
{
  "id": "uuid",
  "name": "Production Backend",
  "display_key": "sk_a1b2...x9z0",
  "raw_key": "sk_<full_key_shown_once>",
  "scopes": ["kb:read", "kb:write", "chat:write"]
}

Delete API Key

DELETE /v1/user/me/api-keys/{id}

Permanently revokes an API key. Takes effect immediately.

Scope: user:write

Rate limit: 100 req/min (all plans)

On this page