Skip to content

Wellesley Platform API (1.0)

Download OpenAPI description
openapi.json
openapi.yaml
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/

AI Agents

Assign and list group AI agent assignments

Operations

List AI agent assignments

Request

Retrieves a list of AI agent assignments filtered by assignment type and optional resource ID. This allows querying which bots are active in specific scopes (global, forums, categories, channels). Returns an array of assignments matching the specified criteria.

RBAC:

  • requires ANY of AIAgents.Read, AIAgents.Manage
Query
resourceIdstring or null

Optional resource ID to filter assignments for a specific resource. Required for non-GLOBAL/GROUP assignments (e.g., forum_id for FORUM type, category_id for FORUM_CATEGORY type). Must be null or omitted for GLOBAL and GROUP assignment types.

Example: resourceId=frm_xyz123
typestring or null

Optional assignment type to filter by. Valid values: GLOBAL, GROUP, FORUM, FORUM_CATEGORY, GROUP_CHANNEL. Determines the scope where the AI agent operates.

Enum"GLOBAL""GROUP""FORUM""FORUM_CATEGORY""GROUP_CHANNEL"
Example: type=GLOBAL
curl -i -X GET \
  'https://docs.wellesley.social/_mock/openapi/api/v1/ai-agents/assignments?resourceId=frm_xyz123&type=GLOBAL'

Responses

Array of AI agent assignments matching the query criteria

Bodyapplication/jsonArray [
assignmentIdstringrequired

Unique TypeId for this assignment

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
agentIdstringrequired

TypeId of the bot user assigned. References a user with isBot=true.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
assignmentTypestringrequired

Assignment scope/type that determines where an AI agent operates.

  • GLOBAL: Bot operates platform-wide across all content
  • GROUP: Bot operates within a specific group
  • FORUM: Bot operates within a specific forum
  • FORUM_CATEGORY: Bot operates within a specific forum category
  • GROUP_CHANNEL: Bot operates within a specific group channel
Enum"GLOBAL""GROUP""FORUM""FORUM_CATEGORY""GROUP_CHANNEL"
Example: "FORUM"
resourceIdstring or null

TypeId of the specific resource this assignment is scoped to. Null for GLOBAL assignments. Contains forum_id for FORUM, category_id for FORUM_CATEGORY, channel_id for GROUP_CHANNEL assignments.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
groupIdstring or null

TypeId of the group this assignment belongs to. Present for group-scoped assignments (GROUP, FORUM, FORUM_CATEGORY, GROUP_CHANNEL). Null for GLOBAL assignments.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
createdAtstring(date-time)required

ISO 8601 timestamp when this assignment was created

Example: "2022-03-10T16:15:50Z"
updatedAtstring(date-time)required

ISO 8601 timestamp when this assignment was last updated

Example: "2022-03-10T16:15:50Z"
]
Response
application/json
[
  {
    "assignmentId": "aia_abc123",
    "agentId": "usr_bot456",
    "assignmentType": "GLOBAL",
    "resourceId": null,
    "groupId": null,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  },
  {
    "assignmentId": "aia_def789",
    "agentId": "usr_bot789",
    "assignmentType": "FORUM",
    "resourceId": "frm_xyz123",
    "groupId": "grp_abc456",
    "createdAt": "2024-01-16T14:20:00Z",
    "updatedAt": "2024-01-16T14:20:00Z"
  }
]

Delete an AI agent assignment

Request

Deletes an existing AI agent assignment by its ID. This deactivates the bot from its assigned scope. Returns success if the assignment was deleted, or ResourceNotFound if the assignment doesn't exist.

RBAC: requires AIAgents.Manage

Query
idstring(TypeId)required

The TypeId of the AI agent assignment to delete

Example: id=aia_abc123
curl -i -X DELETE \
  'https://docs.wellesley.social/_mock/openapi/api/v1/ai-agents/assignments?id=aia_abc123'

Responses

Assignment successfully deleted

Bodyapplication/json
any
Response
application/json
null

Create a global AI agent assignment

Request

Creates a global AI agent assignment that activates a bot platform-wide. The agent must be a valid bot user (user with isBot=true). Only GLOBAL assignment type is allowed in this context. For group-scoped assignments, use the Group AI Agent Management API instead.

