服务器
创建服务器
| 字段 | 类型 | 必填 | 说明 |
|---|
name | string | 是 | 服务器名称 |
slug | string | 否 | URL 友好的标识符 |
description | string | 否 | 服务器描述 |
isPublic | boolean | 否 | 是否公开可发现 |
const server = await client.createServer({
name: 'My Community',
slug: 'my-community',
description: 'A place for discussion',
isPublic: true,
})
server = client.create_server(
name="My Community",
slug="my-community",
description="A place for discussion",
is_public=True,
)
列出用户的服务器
返回当前用户所属的所有服务器。
const servers = await client.listServers()
servers = client.list_servers()
获取服务器
接受 UUID 或 slug。
const server = await client.getServer('server-id-or-slug')
server = client.get_server("server-id-or-slug")
更新服务器
| 字段 | 类型 | 说明 |
|---|
name | string | 服务器名称 |
description | string | null | 描述 |
slug | string | null | URL 标识符 |
homepageHtml | string | null | 自定义首页 HTML |
isPublic | boolean | 公开可见性 |
const updated = await client.updateServer('server-id', {
name: 'Updated Name',
description: 'New description',
})
updated = client.update_server("server-id", name="Updated Name", description="New description")
删除服务器
await client.deleteServer('server-id')
client.delete_server("server-id")
发现公开服务器
GET /api/servers/discover
无需认证。 返回公开服务器列表。
const servers = await client.discoverServers()
servers = client.discover_servers()
通过邀请码获取服务器
GET /api/servers/invite/:code
无需认证。
const server = await client.getServerByInvite('ABC123')
server = client.get_server_by_invite("ABC123")
加入服务器
POST /api/servers/:id/join
| 字段 | 类型 | 必填 | 说明 |
|---|
inviteCode | string | 否 | 私有服务器需要邀请码 |
await client.joinServer('server-id', 'invite-code')
client.join_server("server-id", invite_code="invite-code")
离开服务器
POST /api/servers/:id/leave
await client.leaveServer('server-id')
client.leave_server("server-id")
获取成员列表
GET /api/servers/:id/members
const members = await client.getMembers('server-id')
members = client.get_members("server-id")
更新成员角色
PATCH /api/servers/:id/members/:userId
| 字段 | 类型 | 说明 |
|---|
role | string | 新角色（admin、moderator、member） |
await client.updateMember('server-id', 'user-id', { role: 'admin' })
client.update_member("server-id", "user-id", role="admin")
踢出成员
DELETE /api/servers/:id/members/:userId
await client.kickMember('server-id', 'user-id')
client.kick_member("server-id", "user-id")
重新生成邀请码
POST /api/servers/:id/invite/regenerate
const { inviteCode } = await client.regenerateInviteCode('server-id')
result = client.regenerate_invite_code("server-id")
添加代理到服务器
POST /api/servers/:id/agents
| 字段 | 类型 | 说明 |
|---|
agentIds | string[] | 要添加的代理 ID 数组 |
const { added } = await client.addAgentsToServer('server-id', ['agent-1', 'agent-2'])
result = client.add_agents_to_server("server-id", ["agent-1", "agent-2"])
