Documentation.

Authenticate and set a session cookie on the response. Send "email", or send "username" — which takes a name or an address, as the sign-in form does. At least one is required; if both are sent, "username" is the one used. Failures answer 401 for bad credentials, 422 for a body the validator refused, or 403 with a code of account_banned or account_suspended.

{ "email": "user@example.com", "password": "secret" }

{ "success": true, "user": { "id": "…", "username": "alice", "role": "user" }, "redirectTo": "/home" }

Step one of registration. Returns a proof-of-work challenge, its difficulty and the rule to satisfy. Find any nonce where the hex SHA-256 of the challenge and the nonce concatenated begins with that many zeros, then send the challenge and the nonce to the register endpoint. A challenge lasts 10 minutes and is good for one attempt.

{ "success": true, "data": { "challenge": "…", "difficulty": 5, "algorithm": "sha256", "rule": "hex(sha256(challenge + nonce)) must start with 5 zeros", "expiresInSeconds": 600 } }

Create a new account. Requires a solved challenge from the endpoint above; the same proof-of-work protects the browser form. Usernames are 3 to 20 characters, letters, numbers and underscores. Proof-of-work failures carry a code of pow_missing, pow_invalid, pow_expired or pow_already_used. Limited to 6 attempts an hour and 5 accounts a day from one address.

{ "username": "alice", "email": "user@example.com", "password": "secret", "_pow_challenge": "…", "_pow_nonce": "48213" }

{ "success": true, "user": { "id": "…", "username": "alice" }, "redirectTo": "/home" }

Invalidate the current session.

{ "success": true }

The authenticated account in full. Requires authentication.

{ "success": true, "user": { "id": "…", "username": "alice", "email": "…", "role": "user", "plan": "free", "storage_used": 0 } }

A user's public profile, looked up by username or id.

Parameters

• username optional username to look up
• userId optional user id to look up

{ "success": true, "profile": { "username": "alice", "bio": "…", "avatar_url": "…" } }

Change fields on the authenticated account.

{ "bio": "My new bio", "display_username": "Alice" }

{ "success": true, "user": { … } }

Multipart form-data. Images only, 5 MB ceiling.

Content-Type: multipart/form-data
field: avatar   (image file, max 5MB)

{ "success": true, "avatarUrl": "https://cdn.weggle.xyz/…" }

Match accounts by username.

Parameters

• q required search query, two characters minimum
• limit optional max results, default 10

{ "success": true, "users": [{ "username": "alice", "avatar_url": "…" }] }

Files belonging to the authenticated account.

Parameters

• limit optional max results, default 25, ceiling 100
• offset optional pagination offset
• search optional filename search
• type optional mime prefix, e.g. image/
• publicStatus optional true or false

{
  "success": true,
  "data": {
    "files": [{ "id": 1, "filename": "photo.jpg", "mimeType": "image/jpeg", "size": 102400,
                "humanReadableSize": "100 KB", "isPublic": false, "downloadCount": 0, "url": "/file/1" }],
    "pagination": { "total": 42, "limit": 25, "offset": 0, "hasMore": true }
  }
}

Metadata for one file. Private files require the owner's credentials.

Parameters

• fileId required integer file id, in the path

{ "success": true, "data": { "file": { "id": 1, "filename": "photo.jpg", "size": 102400, "url": "/file/1" } } }

Multipart form-data. The size ceiling depends on the account plan.

Content-Type: multipart/form-data
field: file       (required, binary)
field: isPublic   (optional, boolean, default false)

{ "success": true, "file": { "id": 1, "url": "/file/1" } }

Rename a file or change its visibility.

Parameters

• fileId required path parameter

{ "filename": "new-name.jpg", "isPublic": true }

{ "success": true, "file": { … } }

Permanent. There is no recycle bin behind this.

Parameters

• fileId required path parameter

{ "success": true, "message": "File deleted" }

Memes belonging to the authenticated account.

Parameters

• limit optional max results, default 25, ceiling 100
• offset optional pagination offset
• templateId optional filter by template

{
  "success": true,
  "data": {
    "memes": [{ "id": 1, "title": "My Meme", "templateId": "drake", "isPublic": true,
                "viewCount": 42, "imageUrl": "/meme/1/view" }],
    "pagination": { "total": 5, "limit": 25, "offset": 0, "hasMore": false }
  }
}

Render a template with your own text. Needs write:memes on the key.

{ "templateId": "drake", "title": "My Meme", "textFields": ["top text", "bottom text"], "isPublic": true }

{ "success": true, "meme": { "id": 1, "imageUrl": "/meme/1/view" } }

Removes a meme you own.

Parameters

• memeId required path parameter

{ "success": true }

Every accepted friendship for the current account.

{ "success": true, "friends": [{ "id": "…", "username": "bob" }] }

Open a friend request to another account.

{ "addresseeId": 123 }

{ "success": true, "friendship": { "status": "pending" } }

Accept or decline an incoming request.

{ "friendshipId": "…", "action": "accept" }

{ "success": true }

Accounts following the current user.

{ "success": true, "followers": [{ "username": "…" }], "total": 42 }

Follow another account.

{ "followingId": 123 }

{ "success": true }

Public wall posts, paginated.

Parameters

• page optional page number, default 1

{ "success": true, "posts": [{ "id": "…", "content": "Hello world", "username": "alice" }] }

Post to the public wall. Requires authentication.

{ "content": "Hello, world!" }

{ "success": true, "post": { "id": "…" } }

Every direct thread the current account is part of.

{ "success": true, "data": [{ "id": 12, "other_username": "bob", "last_content": "Hey!", "unread": 2 }] }

Everyone the account can message right now, built from accepted friendships.

{ "success": true, "data": [{ "id": "…", "username": "bob", "status": "online", "conversation_id": 12 }] }

Finds or creates the direct conversation with one user.

Parameters

• username required path parameter

{ "success": true, "data": { "conversationId": 12, "other": { "username": "bob" } } }

One page of messages, newest last. Pass ?before=<id> for older ones.

Parameters

• id required path parameter
• before optional message id to page back from

{ "success": true, "data": [{ "id": 88, "content": "Hello!", "sender_id": "…" }], "hasMore": false }

Post into a conversation the account is a participant of.

Parameters

• id required path parameter

{ "content": "Hello!" }

{ "success": true, "data": { "id": 89, "content": "Hello!" } }

Author, group admin or staff only.

Parameters

• id required path parameter

{ "success": true, "data": { "id": 89 } }

Every group the account belongs to.

{ "success": true, "data": [{ "id": 4, "group_name": "Crew", "member_count": 3, "my_role": "admin" }] }

Every subscription tier and what it includes.

{ "success": true, "plans": [{ "id": "free", "name": "Free", "storage": 5368709120 }] }

The authenticated account's active plan and usage.

{ "success": true, "subscription": { "plan": "free", "storage_used": 0, "storage_limit": 5368709120 } }