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
Request
Approves a pending signup request and creates the user account. Sends a welcome email to the user upon successful account creation. If username conflicts occur, sends an alternative email prompting the user to choose a different username. If email/phone conflicts occur, the request is deleted as the user likely already has an account. The operation is logged for audit purposes.
RBAC: requires Signups.Manage
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/signup_requests/approve/{hash}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/signup_requests/approve/{hash}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/signup_requests/approve/{hash}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.wellesley.social/_mock/openapi/api/v1/admin/signup_requests/approve/{hash}'Response
application/json
null
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/signup_requests/delete/{hash}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/signup_requests/delete/{hash}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/signup_requests/delete/{hash}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.wellesley.social/_mock/openapi/api/v1/admin/signup_requests/delete/{hash}'Request
Retrieves a paginated list of signup requests awaiting admin approval. Can filter by email address, request hash, or originating IP address. Results are sorted by creation date (newest first) by default. Only shows requests at the ADMIN approval step.
RBAC:
- requires ANY of Signups.Read, Signups.Manage
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/signup_requests/list
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/signup_requests/list
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/signup_requests/list
- 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/signup_requests/list?email=string&hash=string&ip=string&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}'Paginated list of signup requests with total count
List of signup requests
Display name for the first user
Example: "John Smith"
Account password, enforced by password policy
Example: "PassW0rd!"
Shows the current step in the signup flow:
- EMAIL – We sent an email to the user with a verification code. The user must enter the code to confirm their email.
- PHONE – We sent a text to the user with a verification code. The user must enter the code to confirm their phone number.
- CAPTCHA – The user must complete a CAPTCHA verification.
- REASON – The user must provide a reason for admins to approve their signup request.
- ADMIN – Admins must approve or reject the user's signup request. No action is required from the user.
- USER – The final step that creates the account. Most of the time, no action is required from the user. If the account can't be created because the username is already taken, the user can provide a different username at this step.
Enum"EMAIL""PHONE""CAPTCHA""REASON""ADMIN""USER"
Example: "EMAIL"
IP address of the user
Creation timestamp of the request
Example: "2022-03-10T16:15:50Z"
Response
application/json
{ "list": [ { … } ], "total": 42 }
Request
Rejects a pending signup request and permanently removes it from the queue. Sends a rejection email to the applicant with an optional reason for the rejection. This action is final and the user would need to submit a new signup request. The rejection is logged for audit purposes.
RBAC: requires Signups.Manage
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/signup_requests/reject/{hash}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/signup_requests/reject/{hash}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/signup_requests/reject/{hash}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.wellesley.social/_mock/openapi/api/v1/admin/signup_requests/reject/{hash}?reason=string'Response
application/json
null
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