RBAC: requires AIAgents.Manage

Bodyapplication/jsonrequired
agentIdstringrequired

TypeId of the bot user to assign. Must be a valid user with isBot=true.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
assignmentTypestringrequired

Assignment scope/type that determines where an AI agent operates.

  • GLOBAL: Bot operates platform-wide across all content
  • GROUP: Bot operates within a specific group
  • FORUM: Bot operates within a specific forum
  • FORUM_CATEGORY: Bot operates within a specific forum category
  • GROUP_CHANNEL: Bot operates within a specific group channel
Enum"GLOBAL""GROUP""FORUM""FORUM_CATEGORY""GROUP_CHANNEL"
Example: "GLOBAL"
resourceIdstring or null

TypeId of the resource to scope the assignment to. Must be null for GLOBAL assignments. Must be null or match the group ID for GROUP assignments. Required for FORUM (forum_id), FORUM_CATEGORY (category_id), GROUP_CHANNEL (channel_id) assignments. The TypeId type must match the assignment type.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
curl -i -X POST \
  https://docs.wellesley.social/_mock/openapi/api/v1/ai-agents/assignments \
  -H 'Content-Type: application/json' \
  -d '{
    "agentId": "usr_bot456",
    "assignmentType": "GLOBAL",
    "resourceId": null
  }'

Responses

Successfully created AI agent assignment with assignment details

Bodyapplication/json
assignmentIdstringrequired

Unique TypeId for this assignment

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
agentIdstringrequired

TypeId of the bot user assigned. References a user with isBot=true.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
assignmentTypestringrequired

Assignment scope/type that determines where an AI agent operates.

  • GLOBAL: Bot operates platform-wide across all content
  • GROUP: Bot operates within a specific group
  • FORUM: Bot operates within a specific forum
  • FORUM_CATEGORY: Bot operates within a specific forum category
  • GROUP_CHANNEL: Bot operates within a specific group channel
Enum"GLOBAL""GROUP""FORUM""FORUM_CATEGORY""GROUP_CHANNEL"
Example: "GLOBAL"
resourceIdstring or null

TypeId of the specific resource this assignment is scoped to. Null for GLOBAL assignments. Contains forum_id for FORUM, category_id for FORUM_CATEGORY, channel_id for GROUP_CHANNEL assignments.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
groupIdstring or null

TypeId of the group this assignment belongs to. Present for group-scoped assignments (GROUP, FORUM, FORUM_CATEGORY, GROUP_CHANNEL). Null for GLOBAL assignments.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
createdAtstring(date-time)required

ISO 8601 timestamp when this assignment was created

Example: "2022-03-10T16:15:50Z"
updatedAtstring(date-time)required

ISO 8601 timestamp when this assignment was last updated

