Assign and list group AI agent assignments
Wellesley Platform API (1.0)
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.
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.
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.
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.
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.
- PUBLIC - Open Content. Content and membership are viewable by anyone.
- PRIVATE - Members-Only Content. Outsiders cannot see posts or members unless they join.
- VISIBLE - The group is listed openly. It shows up in search results or directory listings.
- UNLISTED - The group does not appear in public lists but is accessible via direct link.
- HIDDEN - The group is completely hidden and invite-only. Shared links will return 404 for non-members.
- OPEN - Anyone can join the group immediately without approval.
- APPROVAL - User requests must be approved by a group admin or moderator.
- INVITE_ONLY - Only users with an invitation from a member can join.
Unique group name used in URLs. Must be alphanumeric with underscores/hyphens, 3-30 characters.
Human-readable display name for the group. Can contain spaces and special characters.
Detailed description of the group's purpose and activities. Supports markdown formatting.
Custom fields for the group
Additional metadata for the group including rules, guidelines, and custom fields
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/groups
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/groups
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/groups
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.wellesley.social/_mock/openapi/api/v1/groups \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"privacy": "PUBLIC",
"visibility": "VISIBLE",
"joinMode": "OPEN",
"bannerId": "us_01hxcvk1hjexere4pvtrj0ymqq",
"avatarId": "us_01hxcvk1hjexere4pvtrj0ymqq",
"location": {
"geo": {
"latitude": 0.1,
"longitude": 0.1,
"altitude": 0.1,
"accuracy": 0.1,
"verticalAccuracy": 0.1,
"speed": 0.1,
"bearing": 0.1,
"timestamp": 0
},
"name": "string",
"autoUpdate": true,
"show": true
},
"timezone": {
"ianaTimezone": "string",
"autoUpdate": true,
"show": true
},
"name": "string",
"displayName": "string",
"description": "string",
"fields": {
"property1": {
"value": "string",
"verifiedAt": "2022-03-10T16:15:50Z"
},
"property2": {
"value": "string",
"verifiedAt": "2022-03-10T16:15:50Z"
}
},
"meta": {
"color": "string"
},
"type": "CHANNEL"
}'Successfully created the new group
group metadata including color
- PUBLIC - Open Content. Content and membership are viewable by anyone.
- PRIVATE - Members-Only Content. Outsiders cannot see posts or members unless they join.
- VISIBLE - The group is listed openly. It shows up in search results or directory listings.
- UNLISTED - The group does not appear in public lists but is accessible via direct link.
- HIDDEN - The group is completely hidden and invite-only. Shared links will return 404 for non-members.
- OPEN - Anyone can join the group immediately without approval.
- APPROVAL - User requests must be approved by a group admin or moderator.
- INVITE_ONLY - Only users with an invitation from a member can join.
ID of the forum associated with this group
Custom fields for the group
{ "meta": { "color": "string" }, "privacy": "PUBLIC", "visibility": "VISIBLE", "joinMode": "OPEN", "location": { "geo": { … }, "name": "string", "autoUpdate": true, "show": true }, "timezone": { "ianaTimezone": "string", "autoUpdate": true, "show": true }, "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq", "groupName": "string", "domain": "string", "displayName": "string", "summary": "string", "uri": "http://example.com", "publicKey": "string", "privateKey": "string", "forumId": "us_01hxcvk1hjexere4pvtrj0ymqq", "stats": { "property1": null, "property2": null }, "fields": { "property1": { … }, "property2": { … } }, "type": "CHANNEL", "membersUrl": "string", "banner": { "uploadId": "up_kjhwieuy2387928371", "userId": "us_97234khddqdkuhqwij", "uploadType": "video", "meta": { … }, "size": 0, "files": [ … ], "tags": [ … ], "error": "string", "cached": true, "logs": "string", "remote": true, "createdAt": "2022-03-10T16:15:50Z", "updatedAt": "2022-03-10T16:15:50Z" }, "avatar": { "uploadId": "up_kjhwieuy2387928371", "userId": "us_97234khddqdkuhqwij", "uploadType": "video", "meta": { … }, "size": 0, "files": [ … ], "tags": [ … ], "error": "string", "cached": true, "logs": "string", "remote": true, "createdAt": "2022-03-10T16:15:50Z", "updatedAt": "2022-03-10T16:15:50Z" }, "deletedAt": "2022-03-10T16:15:50Z", "createdAt": "2022-03-10T16:15:50Z", "updatedAt": "2022-03-10T16:15:50Z", "membersCount": 0 }
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/groups/my-groups
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/groups/my-groups
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/groups/my-groups
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.wellesley.social/_mock/openapi/api/v1/groups/my-groups?lastId=%3FlastId%3D%24{data.last%28%29.id}&limit=0&offset=0&sortBy=string&sortOrder=string&untilId=%3FuntilId%3D%24{data.first%28%29.id}' \
-H 'Authorization: YOUR_API_KEY_HERE'[ { "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq", "name": "string", "displayName": "string", "summary": "string", "avatar": { … }, "header": { … }, "meta": { … }, "pin": 0, "isOwner": true, "canManage": true, "role": "string", "createdAt": "2022-03-10T16:15:50Z" } ]
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/groups/name/{groupname}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/groups/name/{groupname}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/groups/name/{groupname}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.wellesley.social/_mock/openapi/api/v1/groups/name/wine-loversGroup details retrieved successfully
group metadata including color
- PUBLIC - Open Content. Content and membership are viewable by anyone.
- PRIVATE - Members-Only Content. Outsiders cannot see posts or members unless they join.
- VISIBLE - The group is listed openly. It shows up in search results or directory listings.
- UNLISTED - The group does not appear in public lists but is accessible via direct link.
- HIDDEN - The group is completely hidden and invite-only. Shared links will return 404 for non-members.
- OPEN - Anyone can join the group immediately without approval.
- APPROVAL - User requests must be approved by a group admin or moderator.
- INVITE_ONLY - Only users with an invitation from a member can join.
ID of the forum associated with this group
Custom fields for the group
{ "meta": { "color": "string" }, "privacy": "PUBLIC", "visibility": "VISIBLE", "joinMode": "OPEN", "location": { "geo": { … }, "name": "string", "autoUpdate": true, "show": true }, "timezone": { "ianaTimezone": "string", "autoUpdate": true, "show": true }, "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq", "groupName": "string", "domain": "string", "displayName": "string", "summary": "string", "uri": "http://example.com", "publicKey": "string", "privateKey": "string", "forumId": "us_01hxcvk1hjexere4pvtrj0ymqq", "stats": { "property1": null, "property2": null }, "fields": { "property1": { … }, "property2": { … } }, "type": "CHANNEL", "membersUrl": "string", "banner": { "uploadId": "up_kjhwieuy2387928371", "userId": "us_97234khddqdkuhqwij", "uploadType": "video", "meta": { … }, "size": 0, "files": [ … ], "tags": [ … ], "error": "string", "cached": true, "logs": "string", "remote": true, "createdAt": "2022-03-10T16:15:50Z", "updatedAt": "2022-03-10T16:15:50Z" }, "avatar": { "uploadId": "up_kjhwieuy2387928371", "userId": "us_97234khddqdkuhqwij", "uploadType": "video", "meta": { … }, "size": 0, "files": [ … ], "tags": [ … ], "error": "string", "cached": true, "logs": "string", "remote": true, "createdAt": "2022-03-10T16:15:50Z", "updatedAt": "2022-03-10T16:15:50Z" }, "deletedAt": "2022-03-10T16:15:50Z", "createdAt": "2022-03-10T16:15:50Z", "updatedAt": "2022-03-10T16:15:50Z", "membersCount": 0 }
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.
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.