Skip to content

Wellesley Platform API (1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.wellesley.social/_mock/openapi/
Simple setup, all in one. Digital Ocean
https://dust.allroads.social/
Simple setup, db is separate. Digital Ocean
https://meteor.allroads.social/

AI Agents

Assign and list group AI agent assignments

Operations

Accounts

Account management and authentication endpoints. Handles user registration, login flows (email/phone), profile management, and account lifecycle operations. Supports multi-step signup with email/SMS verification, CAPTCHA, and optional admin approval.

Operations

ActivityPub

WebFinger endpoint for ActivityPub user discovery and federation

Addresses

Endpoints for suggesting and validating physical addresses

Operations

Admin

Development and testing endpoints for populating the database with test data

Admin Accounts

Administrative endpoints for account and user management. Provides comprehensive tools for managing user accounts, including creation, deletion, role assignment, password management, state changes, and user impersonation for bot accounts.

Operations

Admin ActivityPub

Administrative endpoints for ActivityPub

Operations

Admin Audit

Administrative endpoints for viewing and managing audit logs. Provides comprehensive logging of all security-relevant actions performed in the system.

Operations

Admin Domain Blocks

Administrative APIs for managing domain blocks. Provides endpoints to block specific domains with different severity levels (SUSPEND, LIMIT, NOOP), update existing blocks, unblock domains, and list currently blocked domains. Domain blocks prevent or limit federation with specified domains.

Operations

Admin Domains Allow List

Administrative endpoints for managing domain allowlists. When domain allowlisting is enabled, only domains in this list can federate with the instance.

Operations

Admin Email Allow List

Administrative endpoints for managing email domain allowlist used for registrations.

Operations

Admin Email Blocks

Administrative APIs for managing email blocks to prevent unwanted signups. Supports blocking specific email addresses and entire domains. Email blocks are automatically normalized and checked during user registration.

Operations

Admin Federation Metrics

Administrative endpoints for monitoring and managing federation with other ActivityPub instances. Provides metrics on connected domains, user counts, post statistics, and federation health monitoring.

Operations

List federated domains

Request

Retrieves a paginated list of all domains this instance is federated with, including user counts, availability status, and blocking state. Supports filtering by domain name, availability, and block status.

Query
blockStateArray of strings or null(DomainBlockState)

Filter by blocking state(s) - accepts single state or comma-separated list (LIMITED, SUSPENDED, NOOP)

Enum"SUSPEND""LIMIT""NOOP"
lastIdstring or null

Get older records (records with IDs less than this value) Alias maxId/max_id

Example: lastId=?lastId=${data.last().id}
limitinteger or null(int32)
offsetinteger or null(int32)
searchstring or null

Filter domains by name

sortBystring or null
sortOrderstring or null
unavailableboolean or null

Filter only unavailable domains (7+ days not responding)

untilIdstring or null

Get newer records (records with IDs greater than this value) Alias minId/min_id

Example: untilId=?untilId=${data.first().id}
warningboolean or null

Filter only failing domains (1+ days not responding)

curl -i -X GET \
  'https://docs.wellesley.social/_mock/openapi/api/v1/admin/federation?blockState=SUSPEND&lastId=%3FlastId%3D%24{data.last%28%29.id}&limit=0&offset=0&search=string&sortBy=string&sortOrder=string&unavailable=true&untilId=%3FuntilId%3D%24{data.first%28%29.id}&warning=true'

Responses

Successfully retrieved list of federated domains

Bodyapplication/json
listArray of objects(ServersResultInfo)required
list[].​domainstringrequired
list[].​usersinteger(int64)
list[].​failureDaysinteger(int32)required

N of days federation has been unavailable for this domain

list[].​availableboolean
list[].​allowedbooleanrequired

Whether it's whitelisted when limited federation mode is on

list[].​blockedstring or null

Registration mode:

  • SUSPEND - removes all content, media, and profile data for this domain's accounts from your server.
  • LIMIT - makes posts from accounts at this domain invisible to anyone who isn't following them.
  • NOOP - when you just want to reject media files or reports.
Enum"SUSPEND""LIMIT""NOOP"
list[].​reportsinteger(int32)
list[].​rejectMediaboolean or null

Whether media files from this domain are rejected

list[].​rejectReportsboolean or null

Whether reports from this domain are rejected

totalinteger(int32)
failureThresholdnumber(double)required

Duration in seconds

Example: "3600"
Response
application/json
{
  "list": [
    { … }
  ],
  "total": 0,
  "failureThreshold": "3600"
}

List tracked ActivityPub operations

Request

Retrieves a list of all ActivityPub operations that have been tracked on this server. An operation combines the Activity type with the inner object type (if present). Examples: 'create-note' (Create activity with Note object), 'follow' (Follow activity), 'accept-follow' (Accept activity with Follow object), 'announce' (boost/reblog), 'undo-announce'.

RBAC:

  • requires ANY of Federation.Read, Federation.Manage
Query
windowstring or null

Time window to check for operations (defaults to 24h)

Enum"TEN_MINUTES""ONE_HOUR""TWENTY_FOUR_HOURS"
Example: window=ONE_HOUR
curl -i -X GET \
  'https://docs.wellesley.social/_mock/openapi/api/v1/admin/federation/metrics/operations?window=ONE_HOUR'

Responses

Successfully retrieved list of tracked operations

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "follow",
  "accept-follow",
  "create-note",
  "announce",
  "undo-follow",
  "like",
  "undo-like"
]

