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 upload processing jobs from a specific queue (submitted, in_progress, or completed). Used to monitor the status of async upload processing tasks such as image resizing, video encoding, or thumbnail generation. Supports filtering by upload type and sorting by various fields like submission time or processing duration.
RBAC: requires Uploads.Read
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/uploads/jobs/queue/{queueName}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/uploads/jobs/queue/{queueName}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/uploads/jobs/queue/{queueName}
- 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/uploads/jobs/queue/{queueName}?limit=0&offset=0&sortBy=string&sortOrder=string&uploadType=string'Response
application/json
{ "list": [ { … } ], "total": 0, "totalJobs": 0 }
Request
Retrieves summary statistics for all upload processing queues, showing counts of jobs in submitted, in-progress, and completed states. Provides a high-level overview of the upload processing system's current workload and performance. Useful for monitoring system health and identifying processing bottlenecks.
RBAC: requires Uploads.Read
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/uploads/jobs/summary
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/uploads/jobs/summary
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/uploads/jobs/summary
- 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/uploads/jobs/summaryResponse
application/json
[ { "queue": "Submitted", "count": 0, "averageTimeInQueueMillis": 0, "oldestTimeInQueueMillis": 0, "averageProcessingTimeMillis": 0, "averageWaitingTimeMillis": 0, "p95TimeInQueueMillis": 0, "successCount": 0, "failureCount": 0 } ]
Request
Searches and retrieves uploads for a specific user with optional filtering by upload type (IMAGE, VIDEO, AUDIO, DOCUMENT) and tags (Avatar, Header, Post, etc.). Supports pagination for large result sets. Returns upload metadata including file information, processing status, and associated tags.
RBAC: requires Uploads.Read
Query
Get older records (records with IDs less than this value) Alias maxId/max_id
Example: lastId=?lastId=${data.last().id}
Filter by upload tag (Avatar, Header, Post, etc.). Omit to include all tags.
Enum"Post""Avatar""Header""Album""Emoji""Event"
Example: tag=$post
Get newer records (records with IDs greater than this value) Alias minId/min_id
Example: untilId=?untilId=${data.first().id}
Filter by upload type (IMAGE, VIDEO, AUDIO, DOCUMENT). Omit to include all types.
Enum"VIDEO""IMAGE""AUDIO""DOCUMENT""OTHER"
Example: uploadType=video
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/uploads/search
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/uploads/search
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/uploads/search
- 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/uploads/search?lastId=%3FlastId%3D%24{data.last%28%29.id}&limit=0&offset=0&sortBy=string&sortOrder=string&tag=%24post&untilId=%3FuntilId%3D%24{data.first%28%29.id}&uploadType=video&userId=us_01hxcvk1hjexere4pvtrj0ymqq'Upload search results retrieved successfully
User id this upload belongs to
Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
Type of the upload
Enum"VIDEO""IMAGE""AUDIO""DOCUMENT""OTHER"
Example: "video"
Meta data
List of all the files this upload has
true if this file is original, false if it is a derivative
File metadata. Contains optional values for width, height etc.
List of tags attached to upload
Items Enum"Post""Avatar""Header""Album""Emoji""Event"
Example: ["$post"]
Response
application/json
{ "list": [ { … } ], "total": 0 }
- Mock serverhttps://docs.wellesley.social/_mock/openapi/api/v1/admin/uploads/storage/{userId}
- Simple setup, all in one. Digital Oceanhttps://dust.allroads.social/api/v1/admin/uploads/storage/{userId}
- Simple setup, db is separate. Digital Oceanhttps://meteor.allroads.social/api/v1/admin/uploads/storage/{userId}
- 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/uploads/storage/us_01hxcvk1hjexere4pvtrj0ymqqResponse
application/json
{ "video": 0, "image": 0, "audio": 0, "document": 0, "other": 0 }
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