Example: "2022-03-10T16:15:50Z"
Response
application/json
{
  "assignmentId": "aia_abc123",
  "agentId": "usr_bot456",
  "assignmentType": "GLOBAL",
  "resourceId": null,
  "groupId": null,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Retrieve posts for AI agents

Request

Returns posts for AI agents. If ownerId is missing, retrieves posts from the global space (group_id is null) with PUBLIC visibility. Supports pagination and optional 'since' timestamp to fetch posts strictly newer than the given timestamp.

RBAC: requires AIAgents.PostsRead

Query
limitinteger or null(int32)

Maximum number of items to return (page size). Defaults to 100.

ownerIdstring or null

Owner id. Accepts a group channel (USER) or forum category (CATEGORY) id

Example: ownerId=us_01hxcvk1hjexere4pvtrj0ymqq
sincestring or null(date-time)

Timestamp to retrieve posts strictly newer than this (by createdAt)

Example: since=2022-03-10T16:15:50Z
htmlContentany

Returns text as html if true or original text if false. Applicable only to local posts and users. Default is true.

curl -i -X GET \
  'https://docs.wellesley.social/_mock/openapi/api/v1/ai-agents/posts?limit=0&ownerId=us_01hxcvk1hjexere4pvtrj0ymqq&since=2022-03-10T16%3A15%3A50Z'

Responses

Posts list

Bodyapplication/jsonArray [
idstringrequired

internal post id

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
uristring(uri)required

unique post uri

textstringrequired

post text, raw or html depending on how it was requested

pathArray of strings(TypeId)required

replies path

Example: ["us_01hxcvk1hjexere4pvtrj0ymqq"]
privacystringrequired

Privacy levels for posts:

  • PUBLIC - post is visible to anyone, including people who are not logged in and those who do not follow the user. It appears in the public timelines (home, local, and federated).
  • UNLISTED - post is visible to anyone who visits the user's profile, but it does not appear in public timelines. Only followers and those who visit the user's profile directly can see it.
  • PRIVATE - post is only visible to the user's followers. It does not appear in public timelines or on the user's profile for non-followers.
  • DIRECT - post is visible only to the mentioned users. It functions like a direct message and is not visible on public timelines, the user's profile, or to followers.
  • FOLLOW_POST - comment only. Follow parent post visibility
Enum"PUBLIC""UNLISTED""PRIVATE""DIRECT""FOLLOW_POST"
Example: "PUBLIC"
kindstringrequired

Article or Note

Enum"Note""Article"
Example: "Note"
softwarestringrequired

post software

Example: "wellesley"
repostOfstring or null

id of a post this one was reposted from

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
ownerIdstring(TypeId)required

UUID with type prefix

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
ownerTypestring(PostOwnerType)required

Owner types for posts:

  • USER - user’s channel (personal or group channel)
  • EVENT - event (personal or group)
  • CATEGORY - forum category

** POST OWNER: **

  • Personal channel
    • userId = author
    • ownerId = userId (Type.USER)
    • ownerType = USER
    • groupId = null
  • Forum post
    • userId = author
    • ownerId = categoryId (Type.CATEGORY)
    • ownerType = CATEGORY
    • groupId = forum’s groupId
  • Personal event
    • userId = author
    • ownerId = eventId (Type.EVENT)
    • ownerType = EVENT
    • groupId = null
  • Group channel
    • userId = author
    • ownerId = channel userId (Type.USER)
    • ownerType = USER
    • groupId = groupId
  • Group event
    • userId = author
    • ownerId = eventId (Type.EVENT)
    • ownerType = EVENT
    • groupId = groupId
Enum"USER""EVENT""CATEGORY"
groupIdstring or null

UUID with type prefix

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
titlestring or null
summarystring or nullrequired

Subject or summary line, below which post content is collapsed until expanded.

tagsArray of stringsrequired

List of tags

mentionsArray of strings(uri)required

List of mentions

statsobjectrequired

Stats

stats.​likesinteger(int32)
stats.​repostsinteger(int32)
stats.​quotesinteger(int32)
stats.​commentsinteger(int32)
stats.​viewsinteger(int32)
stats.​bookmarksinteger(int32)
stats.​reactionsobjectrequired
stats.​reactions.​property name*integer(int32)additional property
stats.​watchTimeinteger or null(int64)
stats.​secondsToFirstAnswerinteger or null(int32)
stats.​secondsToAcceptedinteger or null(int32)
stats.​lastActivitystring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
stats.​lastViewTimestampstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
settingsobjectrequired

Settings

settings.​commentsEnabledboolean
settings.​sensitiveboolean
langstring or null
Enum"BG""CS""DA""DE""EL""EN""ES""ET""FI""FR"
pollobject or null
cardobject or null

Preview card for any links in the post

mediaTypestringrequired

Post media type. Default for Note is text/plain, for Article text/markdown

Enum"TEXT_PLAIN""MARKDOWN"
translationsobject or null
createdAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
updatedAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
authorobject(User)required

One of account's users. Can be multiple per account

author.​groupUserNamestring or null

Name of the channel inside a group

author.​idstringrequired

internal id of this user

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
author.​usernamestringrequired

unique user name

Example: "john_smith"
author.​domainstringrequired

user's domain, remote only, empty for local

Example: "wlsly1.net"
author.​displayNamestringrequired

full name of the user

Example: "John Smith"
author.​uristring(uri)required

URI of this user

Example: "https://wlsly1.net/users/john_smith"
author.​avatarobject or null

User's avatar

author.​createdAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
author.​deletedboolean or null
author.​statestringrequired

Registration mode:

  • REGULAR - just regular state
  • SENSITIVE - all media attachments are flagged as sensitive, i.e. all user's posts should be marked as sensitive, old posts and all future ones.
  • LIMITED - all user's old and future posts should be set maximum to followers only unless user set it to direct himself. non-followers should not be notified, i.e. if user mentions non-follower we do not create notification.
  • SUSPENDED - User can login, but cannot do anything in his account except to read, cannot change anything, cannot create new posts or comments etc. All his posts are marked as deleted, but we do not delete them just yet. User is scheduled to be deleted in one month. During this month it is possible to restore it via admin.
Enum"REGULAR""SENSITIVE""LIMITED""SUSPENDED"
author.​relationshipobject or null

Relationship with this user

author.​channelboolean

Whether this is a channel or a user

author.​groupIdstring or null

UUID with type prefix

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
author.​groupPrivacystring or null
  • PUBLIC - Channel is visible to everyone and can be followed by anyone.
  • PRIVATE - Channel is visible only to group members and can only be followed by group members.
Enum"PUBLIC""PRIVATE"
author.​groupMainboolean or null
author.​groupDefaultboolean or null
author.​actorTypestring or null

Types that an Actor can be assigned. Coincide with ActivityPub Actor types:

  • APPLICATION: Apps will have this type
  • GROUP: Interest Groups and Generic Groups wil have this type
  • ORGANIZATION: Formal Organizations such as Companies, Institutions, etc. will have this type
  • PERSON: Individual people will have this type
  • SERVICE: Bots, Services, and other automated tools which are not also Apps will have this type
Enum"Application""Group""Organization""Person""Service"
uploadsArray of objects(Upload)required
uploads[].​uploadIdstringrequired

Internal id

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
uploads[].​userIdstringrequired

User id this upload belongs to

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
uploads[].​uploadTypestringrequired

Type of the upload

Enum"VIDEO""IMAGE""AUDIO""DOCUMENT""OTHER"
Example: "video"
uploads[].​metaobjectrequired

Meta data

uploads[].​meta.​blurhashstring or null
uploads[].​meta.​namestring or null
uploads[].​meta.​altTextstring or null
uploads[].​sizeinteger(int64)required

Size in bytes of all the files in this upload

uploads[].​filesArray of objects(FileDesc)required

List of all the files this upload has

uploads[].​files[].​uristring or nullrequired

Full url of the file

uploads[].​files[].​fileIdstringrequired

File id

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
uploads[].​files[].​extensionstringrequired

File extension

Example: "mp4"
uploads[].​files[].​originalbooleanrequired

true if this file is original, false if it is a derivative

uploads[].​files[].​metaobjectrequired

File metadata. Contains optional values for width, height etc.

uploads[].​files[].​meta.​durationnumber or null(double)

Video duration in seconds

uploads[].​files[].​meta.​widthinteger or null(int32)

Media width

uploads[].​files[].​meta.​heightinteger or null(int32)

Media height

uploads[].​files[].​meta.​codecstring or null

Video codec

uploads[].​files[].​meta.​rotateinteger or null(int32)

Rotation in degrees

uploads[].​files[].​sizeinteger(int64)required

File size in bytes

uploads[].​files[].​createdAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
uploads[].​files[].​updatedAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
uploads[].​files[].​typestringrequired

File type

Enum"VIDEO""IMAGE""AUDIO""DOCUMENT""OTHER"
Example: "video"
uploads[].​tagsArray of strings(UploadsTags)uniquerequired

List of tags attached to upload

Items Enum"Post""Avatar""Header""Album""Emoji""Event"
Example: ["$post"]
uploads[].​errorstring or null

Upload processing error

uploads[].​cachedboolean

true if cached

uploads[].​logsstring or null

Logs

uploads[].​remoteboolean

true if this upload is remote

uploads[].​createdAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
uploads[].​updatedAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
likedboolean or null

Whether the current user liked it or not

repostedboolean or null

Whether the current user reposted it or not

quotedboolean or null

Whether the current user quoted it or not

mutedboolean or null

Whether the current user muted the author of the post

blockedboolean or null

Whether the current user blocked the author of the post

visibleboolean or null

Whether the current user can see it or not (e.g. FOLLOWERS_ONLY

pinnedboolean or null

Whether the current user pinned it or not

bookmarkedboolean or null

Whether the current user bookmarked it or not

editedboolean or null

Whether the post was edited

deletedboolean or null
emojisArray of objects or null(Emoji)
repliesArray of objects or null(Post)
repostedByArray of objects or null(UserLite)

List of users who reposted this post

originalPostobject or nullRecursive

Original of repost/quote. In WS context or /replies API could also be parent of a comment

votesobject or null

Votes summary

remoteboolean
repostAnyboolean
repostboolean
quoteboolean
ownboolean
replyTostring or null

UUID with type prefix

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
conversationIdstring(TypeId)required

UUID with type prefix

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
]
Response
application/json
[
  {
    "id": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "uri": "http://example.com",
    "text": "string",
    "path": [ … ],
    "privacy": "PUBLIC",
    "kind": "Note",
    "software": "wellesley",
    "repostOf": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "ownerId": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "ownerType": "USER",
    "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "title": "string",
    "summary": "string",
    "tags": [ … ],
    "mentions": [ … ],
    "stats": { … },
    "settings": { … },
    "lang": "BG",
    "poll": { … },
    "card": { … },
    "mediaType": "TEXT_PLAIN",
    "translations": { … },
    "createdAt": "2022-03-10T16:15:50Z",
    "updatedAt": "2022-03-10T16:15:50Z",
    "author": { … },
    "uploads": [ … ],
    "liked": true,
    "reposted": true,
    "quoted": true,
    "muted": true,
    "blocked": true,
    "visible": true,
    "pinned": true,
    "bookmarked": true,
    "edited": true,
    "deleted": true,
    "emojis": [ … ],
    "replies": [ … ],
    "repostedBy": [ … ],
    "originalPost": {},
    "votes": { … },
    "remote": true,
    "repostAny": true,
    "repost": true,
    "quote": true,
    "own": true,
    "replyTo": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "conversationId": "us_01hxcvk1hjexere4pvtrj0ymqq"
  }
]

List group AI agent assignments

Request

RBAC:

  • requires ANY of GroupAIAgents.Read, GroupAIAgents.Manage
Path
groupIdstring(TypeId)required

The unique identifier of the group

Example: gr_01hz1f0kw36f82k9s4nzpc4s33n
Query
resourceIdstring or null
typestring or null

Assignment scope/type that determines where an AI agent operates.

  • GLOBAL: Bot operates platform-wide across all content
  • GROUP: Bot operates within a specific group
  • FORUM: Bot operates within a specific forum
  • FORUM_CATEGORY: Bot operates within a specific forum category
  • GROUP_CHANNEL: Bot operates within a specific group channel
Enum"GLOBAL""GROUP""FORUM""FORUM_CATEGORY""GROUP_CHANNEL"
curl -i -X GET \
  'https://docs.wellesley.social/_mock/openapi/api/v1/groups/gr_01hz1f0kw36f82k9s4nzpc4s33n/ai-agents/assignments?resourceId=string&type=GLOBAL'

Responses

Assignments

Bodyapplication/jsonArray [
assignmentIdstringrequired

Unique TypeId for this assignment

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
agentIdstringrequired

TypeId of the bot user assigned. References a user with isBot=true.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
assignmentTypestringrequired

Assignment scope/type that determines where an AI agent operates.

  • GLOBAL: Bot operates platform-wide across all content
  • GROUP: Bot operates within a specific group
  • FORUM: Bot operates within a specific forum
  • FORUM_CATEGORY: Bot operates within a specific forum category
  • GROUP_CHANNEL: Bot operates within a specific group channel
Enum"GLOBAL""GROUP""FORUM""FORUM_CATEGORY""GROUP_CHANNEL"
Example: "FORUM"
resourceIdstring or null

TypeId of the specific resource this assignment is scoped to. Null for GLOBAL assignments. Contains forum_id for FORUM, category_id for FORUM_CATEGORY, channel_id for GROUP_CHANNEL assignments.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
groupIdstring or null

TypeId of the group this assignment belongs to. Present for group-scoped assignments (GROUP, FORUM, FORUM_CATEGORY, GROUP_CHANNEL). Null for GLOBAL assignments.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
createdAtstring(date-time)required

ISO 8601 timestamp when this assignment was created

Example: "2022-03-10T16:15:50Z"
updatedAtstring(date-time)required

ISO 8601 timestamp when this assignment was last updated

Example: "2022-03-10T16:15:50Z"
]
Response
application/json
[
  {
    "assignmentId": "aia_abc123",
    "agentId": "usr_bot456",
    "assignmentType": "FORUM",
    "resourceId": "frm_xyz123",
    "groupId": "grp_abc456",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
]

Delete an AI agent assignment

Request

RBAC: requires GroupAIAgents.Manage

Path
groupIdstring(TypeId)required

The unique identifier of the group

Example: gr_01hz1f0kw36f82k9s4nzpc4s33n
Query
assignmentIdstring(TypeId)required

UUID with type prefix

Example: assignmentId=us_01hxcvk1hjexere4pvtrj0ymqq
curl -i -X DELETE \
  'https://docs.wellesley.social/_mock/openapi/api/v1/groups/gr_01hz1f0kw36f82k9s4nzpc4s33n/ai-agents/assignments?assignmentId=us_01hxcvk1hjexere4pvtrj0ymqq'

Responses

OK

Bodyapplication/json
any
Response
application/json
null

Create a group AI agent assignment

Request

RBAC: requires GroupAIAgents.Manage

Path
groupIdstring(TypeId)required

The unique identifier of the group

Example: gr_01hz1f0kw36f82k9s4nzpc4s33n
Bodyapplication/jsonrequired
agentIdstringrequired

TypeId of the bot user to assign. Must be a valid user with isBot=true.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
assignmentTypestringrequired

Assignment scope/type that determines where an AI agent operates.

  • GLOBAL: Bot operates platform-wide across all content
  • GROUP: Bot operates within a specific group
  • FORUM: Bot operates within a specific forum
  • FORUM_CATEGORY: Bot operates within a specific forum category
  • GROUP_CHANNEL: Bot operates within a specific group channel
Enum"GLOBAL""GROUP""FORUM""FORUM_CATEGORY""GROUP_CHANNEL"
Example: "GLOBAL"
resourceIdstring or null

TypeId of the resource to scope the assignment to. Must be null for GLOBAL assignments. Must be null or match the group ID for GROUP assignments. Required for FORUM (forum_id), FORUM_CATEGORY (category_id), GROUP_CHANNEL (channel_id) assignments. The TypeId type must match the assignment type.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
curl -i -X POST \
  https://docs.wellesley.social/_mock/openapi/api/v1/groups/gr_01hz1f0kw36f82k9s4nzpc4s33n/ai-agents/assignments \
  -H 'Content-Type: application/json' \
  -d '{
    "agentId": "usr_bot456",
    "assignmentType": "GLOBAL",
    "resourceId": null
  }'

Responses

Created assignment

Bodyapplication/json
assignmentIdstringrequired

Unique TypeId for this assignment

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
agentIdstringrequired

TypeId of the bot user assigned. References a user with isBot=true.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
assignmentTypestringrequired

Assignment scope/type that determines where an AI agent operates.

  • GLOBAL: Bot operates platform-wide across all content
  • GROUP: Bot operates within a specific group
  • FORUM: Bot operates within a specific forum
  • FORUM_CATEGORY: Bot operates within a specific forum category
  • GROUP_CHANNEL: Bot operates within a specific group channel
Enum"GLOBAL""GROUP""FORUM""FORUM_CATEGORY""GROUP_CHANNEL"
Example: "FORUM"
resourceIdstring or null

TypeId of the specific resource this assignment is scoped to. Null for GLOBAL assignments. Contains forum_id for FORUM, category_id for FORUM_CATEGORY, channel_id for GROUP_CHANNEL assignments.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
groupIdstring or null

TypeId of the group this assignment belongs to. Present for group-scoped assignments (GROUP, FORUM, FORUM_CATEGORY, GROUP_CHANNEL). Null for GLOBAL assignments.

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
createdAtstring(date-time)required

ISO 8601 timestamp when this assignment was created

Example: "2022-03-10T16:15:50Z"
updatedAtstring(date-time)required

ISO 8601 timestamp when this assignment was last updated

Example: "2022-03-10T16:15:50Z"
Response
application/json
{
  "assignmentId": "aia_abc123",
  "agentId": "usr_bot456",
  "assignmentType": "FORUM",
  "resourceId": "frm_xyz123",
  "groupId": "grp_abc456",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Accounts

Account management and authentication endpoints. Handles user registration, login flows (email/phone), profile management, and account lifecycle operations. Supports multi-step signup with email/SMS verification, CAPTCHA, and optional admin approval.

Operations

ActivityPub

WebFinger endpoint for ActivityPub user discovery and federation

Addresses

Endpoints for suggesting and validating physical addresses

Operations

Admin

Development and testing endpoints for populating the database with test data

Admin Accounts

Administrative endpoints for account and user management. Provides comprehensive tools for managing user accounts, including creation, deletion, role assignment, password management, state changes, and user impersonation for bot accounts.

Operations

Admin ActivityPub

Administrative endpoints for ActivityPub

Operations

Admin Audit

Administrative endpoints for viewing and managing audit logs. Provides comprehensive logging of all security-relevant actions performed in the system.

Operations

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

Admin Domains Allow List

Administrative endpoints for managing domain allowlists. When domain allowlisting is enabled, only domains in this list can federate with the instance.

Operations

Admin Email Allow List

Administrative endpoints for managing email domain allowlist used for registrations.

Operations

Admin Email Blocks

Administrative APIs for managing email blocks to prevent unwanted signups. Supports blocking specific email addresses and entire domains. Email blocks are automatically normalized and checked during user registration.

Operations

Admin Federation Metrics

Administrative endpoints for monitoring and managing federation with other ActivityPub instances. Provides metrics on connected domains, user counts, post statistics, and federation health monitoring.

Operations

Admin Feeds

Administrative endpoints for managing user feeds and cache

Operations

Admin Groups

Administrative endpoints for Groups management

Operations

Admin Init

Administration endpoints for system initialization and updates

Admin Posts

Administrative endpoints for managing posts. Provides moderation capabilities to delete posts that violate community guidelines or are part of reported content.

Operations

Admin Reports

Administrative endpoints for managing user reports and moderation. Provides tools for reviewing, assigning, resolving, and annotating reports about users, posts, and groups. Supports workflow management with assignment, notes, and resolution tracking.

Operations

Admin Signup Requests

Administrative endpoints for managing user signup requests. Provides tools for reviewing, approving, rejecting, and managing signup requests in moderation queue. Supports workflow for manual account approval when enabled.

Operations

Admin Uploads

Administrative endpoints for managing file uploads and media storage. Provides tools for monitoring user storage usage, searching uploaded files, and managing upload processing jobs. Supports queue management for async upload processing workflows.

Operations

Aliases

Endpoints for managing previous usernames and username aliases

Operations

Application Data

Endpoints for managing application-specific data storage. Provides a flexible key-value storage system for applications to store custom data associated with users, groups, or the platform. Supports tagging, filtering, and ownership-based access control.

Operations

Applications

Endpoints for serving and routing platform applications to users

Operations

Blocks

User blocking functionality for preventing interaction with specific users. Blocking a user prevents them from following you, seeing your posts, or interacting with your content. Block operations are federated to remote servers when blocking remote users.

Operations

Categories

Endpoints for managing forum-specific categories

Operations

Domain Blocks

Public API for listing domains blocked by this instance. Visibility and reason details are controlled by platform settings.

Operations

Domain-blocks

Endpoints for managing user-level domain blocks to filter content from specific servers

Operations

Drafts

Endpoints for creating, reading, updating, and deleting drafts, as well as publishing them to posts

Operations

Email

Email address management for user accounts. Provides secure email change workflow with verification codes, password confirmation, and notification system. All email changes require authentication and are logged for security.

Operations

Emoji

Custom emoji management system for the platform. Supports creating, uploading, importing/exporting, searching, and deleting custom emojis. Emojis are automatically resized and optimized. Admin-only operations require Emojis.Manage permission.

Operations

Events

Endpoints for creating, retrieving, and managing events and attendees

Operations

Events ActivityPub

ActivityPub-compatible endpoint for events

Follow

User follow relationship management. Handles following/unfollowing users, managing follow requests, and querying follower/followee relationships. Supports both local and remote (federated) users with ActivityPub protocol integration.

Operations

Forums

Endpoints for managing discussion forums, including creation, retrieval, and deletion

Operations

Geo

Endpoints for geographic location lookup and timezone services

Operations

Group Applications

Endpoints for managing applications available to groups, including listing, adding, and removing group-specific applications

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 Member Settings

Endpoints for managing member-specific settings within groups. These settings are personal to each group member and affect their individual experience within the group. Members can only access and modify their own settings within groups they belong to.

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 Reports

Group-scoped moderation reports. Allows group admins to review and resolve reports targeting their channels, forums, and events without global moderator access.

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

Group Settings

Endpoints for managing group-specific settings and configuration options. These endpoints allow authorized group members to view, update, and delete settings that control group behavior, features, and customization options.

Operations

Groups

API endpoints for managing groups within the Wellesley platform. Groups are community spaces that can be public or private, support forums, and have their own membership and permission systems. Groups can be federated via ActivityPub for cross-instance communication.

Operations

Import

Endpoints for importing data from other platforms including followers, blocks, and mutes

Operations

Instance

Server instance information and configuration. Provides metadata about the server, compatible domains, supported languages, timezones, and countries. All endpoints are publicly accessible without authentication.

Operations

Invites

Endpoints for sending and managing user invitations

Operations

Jobs

Endpoints for monitoring and managing background job queues, including statistics, job listings, and queue monitoring

Operations

Lists

Endpoints for managing user lists for organizing and grouping followed accounts

Operations

Logins

Endpoints for managing user login methods including email, password, and phone authentication

Operations

Metrics

Endpoints for retrieving metrics and analytics data from the events stream

Operations

Mutes

Endpoints for managing user mutes to hide content from specific users

Operations

Notes

Endpoints for managing personal notes about other users

Operations

Notifications

Endpoints for managing user notifications including retrieving, counting, and marking notifications as read or unread

Operations

Passkeys

Passkey (WebAuthn) registration and authentication

Operations

Password

Endpoints for password management including changing, resetting, and recovering passwords

Operations

Pins

Endpoints for pinning posts to profiles and retrieving pinned posts

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

Platform Settings

Endpoints for managing platform-wide settings and configuration options. These endpoints control server-level settings that affect the entire platform, including features, limits, security policies, and default behaviors for all users and groups.

Operations

Polls

Endpoints for interacting with polls, including voting and retrieving results

Operations

Posts

Endpoints for creating, reading, updating, and deleting posts, as well as managing comments, likes, bookmarks, and reposts

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, a name, an optional description, and a scope.
  • The scope defines the domain or area in which the role is valid.
  • The scope can be Global (hardcoded), currently the only one is "System"
  • The scope also 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 createdAt and updatedAt timestamps 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 allowed RBACAccess types.
  • RBACAccess enumerates 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) and roleId (specific role ID).
  • Includes timestamps to record when the assignment was created or updated.
Operations

Remote collections

API to retrieve followers and following collections for remote users.

Operations

Reports

Endpoints for reporting content and managing content reports

Operations

Rules

Endpoints for managing platform rules that govern user conduct and content policies

Operations

Sessions

Endpoints for managing user authentication sessions and device logins

Operations

Tags

Endpoints for managing hashtags, including following, featuring, and retrieving tag information

Operations

Tags v2

Scoped tags search, policy lists and reports

Operations

Translation

Endpoints for translating text between languages

Operations

Uploads

Endpoints for uploading, retrieving, and managing media files

Operations

User Devices

APIs for managing user devices for push notifications

Operations

User Settings

Endpoints for managing user-specific settings and preferences. These endpoints allow authenticated users to view, update, and delete their personal settings that control their account behavior, interface preferences, privacy options, and feature customizations.

Operations

Users

Endpoints for managing user profiles, including creation, retrieval, updates, and moderation

Operations

employee

Employee. DO NOT USE, SUBJECT TO CHANGE/REMOVE

employer

Employer. DO NOT USE, SUBJECT TO CHANGE/REMOVE

job-applications

Jobs. DO NOT USE, SUBJECT TO CHANGE/REMOVE

job-postings

Jobs. DO NOT USE, SUBJECT TO CHANGE/REMOVE

phone

Phone management

Operations

Fasp Resource

Operations

Debug Resource

Operations

Test Authenticated Controller

Operations

Test Class Auth Controller

Operations

Test Class Authenticated Controller

Operations

Test Class Permit All Controller

Operations

Test Permit All Controller

Operations

Test Authorization Controller

Operations

Quarkus Test Resource For Transaction

Operations