Get metrics for specific operation

Request

Returns sliding window metrics for a single ActivityPub operation, including count, average processing time, and percentiles. The metrics are calculated over the specified time window. Returns 404 if no data exists for the operation or the window has expired.

RBAC:

  • requires ANY of Federation.Read, Federation.Manage
Query
operationstringrequired

The ActivityPub operation to get metrics for

Example: operation=follow
windowstring(WindowSize)required

Time window for metric calculation (e.g., ONE_HOUR, SIX_HOURS, TWENTY_FOUR_HOURS)

Enum"TEN_MINUTES""ONE_HOUR""TWENTY_FOUR_HOURS"
Example: window=ONE_HOUR
curl -i -X GET \
  'https://docs.wellesley.social/_mock/openapi/api/v1/admin/federation/metrics/running-average-single?operation=follow&window=ONE_HOUR'

Responses

Successfully retrieved operation metrics

Bodyapplication/json
averagenumber(double)required

Average duration in milliseconds for operations in this window

countinteger(int64)required

Total number of operations recorded in this window

totalTimeinteger(int64)required

Sum of all operation durations in milliseconds

lastUpdatedstring(date-time)required

When the last metric was added to this window

Example: "2022-03-10T16:15:50Z"
operationstringrequired

The operation name being tracked

windowCreatedstring(date-time)required

When this window was created (first metric timestamp)

Example: "2022-03-10T16:15:50Z"
Response
application/json
{
  "average": 0.1,
  "count": 0,
  "totalTime": 0,
  "lastUpdated": "2022-03-10T16:15:50Z",
  "operation": "string",
  "windowCreated": "2022-03-10T16:15:50Z"
}

Get metrics for multiple operations

Request

Returns sliding window metrics for all ActivityPub operations or a filtered subset. Only includes operations that have active data within the specified time window. Each operation's metrics include count, average processing time, and percentiles.

RBAC:

  • requires ANY of Federation.Read, Federation.Manage
Query
operationsArray of strings or null

Comma-separated list of specific operations to get metrics for. If omitted, returns all operations.

Example: operations=follow,create-note,announce
windowstring(WindowSize)required

Time window for metric calculation

Enum"TEN_MINUTES""ONE_HOUR""TWENTY_FOUR_HOURS"
Example: window=TWENTY_FOUR_HOURS
curl -i -X GET \
  'https://docs.wellesley.social/_mock/openapi/api/v1/admin/federation/metrics/running-averages-all?operations=follow%2Ccreate-note%2Cannounce&window=TWENTY_FOUR_HOURS'

Responses

Map of operation names to their corresponding metrics

Bodyapplication/json
property name*object(SlidingWindowMetrics)additional property

Wall-clock aligned tumbling window metrics for monitoring operation performance over time periods.

Key Features:

  • Windows are aligned to wall-clock boundaries (e.g., 10:00-10:10, 10:10-10:20)
  • All operations share the same window boundaries for consistent comparison
  • Windows reset completely when they expire (tumbling, not sliding)
  • Memory-efficient with constant storage per operation per window

