You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: llms/llms-full.txt
+50-37Lines changed: 50 additions & 37 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# XMTP Full Documentation
2
2
3
-
Generated at 02:16 AM UTC / November 05, 2025
3
+
Generated at 04:58 PM UTC / November 05, 2025
4
4
5
5
## Instructions for AI Tools
6
6
@@ -9990,13 +9990,15 @@ Group chats can have metadata like names, descriptions, and images to help users
9990
9990
To learn more, see the [Gated group example](https://github.com/ephemeraHQ/xmtp-agent-examples/tree/main/examples/xmtp-gated-group) in the xmtp-agents-examples repo.
9991
9991
:::
9992
9992
9993
-
## Available metadata fields
9993
+
## Group metadata
9994
+
9995
+
### Available metadata fields
9994
9996
9995
9997
- `group_name`: The name of the group chat
9996
9998
- `description`: A description of the group chat
9997
9999
- `image_url`: A URL pointing to an image for the group chat
9998
10000
9999
-
## Get and update metadata
10001
+
### Get and update metadata
10000
10002
10001
10003
```js [Node]
10002
10004
// Get metadata
@@ -10010,23 +10012,18 @@ await group.updateDescription('New Group Description');
10010
10012
await group.updateImageUrl('newurl.com');
10011
10013
```
10012
10014
10013
-
## Manage group chat membership
10014
-
10015
-
:::tip[Quickstart]
10016
-
To learn more, see the [Gated group example](https://github.com/ephemeraHQ/xmtp-agent-examples/tree/main/examples/xmtp-gated-group) in the xmtp-agents-examples repo.
10017
-
:::
10015
+
## Group membership
10018
10016
10019
10017
The maximum group chat size is 250 members.
10020
10018
10021
10019
### Add members
10022
10020
10023
-
You can add members directly by their Ethereum addresses or by their inbox IDs
10021
+
Add members directly by their Ethereum addresses or by their inbox IDs:
Members can be assigned different roles with varying permission levels. To learn more about how the permission system works, see [Understand group permissions](/agents/build-agents/group-permissions).
10081
+
10082
+
### Available roles
10083
+
10084
+
- **Member** - Default role for all group participants
10085
+
- **Admin** - Members with elevated permissions
10086
+
- **Super admin** - Highest permission level (creator starts as super admin)
The group permissions system controls what actions different members can take in a group chat. This guide explains how the system works conceptually. For practical code examples of managing roles and permissions, see [Manage group chats](/agents/build-agents/groups).
10461
10468
10462
10469
## Member statuses
10463
10470
10464
-
Member statuses are the roles that can be assigned to each participant (inbox ID) in a group chat. These are the available member statuses:
10471
+
Member statuses are the roles that can be assigned to each participant (inbox ID) in a group chat:
10465
10472
10466
-
- Member
10467
-
- Everyone in a group chat is a member. A member can be granted admin or super admin status. If a member's admin or super admin status is removed, they are still a member of the group.
10468
-
- Admin
10469
-
- Super admin
10473
+
- **Member** - Everyone in a group chat is a member. A member can be granted admin or super admin status. If a member's admin or super admin status is removed, they are still a member of the group.
10474
+
- **Admin** - Members with elevated permissions
10475
+
- **Super admin** - Highest permission level with full control over the group
10470
10476
10471
10477
## Options
10472
10478
@@ -10539,6 +10545,13 @@ If you aren't opinionated and don't set any permissions and options, groups will
10539
10545
10540
10546
To learn more about the `All_Members` and `Admin_Only` policy sets, see [group_permissions.rs](https://github.com/xmtp/libxmtp/blob/85dd6d36f46db1ed74fe98273eea6871fea2e078/xmtp_mls/src/groups/group_permissions.rs#L1192-L1226) in the LibXMTP repo.
10541
10547
10548
+
## Next steps
10549
+
10550
+
Now that you understand how the permission system works, see [Manage group chats](/agents/build-agents/groups) for practical code examples of:
0 commit comments