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/
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
Request
Retrieves the complete list of rules for a specific group. Rules are returned in order based on their ordering value (lowest first). This endpoint is publicly accessible as group rules should be visible to potential members before joining. Each rule includes its text content, explanatory hint, and display ordering.
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/groups/{groupId}/rules
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/groups/{groupId}/rules
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/groups/{groupId}/rules
- 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/gr_01hz1f0kw36f82k9s4nzpc4s92n/rulesList of all group rules sorted by ordering value
The rule text that defines expected behavior or policy (max 500 characters)
Example: "Be respectful to all members"
Additional context or clarification for the rule (max 500 characters)
Example: "This includes no harassment, personal attacks, or discriminatory language"
Display order position - rules with lower values appear first
Example: 1000
Response
application/json
[ { "id": "rl_01hz1f0gs9fe4a37jzvzn9m96k", "text": "Be respectful to all members", "hint": "Treat all group members with respect and kindness", "ordering": 1000 } ]
Request
Creates a new rule for the specified group. Requires GroupSettings.Manage permission. The rule will be assigned a unique ID and added to the group's rule list. Rules are used to establish community guidelines and expected behavior. An audit log entry is created for this action.
RBAC: requires GroupSettings.Manage
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/groups/{groupId}/rules
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/groups/{groupId}/rules
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/groups/{groupId}/rules
- 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/gr_01hz1f0kw36f82k9s4nzpc4s92n/rules?hint=This+includes+no+personal+attacks%2C+harassment%2C+or+discriminatory+language&ordering=1000&text=Be+respectful+to+all+members'Successfully created the new rule
The rule text that defines expected behavior or policy (max 500 characters)
Example: "Be respectful to all members"
Additional context or clarification for the rule (max 500 characters)
Example: "This includes no harassment, personal attacks, or discriminatory language"
Display order position - rules with lower values appear first
Example: 1000
Response
application/json
{ "text": "Be respectful to all members", "hint": "This includes no harassment, personal attacks, or discriminatory language", "ordering": 1000, "id": "rl_01hz1f0gs9fe4a37jzvzn9m96k" }
Request
Batch updates the display ordering of multiple rules within a group. This endpoint allows efficient reordering of rules without individual API calls. Requires GroupSettings.Manage permission. Each reordering operation is tracked in the audit log. Rules not included in the request maintain their current ordering. Returns all group rules with updated ordering values.
RBAC: requires GroupSettings.Manage
The unique identifier of the rule to reorder
Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
New display order position (lower values appear first)
Example: 1000
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/groups/{groupId}/rules/reorder
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/groups/{groupId}/rules/reorder
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/groups/{groupId}/rules/reorder
- 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/gr_01hz1f0kw36f82k9s4nzpc4s92n/rules/reorder \
-H 'Content-Type: application/json' \
-d '[
{
"id": "rl_01hz1f0gs9fe4a37jzvzn9m96k",
"ordering": 1000
}
]'All group rules with updated ordering
The rule text that defines expected behavior or policy (max 500 characters)
Example: "Be respectful to all members"
Additional context or clarification for the rule (max 500 characters)
Example: "This includes no harassment, personal attacks, or discriminatory language"
Display order position - rules with lower values appear first
Example: 1000
Response
application/json
[ { "text": "Be respectful to all members", "hint": "This includes no harassment, personal attacks, or discriminatory language", "ordering": 1000, "id": "rl_01hz1f0gs9fe4a37jzvzn9m96k" } ]
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/groups/{groupId}/rules/{id}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/groups/{groupId}/rules/{id}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/groups/{groupId}/rules/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://docs.wellesley.social/_mock/openapi/api/v1/groups/gr_01hz1f0kw36f82k9s4nzpc4s92n/rules/rl_01hz1f0gs9fe4a37jzvzn9m96kRequest
Modifies an existing rule's text, hint, or ordering. Requires GroupSettings.Manage permission. The entire rule content must be provided in the update request. Changes are tracked in the audit log for compliance and moderation purposes. Returns 404 if the rule doesn't exist.
RBAC: requires GroupSettings.Manage
The rule text that defines expected behavior or policy (max 500 characters)
Example: "Be respectful to all members"
Additional context or clarification for the rule (max 500 characters)
Example: "This includes no harassment, personal attacks, or discriminatory language"
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/groups/{groupId}/rules/{ruleId}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/groups/{groupId}/rules/{ruleId}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/groups/{groupId}/rules/{ruleId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://docs.wellesley.social/_mock/openapi/api/v1/groups/gr_01hz1f0kw36f82k9s4nzpc4s92n/rules/rl_01hz1f0gs9fe4a37jzvzn9m96k \
-H 'Content-Type: application/json' \
-d '{
"text": "Be respectful to all members",
"hint": "This includes no harassment, personal attacks, or discriminatory language",
"ordering": 1000
}'Successfully updated the rule
The rule text that defines expected behavior or policy (max 500 characters)
Example: "Be respectful to all members"
Additional context or clarification for the rule (max 500 characters)
Example: "This includes no harassment, personal attacks, or discriminatory language"
Display order position - rules with lower values appear first
Example: 1000
Response
application/json
{ "text": "Be respectful to all members", "hint": "This includes no harassment, personal attacks, or discriminatory language", "ordering": 1000, "id": "rl_01hz1f0gs9fe4a37jzvzn9m96k" }
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