Synchronous Boundaries: All operations use identical window start/end times

10:05 - "follow" metric     → Window: 10:00-10:10
10:07 - "create-note" metric → Window: 10:00-10:10 (same window)
10:11 - "follow" metric     → Window: 10:10-10:20 (new window)

Complete Reset on Expiration:

Window 10:00-10:10: follow(avg=150ms, count=45)
Window 10:10-10:20: follow(avg=200ms, count=12) ← Fresh start

Gap Handling:

10:05 - Metrics recorded → Window: 10:00-10:10
[No activity for 25 minutes]
10:35 - New metric      → Window: 10:30-10:40 ← Fresh window

Previous windows (10:10-10:20, 10:20-10:30) remain empty/non-existent.

Limitations:

  • Not true sliding: Old data is completely lost when windows expire
  • Coarse granularity: Only shows averages per window, not sub-window patterns
  • No historical depth: Only current window data is retained

UI Display Recommendations:

"Follow operations: 150ms avg (45 ops, 10:00-10:10, last updated 10:08:30)"

Use windowCreated and lastUpdated to show clear time boundaries and data freshness.

Response
application/json
{
  "property1": {
    "average": 0.1,
    "count": 0,
    "totalTime": 0,
    "lastUpdated": "2022-03-10T16:15:50Z",
    "operation": "string",
    "windowCreated": "2022-03-10T16:15:50Z"
  },
  "property2": {
    "average": 0.1,
    "count": 0,
    "totalTime": 0,
    "lastUpdated": "2022-03-10T16:15:50Z",
    "operation": "string",
    "windowCreated": "2022-03-10T16:15:50Z"
  }
}

Get domain federation details

Request

Retrieves detailed federation statistics for a specific domain, including user counts, post counts, follower/following relationships, reports, availability status, and blocking information.

RBAC:

  • requires ANY of Federation.Read, Federation.Manage
Path
domainstring\Srequired

Domain name to get federation details for

Example: mastodon.social
curl -i -X GET \
  https://docs.wellesley.social/_mock/openapi/api/v1/admin/federation/mastodon.social

Responses

Successfully retrieved domain federation information

Bodyapplication/json
usersinteger(int64)
postsinteger(int64)
followersinteger(int64)required

N of remote users who are being followed from this server

followingsinteger(int64)required

N of local users who follow users on this domain

reportsinteger(int32)required

N of reports against users of this domain

availablebooleanrequired

Whether it's whitelisted when limited federation mode is on

failureDaysinteger(int32)required

N of days federation has been unavailable for this domain

failureThresholdnumber(double)required

Duration in seconds

Example: "3600"
blockedobject or null
Response
application/json
{
  "users": 0,
  "posts": 0,
  "followers": 0,
  "followings": 0,
  "reports": 0,
  "available": true,
  "failureDays": 0,
  "failureThreshold": "3600",
  "blocked": {
    "domain": "spam.example",
    "publicComment": "Repeated spam violations",
    "state": "SUSPEND",
    "rejectMedia": true,
    "rejectReports": false,
    "privateComment": "Multiple verified spam reports from trusted instances",
    "obfuscate": false,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-16T14:20:00Z"
  }
}

Admin Feeds

Administrative endpoints for managing user feeds and cache

Operations

Admin Groups

Administrative endpoints for Groups management

Operations

Admin Init

Administration endpoints for system initialization and updates

Admin Posts

Administrative endpoints for managing posts. Provides moderation capabilities to delete posts that violate community guidelines or are part of reported content.

Operations

Admin Reports

Administrative endpoints for managing user reports and moderation. Provides tools for reviewing, assigning, resolving, and annotating reports about users, posts, and groups. Supports workflow management with assignment, notes, and resolution tracking.

Operations

Admin Signup Requests

Administrative endpoints for managing user signup requests. Provides tools for reviewing, approving, rejecting, and managing signup requests in moderation queue. Supports workflow for manual account approval when enabled.

Operations

Admin Uploads

Administrative endpoints for managing file uploads and media storage. Provides tools for monitoring user storage usage, searching uploaded files, and managing upload processing jobs. Supports queue management for async upload processing workflows.

