Assign and list group AI agent assignments
Wellesley Platform API (1.0)
Download OpenAPI description
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/
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/release-username
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/release-username
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/release-username
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.wellesley.social/_mock/openapi/api/v1/admin/release-username?username=string'Request
Performs an administrative search for users with multiple filter criteria. Can search by user ID, account ID, username, domain, display name, state, email, IP address, country, or role. Supports mixed search across username, display name, and email simultaneously. Results include detailed user information and support pagination and sorting. IP addresses are matched exactly, and country codes should use ISO 3166-1 alpha-2 format.
RBAC: requires Users.Manage
Query
Result kind: CHANNEL for only global channels, USER for only users, ALL for both. Default ALL
Enum"CHANNEL""USER""ALL"
Get older records (records with IDs less than this value) Alias maxId/max_id
Example: lastId=?lastId=${data.last().id}
Role
Example: role=
'admin',
'System:admin',
'rr_01hxcvk1hjexere4pvtrj0ymqq',
'System:rr_01hxcvk1hjexere4pvtrj0ymqq',
'gr_1lkjvfdoibb126576:rr_01hxcvk1hjexere4pvtrj0ymqq',
Get newer records (records with IDs greater than this value) Alias minId/min_id
Example: untilId=?untilId=${data.first().id}
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/search
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/search
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.wellesley.social/_mock/openapi/api/v1/admin/search?accountId=us_01hxcvk1hjexere4pvtrj0ymqq&country=string&displayName=string&domain=string&email=string&ip=string&kind=CHANNEL&lastId=%3FlastId%3D%24{data.last%28%29.id}&limit=0&offset=0&role=%0A++++++++%27admin%27%2C%0A++++++++%27System%3Aadmin%27%2C%0A++++++++%27rr_01hxcvk1hjexere4pvtrj0ymqq%27%2C%0A++++++++%27System%3Arr_01hxcvk1hjexere4pvtrj0ymqq%27%2C%0A++++++++%27gr_1lkjvfdoibb126576%3Arr_01hxcvk1hjexere4pvtrj0ymqq%27%2C%0A++++&search=string&sortBy=string&sortOrder=string&state=REGULAR&untilId=%3FuntilId%3D%24{data.first%28%29.id}&userId=us_01hxcvk1hjexere4pvtrj0ymqq&username=string'List of users, number of users found and total number of users on server
List of user details matching the search criteria
ID of the account this user belongs to, empty for remote users
Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
When this user was created
Example: "2022-03-10T16:15:50Z"
When this user was deleted, if applicable
Example: "2022-03-10T16:15:50Z"
When this user was last active
Example: "2022-03-10T16:15:50Z"
Registration mode:
- REGULAR - just regular state
- SENSITIVE - all media attachments are flagged as sensitive, i.e. all user's posts should be marked as sensitive, old posts and all future ones.
- LIMITED - all user's old and future posts should be set maximum to followers only unless user set it to direct himself. non-followers should not be notified, i.e. if user mentions non-follower we do not create notification.
- SUSPENDED - User can login, but cannot do anything in his account except to read, cannot change anything, cannot create new posts or comments etc. All his posts are marked as deleted, but we do not delete them just yet. User is scheduled to be deleted in one month. During this month it is possible to restore it via admin.
Enum"REGULAR""SENSITIVE""LIMITED""SUSPENDED"
Group id if this user is a group channel
Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
Roles assigned to this user
Response
application/json
{ "list": [ { … } ], "total": 0, "totalUsers": 0 }
Request
Changes the moderation state of a user (e.g., ACTIVE, SUSPENDED, LIMITED). This affects what actions the user can perform on the platform. When suspending a user, their content may be hidden and followers on remote servers are notified. When unsuspending, the user's content is restored and remote servers are updated. Administrators cannot change their own state. Changes are logged for audit purposes and can be linked to moderation reports.
RBAC: requires Users.Manage
Registration mode:
- REGULAR - just regular state
- SENSITIVE - all media attachments are flagged as sensitive, i.e. all user's posts should be marked as sensitive, old posts and all future ones.
- LIMITED - all user's old and future posts should be set maximum to followers only unless user set it to direct himself. non-followers should not be notified, i.e. if user mentions non-follower we do not create notification.
- SUSPENDED - User can login, but cannot do anything in his account except to read, cannot change anything, cannot create new posts or comments etc. All his posts are marked as deleted, but we do not delete them just yet. User is scheduled to be deleted in one month. During this month it is possible to restore it via admin.
Enum"REGULAR""SENSITIVE""LIMITED""SUSPENDED"
Example: "SUSPENDED"
Optional report ID if this action is in response to a moderation report.
Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
Optional reason for the state change. Limited to 120 characters. Logged in audit trail.
Example: "Violation of community guidelines - spam behavior"
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/user/change-state
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/user/change-state
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/user/change-state
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.wellesley.social/_mock/openapi/api/v1/admin/user/change-state \
-H 'Content-Type: application/json' \
-d '{
"newState": "SUSPENDED",
"reportId": "report_01234567890abcdef",
"reason": "Violation of community guidelines - spam behavior",
"userId": "user_01234567890abcdef"
}'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
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 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 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
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
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, aname, an optionaldescription, and ascope. - The
scopedefines the domain or area in which the role is valid. - The
scopecan be Global (hardcoded), currently the only one is "System" - The
scopealso 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
createdAtandupdatedAttimestamps 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 allowedRBACAccesstypes. RBACAccessenumerates 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) androleId(specific role ID). - Includes timestamps to record when the assignment was created or updated.
Operations