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
Retrieves application data entries based on filter criteria. Can filter by data type, tags (multiple tags are AND-ed), and owner. The user must have read permissions for the specified owner if filtering by owner. Returns all matching entries for the application. Without filters, returns all data the user has permission to access.
Security
header
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/apps/{appId}/data
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/apps/{appId}/data
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/apps/{appId}/data
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.wellesley.social/_mock/openapi/api/v1/apps/us_01hxcvk1hjexere4pvtrj0ymqq/data?owner=string&tags=string&type=string' \
-H 'Authorization: YOUR_API_KEY_HERE'List of matching application data entries
Optional application ID that this data belongs to
Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
Owner identifier of the data. Can be a user ID, group ID, user-in-group format userId:groupId, or 'platform'
Example: "us_01hq8c8em5hj1vr2f4h1t9db9q"
Optional list of tags for additional categorization
Example: ["personal","profile"]
JSON string containing the actual data payload
Example: "{\"name\": \"John Doe\", \"bio\": \"Developer\"}"
Timestamp when the data was created
Example: "2022-03-10T16:15:50Z"
Timestamp when the data was last updated
Example: "2022-03-10T16:15:50Z"
Response
application/json
[ { "id": "ad_01hq8c8em5hj1vr2f4h1t9db9q", "applicationId": "ap_01hq8c8em5hj1vr2f4h1t9db9q", "ownerId": "us_01hq8c8em5hj1vr2f4h1t9db9q", "type": "user_profile", "tags": [ … ], "data": "{\"name\": \"John Doe\", \"bio\": \"Developer\"}", "createdAt": "2024-03-20T10:15:30Z", "updatedAt": "2024-03-20T10:15:30Z" } ]
Request
Creates a new data entry for the specified application. The data can be owned by a user, group, user within a group context, or the platform itself. Ownership determines access permissions. The data structure is flexible, supporting any JSON content with optional type categorization and tags for filtering.
Security
header
Owner identifier of the data. Can be a user ID, group ID, user-in-group format userId:groupId, or 'platform'
Example: "usr_01hq8c8em5hj1vr2f4h1t9db9q"
Optional list of tags for additional categorization
Example: ["personal","profile"]
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/apps/{appId}/data
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/apps/{appId}/data
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/apps/{appId}/data
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.wellesley.social/_mock/openapi/api/v1/apps/us_01hxcvk1hjexere4pvtrj0ymqq/data \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"ownerId": "usr_01hq8c8em5hj1vr2f4h1t9db9q",
"type": "user_profile",
"tags": [
"personal",
"profile"
],
"data": "{\"name\": \"John Doe\", \"bio\": \"Developer\"}"
}'Application data successfully created
Optional application ID that this data belongs to
Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
Owner identifier of the data. Can be a user ID, group ID, user-in-group format userId:groupId, or 'platform'
Example: "us_01hq8c8em5hj1vr2f4h1t9db9q"
Optional list of tags for additional categorization
Example: ["personal","profile"]
JSON string containing the actual data payload
Example: "{\"name\": \"John Doe\", \"bio\": \"Developer\"}"
Timestamp when the data was created
Example: "2022-03-10T16:15:50Z"
Response
application/json
{ "id": "ad_01hq8c8em5hj1vr2f4h1t9db9q", "applicationId": "ap_01hq8c8em5hj1vr2f4h1t9db9q", "ownerId": "us_01hq8c8em5hj1vr2f4h1t9db9q", "type": "user_profile", "tags": [ "personal", "profile" ], "data": "{\"name\": \"John Doe\", \"bio\": \"Developer\"}", "createdAt": "2024-03-20T10:15:30Z", "updatedAt": "2024-03-20T10:15:30Z" }
Request
Updates an existing data entry for the application. The user must have manage permissions for the data owner (user/group). The ownership cannot be changed during update - the new ownerId must match the existing one. Updates the data content, type, and tags while preserving ownership.
Security
header
Path
Bodyapplication/jsonrequiredApplication ID that owns this data. Must match the data's application.
Example: us_01hxcvk1hjexere4pvtrj0ymqq
Owner identifier of the data. Can be a user ID, group ID, user-in-group format userId:groupId, or 'platform'
Example: "usr_01hq8c8em5hj1vr2f4h1t9db9q"
Optional list of tags for additional categorization
Example: ["personal","profile"]
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/apps/{appId}/data/{id}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/apps/{appId}/data/{id}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/apps/{appId}/data/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://docs.wellesley.social/_mock/openapi/api/v1/apps/us_01hxcvk1hjexere4pvtrj0ymqq/data/us_01hxcvk1hjexere4pvtrj0ymqq \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"ownerId": "usr_01hq8c8em5hj1vr2f4h1t9db9q",
"type": "user_profile",
"tags": [
"personal",
"profile"
],
"data": "{\"name\": \"John Doe\", \"bio\": \"Developer\"}"
}'Application data successfully updated
Optional application ID that this data belongs to
Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
Owner identifier of the data. Can be a user ID, group ID, user-in-group format userId:groupId, or 'platform'
Example: "us_01hq8c8em5hj1vr2f4h1t9db9q"
Optional list of tags for additional categorization
Example: ["personal","profile"]
JSON string containing the actual data payload
Example: "{\"name\": \"John Doe\", \"bio\": \"Developer\"}"
Timestamp when the data was created
Example: "2022-03-10T16:15:50Z"
Response
application/json
{ "id": "ad_01hq8c8em5hj1vr2f4h1t9db9q", "applicationId": "ap_01hq8c8em5hj1vr2f4h1t9db9q", "ownerId": "us_01hq8c8em5hj1vr2f4h1t9db9q", "type": "user_profile", "tags": [ "personal", "profile" ], "data": "{\"name\": \"John Doe\", \"bio\": \"Developer\"}", "createdAt": "2024-03-20T10:15:30Z", "updatedAt": "2024-03-20T10:15:30Z" }
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/apps/{appId}/data/{id}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/apps/{appId}/data/{id}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/apps/{appId}/data/{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/apps/us_01hxcvk1hjexere4pvtrj0ymqq/data/us_01hxcvk1hjexere4pvtrj0ymqq \
-H 'Authorization: YOUR_API_KEY_HERE'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