Operations

Aliases

Endpoints for managing previous usernames and username aliases

Operations

Application Data

Endpoints for managing application-specific data storage. Provides a flexible key-value storage system for applications to store custom data associated with users, groups, or the platform. Supports tagging, filtering, and ownership-based access control.

Operations

Applications

Endpoints for serving and routing platform applications to users

Operations

Blocks

User blocking functionality for preventing interaction with specific users. Blocking a user prevents them from following you, seeing your posts, or interacting with your content. Block operations are federated to remote servers when blocking remote users.

Operations

Categories

Endpoints for managing forum-specific categories

Operations

Domain Blocks

Public API for listing domains blocked by this instance. Visibility and reason details are controlled by platform settings.

Operations

Domain-blocks

Endpoints for managing user-level domain blocks to filter content from specific servers

Operations

Drafts

Endpoints for creating, reading, updating, and deleting drafts, as well as publishing them to posts

Operations

Email

Email address management for user accounts. Provides secure email change workflow with verification codes, password confirmation, and notification system. All email changes require authentication and are logged for security.

Operations

Emoji

Custom emoji management system for the platform. Supports creating, uploading, importing/exporting, searching, and deleting custom emojis. Emojis are automatically resized and optimized. Admin-only operations require Emojis.Manage permission.

Operations

Events

Endpoints for creating, retrieving, and managing events and attendees

Operations

Events ActivityPub

ActivityPub-compatible endpoint for events

Follow

User follow relationship management. Handles following/unfollowing users, managing follow requests, and querying follower/followee relationships. Supports both local and remote (federated) users with ActivityPub protocol integration.

Operations

Forums

Endpoints for managing discussion forums, including creation, retrieval, and deletion

Operations

Geo

Endpoints for geographic location lookup and timezone services

Operations

Group Applications

Endpoints for managing applications available to groups, including listing, adding, and removing group-specific applications

Operations

Group Channels

API endpoints for managing channels within groups. Channels are specialized accounts that enable organized content distribution within groups. They support hierarchical organization with main and default channels, privacy controls inherited from parent groups, and both scoped (group-specific) and global usernames for discovery. Group administrators manage channels while members can follow them.

Operations

Group Member Settings

Endpoints for managing member-specific settings within groups. These settings are personal to each group member and affect their individual experience within the group. Members can only access and modify their own settings within groups they belong to.

Operations

Group Members

API endpoints for managing group membership. Provides functionality to add, update, and remove members from groups, as well as retrieve membership information. Supports both local and federated groups through ActivityPub protocol. Access control is enforced based on group privacy settings and user permissions.

Operations

Group Questions

API endpoints for managing group entry questions. Groups can require prospective members to answer questions before joining. Questions support multiple types (text, single choice, multiple choice) and are used to screen members when the group's join mode is set to QUESTIONS. Answers are validated and generate a token that can be used during the join process.

Operations

Group Reports

Group-scoped moderation reports. Allows group admins to review and resolve reports targeting their channels, forums, and events without global moderator access.

Operations

Group Rules

API endpoints for managing community rules within groups. Rules define the expected conduct and content policies that members must follow. Each rule consists of text (the rule itself), a hint (explanation or context), and an ordering value for display sequence. Rules are scoped to specific groups and can be managed by users with appropriate permissions.

Operations

Group Settings

Endpoints for managing group-specific settings and configuration options. These endpoints allow authorized group members to view, update, and delete settings that control group behavior, features, and customization options.

Operations

Groups

API endpoints for managing groups within the Wellesley platform. Groups are community spaces that can be public or private, support forums, and have their own membership and permission systems. Groups can be federated via ActivityPub for cross-instance communication.

Operations

Import

Endpoints for importing data from other platforms including followers, blocks, and mutes

Operations

Instance

Server instance information and configuration. Provides metadata about the server, compatible domains, supported languages, timezones, and countries. All endpoints are publicly accessible without authentication.

Operations

Invites

Endpoints for sending and managing user invitations

Operations

Jobs

Endpoints for monitoring and managing background job queues, including statistics, job listings, and queue monitoring

Operations

Lists

Endpoints for managing user lists for organizing and grouping followed accounts

