Skip to main content
Version: Community (1.0.0)

Profile API

Endpoints for managing your user profile and API keys.

Get Profile​

GET /api/profile​

Get your user profile information.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Response:

{
  "user": {
    "id": "user_123",
    "username": "johndoe",
    "email": "john@example.com",
    "api_key": "vsay_ak_xxxxxxxxxxxxx",
    "avatar_url": "https://example.com/avatar.png",
    "created_at": "2026-01-01T00:00:00Z"
  }
}

Regenerate API Key​

POST /api/profile/regenerate-api-key​

Generate a new API key. The old key will be invalidated immediately.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Response:

{
  "message": "API key regenerated",
  "api_key": "vsay_ak_newkeyhere"
}
Important

Regenerating your API key will disconnect all agents using the old key. You'll need to re-register your agents with the new key.

Reset Password​

POST /api/profile/reset-password​

Change your account password.

Request Body:

{
  "current_password": "oldpassword",
  "new_password": "newpassword"
}
FieldTypeRequiredDescription
current_passwordstringYesYour current password
new_passwordstringYesNew password (min 6 chars)

Response:

{
  "message": "Password updated successfully"
}

Update Avatar​

POST /api/profile/upload-avatar​

Update your profile avatar URL.

Request Body:

{
  "avatar_url": "https://example.com/new-avatar.png"
}

Response:

{
  "message": "Avatar updated",
  "avatar_url": "https://example.com/new-avatar.png"
}

API Key Usage​

Your API key is used when configuring the WebXTerm Agent on your machines:

sudo vsay-agent configure \
  --token YOUR_API_KEY \
  --host http://your-webxterm-instance.com:8080 \
  --linux-user ubuntu

The agent uses this key to authenticate with the backend over gRPC and register the machine under your account. Keep it secure — regenerate it immediately if compromised.

warning

Regenerating your API key will disconnect all agents using the old key. You will need to reconfigure them with vsay-agent configure and the new key.