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
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/instance
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/instance
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/instance
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.wellesley.social/_mock/openapi/api/v1/instanceInstance info
Total number of active local users in the last 30 days on this day
Total number of active local users in the last 180 days on this day
Cumulative comments by remote users up to this day
This instance configuration
Registration configuration
Whether reason to join should be provided when signing up
Whether captcha is shown to new users when signing up
Whether existing users can invite other users to join
Message shown to guests when registration is closed
Access configuration
Branding configuration
Server description shown on the homepage
Thumbnail of the image URL shown on the homepage
Domain blocks policy configuration
List of instance rules
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
{ "uri": "https://wellesley.social", "title": "string", "short_description": "string", "description": "string", "email": "string", "version": "1.0", "build": "777", "buildTimestamp": 681486960000, "urls": { "property1": "string", "property2": "string" }, "stats": { "user_count": 0, "active30_user_count": 0, "active180_user_count": 0, "group_count": 0, "post_count": 0, "post_count_total": 0, "comment_count": 0, "remote_comment_count": 0, "comment_count_total": 0, "remote_comment_count_total": 0, "domain_count": 0 }, "thumbnail": "string", "languages": [ "string" ], "configuration": { "registrations": { … }, "passwordPolicy": "ANY", "access": { … }, "branding": { … }, "domainBlocksPolicy": { … }, "contacts": { … } }, "contact_account": { "groupUserName": "string", "id": "us_01hxcvk1hjexere4pvtrj0ymqq", "username": "john_smith", "domain": "wlsly1.net", "displayName": "John Smith", "uri": "https://wlsly1.net/users/john_smith", "avatar": { … }, "createdAt": "2022-03-10T16:15:50Z", "deleted": true, "state": "REGULAR", "relationship": { … }, "channel": true, "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq", "groupPrivacy": "PUBLIC", "groupMain": true, "groupDefault": true, "actorType": "Application" }, "rules": [ { … } ] }
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/instance/countries
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/instance/countries
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/instance/countries
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.wellesley.social/_mock/openapi/api/v1/instance/countriesResponse
application/json
[ { "flags": { … }, "name": { … }, "idd": { … } } ]
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/instance/domains
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/instance/domains
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/instance/domains
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.wellesley.social/_mock/openapi/api/v1/instance/domains?domain=string&limit=0&software=string'- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/instance/extended_description
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/instance/extended_description
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/instance/extended_description
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.wellesley.social/_mock/openapi/api/v1/instance/extended_descriptionExtended Instance info
Total number of active local users in the last 30 days on this day
Total number of active local users in the last 180 days on this day
Cumulative comments by remote users up to this day
This instance configuration
Registration configuration
Whether reason to join should be provided when signing up
Whether captcha is shown to new users when signing up
Whether existing users can invite other users to join
Message shown to guests when registration is closed
Access configuration
Branding configuration
Server description shown on the homepage
Thumbnail of the image URL shown on the homepage
Domain blocks policy configuration
List of instance rules
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
{ "uri": "https://wellesley.social", "title": "string", "short_description": "string", "description": "string", "email": "string", "version": "1.0", "build": "777", "buildTimestamp": 681486960000, "urls": { "property1": "string", "property2": "string" }, "stats": { "user_count": 0, "active30_user_count": 0, "active180_user_count": 0, "group_count": 0, "post_count": 0, "post_count_total": 0, "comment_count": 0, "remote_comment_count": 0, "comment_count_total": 0, "remote_comment_count_total": 0, "domain_count": 0 }, "thumbnail": "string", "languages": [ "string" ], "configuration": { "registrations": { … }, "passwordPolicy": "ANY", "access": { … }, "branding": { … }, "domainBlocksPolicy": { … }, "contacts": { … } }, "contact_account": { "groupUserName": "string", "id": "us_01hxcvk1hjexere4pvtrj0ymqq", "username": "john_smith", "domain": "wlsly1.net", "displayName": "John Smith", "uri": "https://wlsly1.net/users/john_smith", "avatar": { … }, "createdAt": "2022-03-10T16:15:50Z", "deleted": true, "state": "REGULAR", "relationship": { … }, "channel": true, "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq", "groupPrivacy": "PUBLIC", "groupMain": true, "groupDefault": true, "actorType": "Application" }, "rules": [ { … } ] }
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/instance/supported_languages
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/instance/supported_languages
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/instance/supported_languages
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.wellesley.social/_mock/openapi/api/v1/instance/supported_languagesResponse
application/json
[ { "code": "string", "nativeName": "string" } ]
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/instance/timezones
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/instance/timezones
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/instance/timezones
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.wellesley.social/_mock/openapi/api/v1/instance/timezonesResponse
application/json
[ { "value": "string", "abbr": "string", "offset": 0.1, "isdst": true, "text": "string", "utc": [ … ] } ]
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