User Profiles
View public profiles and manage your own profile settings.
User Profiles
Every ModelWorks account has a public profile — a username, a display name, a short bio, and optional links to your website, GitHub, Hugging Face, and Twitter. Profiles are visible to anyone, and they're the home for the circuits and boards you publish.
This guide covers reading public profiles, viewing your own profile and activity feed, and updating your profile or password.
Base URL
All examples assume the following base URL:
https://modelworks.ai/apiAuthentication at a Glance
Profile endpoints split into two flavors — pick the right credential for the job:
| Flavor | Credential | What you can do |
|---|---|---|
| Public | None | Read any public profile, check username availability. |
| API token | mw_ Bearer token | Read your own full profile, fetch your activity feed. |
Important: Profile updates and password changes are not available through the API — you must be logged in to the ModelWorks website. API tokens cannot update profiles or change passwords. See Update Your Profile and Password Management below for the website steps.
Read a Public Profile
GET /users/{username}
Fetch a user's public profile by their username. No auth required.
curl https://modelworks.ai/api/users/janedoeGET /users/id/{uid}
Fetch a user's public profile by their UID. No auth required.
curl https://modelworks.ai/api/users/id/4a1b2c3d-1234-4abc-9def-1234567890abGET /users/check-username/{username}
Check whether a username is available for registration. Public — no auth needed. Useful in sign-up flows before submitting a form.
curl https://modelworks.ai/api/users/check-username/janedoeYour Profile
GET /users/token
Return the current authenticated user based on their API token. This gives you your full profile (more fields than the public view). Requires an API token.
curl https://modelworks.ai/api/users/token \
-H "Authorization: Bearer YOUR_API_TOKEN"GET /users/feed
Get your personal activity feed — recent circuit runs and other account activity. The feed is capped at 30 items. Requires an API token.
curl https://modelworks.ai/api/users/feed \
-H "Authorization: Bearer YOUR_API_TOKEN"Update Your Profile
Updating your profile is done through the ModelWorks website — there is no API endpoint for it.
To update your profile, log in to modelworks.ai, click your avatar (top-right) → Settings → General → Profile. Here you can edit your name, bio, company, location, website, and social links (GitHub, X, HuggingFace). Click Save Changes when done.
| Field | Description |
|---|---|
| Name | Display name shown on your profile. |
| Bio | Short bio. |
| Company | Company or affiliation. |
| Location | Location string (free text). |
| Website | URL of your personal site. |
| GitHub | URL of your GitHub profile. |
| HuggingFace | URL of your Hugging Face profile. |
| X (Twitter) | URL of your Twitter/X profile. |
All fields are optional — update only the ones you want to change.
Password Management
Change Your Password
To change your password, log in to modelworks.ai, click your avatar (top-right) → Settings → Access Controls → Account Password. Enter your current password and new password, then confirm.
Forgot Your Password
If you forgot your password, click the "Forgot password?" link on the login page. You'll receive a reset email with instructions to set a new password.
Error Responses
| HTTP Status | Code | Description |
|---|---|---|
| 400 Bad Request | BadClientData | Invalid payload, or missing required field. |
| 401 Unauthorized | Unauthorized | Missing or invalid API token. |
| 404 Not Found | NotFound | User does not exist. |