Operations

Logins

Endpoints for managing user login methods including email, password, and phone authentication

Operations

Metrics

Endpoints for retrieving metrics and analytics data from the events stream

Operations

Mutes

Endpoints for managing user mutes to hide content from specific users

Operations

Notes

Endpoints for managing personal notes about other users

Operations

Notifications

Endpoints for managing user notifications including retrieving, counting, and marking notifications as read or unread

Operations

Passkeys

Passkey (WebAuthn) registration and authentication

Operations

Password

Endpoints for password management including changing, resetting, and recovering passwords

Operations

Pins

Endpoints for pinning posts to profiles and retrieving pinned posts

Operations

Platform Data

Endpoints for managing platform-wide and group-specific data storage. Unlike application data, this provides direct data management not tied to specific applications. Supports flexible ownership models including platform-level, group-level, and user-level data with appropriate access controls.

Operations

Platform Settings

Endpoints for managing platform-wide settings and configuration options. These endpoints control server-level settings that affect the entire platform, including features, limits, security policies, and default behaviors for all users and groups.

Operations

Polls

Endpoints for interacting with polls, including voting and retrieving results

Operations

Posts

Endpoints for creating, reading, updating, and deleting posts, as well as managing comments, likes, bookmarks, and reposts

Operations

RBAC

Endpoints for retrieving Role-Based Access Control (RBAC) configurations and managing roles, resources, permissions and role-to-user assignments. Scoped Role Definition (RBACRole):

  • Represents roles within the RBAC system.
  • Each role has a unique roleId, a name, an optional description, and a scope.
  • The scope defines the domain or area in which the role is valid.
  • The scope can be Global (hardcoded), currently the only one is "System"
  • The scope also can be dynamic, currently we use Group Ids, like "gr_05hxcvk1hjexere4pvtrj0hggt"
  • Roles come with assigned permissions (RBACPermissions) that define what actions the role can perform on system resources.
  • Metadata such as createdAt and updatedAt timestamps track the role's lifecycle events.

Permissions** (RBACPermissions):

  • Encapsulates resource-specific access controls.
  • Each permission object specifies the resource (e.g., "user", "document") and an associated list of allowed RBACAccess types.
  • RBACAccess enumerates the supported actions: Read, Add, Modify, Delete.

Role Assignments to Actors (RBACActorRole):

  • Maps actors (e.g., users, services) to specific roles.
  • Tracks the association through actorId (representing the unique entity being assigned) and roleId (specific role ID).
  • Includes timestamps to record when the assignment was created or updated.
Operations

Remote collections

API to retrieve followers and following collections for remote users.

Operations

Reports

Endpoints for reporting content and managing content reports

Operations

Rules

Endpoints for managing platform rules that govern user conduct and content policies

Operations

Sessions

Endpoints for managing user authentication sessions and device logins

Operations

Tags

Endpoints for managing hashtags, including following, featuring, and retrieving tag information

Operations

Tags v2

Scoped tags search, policy lists and reports

Operations

Translation

Endpoints for translating text between languages

Operations

Uploads

Endpoints for uploading, retrieving, and managing media files

Operations

User Devices

APIs for managing user devices for push notifications

Operations

User Settings

Endpoints for managing user-specific settings and preferences. These endpoints allow authenticated users to view, update, and delete their personal settings that control their account behavior, interface preferences, privacy options, and feature customizations.

Operations

Users

Endpoints for managing user profiles, including creation, retrieval, updates, and moderation

Operations

employee

Employee. DO NOT USE, SUBJECT TO CHANGE/REMOVE

employer

Employer. DO NOT USE, SUBJECT TO CHANGE/REMOVE

job-applications

Jobs. DO NOT USE, SUBJECT TO CHANGE/REMOVE

job-postings

Jobs. DO NOT USE, SUBJECT TO CHANGE/REMOVE

phone

Phone management

Operations

Fasp Resource

Operations

Debug Resource

Operations

Test Authenticated Controller

Operations

Test Class Auth Controller

Operations

Test Class Authenticated Controller

Operations

Test Class Permit All Controller

Operations

Test Permit All Controller

Operations

Test Authorization Controller

Operations

Quarkus Test Resource For Transaction

Operations