Skip to content

API reference: tenants and members ​

管理工作空间、成员、邀请、API Key 和审计日志。操作作用于当前活跃空间,跨空间访问按接口权限校验。

所有 /tenants/:id/* 路由在组级挂载 PathTenantMatch()(internal/middleware/access.go):URL 中的 :id 必须等于当前活跃空间(跨空间超管例外),防止越权操作他人空间。

租户 memory_config 配置字段及个人记忆接口见长期记忆 API。空间管理员更新配置时提交要保留的完整对象。

空间生命周期 ​

POST /api/v1/tenants ​

用途:创建空间(自助开新工作区;调用者自动成为 Owner)。权限:任何已登录用户(可无空间);API key 仅平台 key 且具 system_tenants_manage。Handler: internal/handler/tenant.go

字段类型必填说明
namestring是(binding:"required,min=1,max=128")空间名称
descriptionstring否(binding:"max=512")描述

跨空间超管可提交完整 types.Tenant(含 storage_quota、status 等)。

响应:201 {"success":true,"data":{Tenant}}(配置允许时可能携带 api_key)。自助创建被禁用返回 403(code 2005),超配额返回 429。

bash
curl -X POST $BASE/api/v1/tenants -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"name":"我的空间"}'

GET /api/v1/tenants ​

用途:列出我可访问的空间。权限:已登录;API key 需 manage_tenant_settings 或 full-access。Handler: internal/handler/tenant.go

响应:200 {"success":true,"data":{"items":[TenantResponse]}}

bash
curl $BASE/api/v1/tenants -H "Authorization: Bearer $TOKEN"

GET /api/v1/tenants/all ​

用途:列出全部空间(跨空间超管)。权限:CrossTenant()(CanAccessAllTenants 且集群开启 EnableCrossTenantAccess);平台 key 需 system_tenants_read|manage。Handler: internal/handler/tenant.go

响应:200 {"success":true,"data":{"items":[TenantResponse]}}

bash
curl $BASE/api/v1/tenants/all -H "Authorization: Bearer $TOKEN"

用途:按关键字搜索空间(跨空间超管)。权限:同上。Handler: internal/handler/tenant.go

查询参数类型必填说明
keywordstring否关键字
tenant_idstring否精确空间 ID
page / page_sizeint否分页(默认 1/20,上限 100)

响应:200 {"success":true,"data":{"items":[...],"total","page","page_size"}}

bash
curl "$BASE/api/v1/tenants/search?keyword=demo&page=1" -H "Authorization: Bearer $TOKEN"

GET /api/v1/tenants/:id ​

用途:空间详情。权限:Viewer+;平台 key 需 system_tenants_read|manage。Handler: internal/handler/tenant.go

响应:200 {"success":true,"data":{TenantResponse}}

bash
curl $BASE/api/v1/tenants/1 -H "Authorization: Bearer $TOKEN"

PUT /api/v1/tenants/:id ​

用途:更新空间配置。权限:Owner;平台 key 需 system_tenants_manage。Handler: internal/handler/tenant.go

字段类型必填说明
name*string否(binding:"omitempty,min=1,max=128")新名称
description*string否(binding:"omitempty,max=512")新描述

响应:200 {"success":true,"data":{TenantResponse}}

bash
curl -X PUT $BASE/api/v1/tenants/1 -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"name":"新名字"}'

DELETE /api/v1/tenants/:id ​

用途:删除空间。权限:Owner;平台 key 需 system_tenants_manage。空间记录与全部成员关系被软删除,成员随即失去访问;空间内的知识库、模型等数据不会被立即物理清除,已删除空间排队中的 Wiki 任务不再调用模型。Handler: internal/handler/tenant.go

响应:200 {"success":true,"message":"Workspace deleted successfully"}

bash
curl -X DELETE $BASE/api/v1/tenants/1 -H "Authorization: Bearer $TOKEN"

空间 KV 配置 ​

:key 为配置键而非空间 ID(空间取自认证上下文),可选值:web-search-config、prompt-templates、parser-engine-config、storage-engine-config、chat-history-config、retrieval-config、memory-config、assistant-config、default-settings。

assistant-config 是 GsKnora 助手的空间设置:display_name(界面上的助手名称,最多 24 字,空表示默认名称)和 max_access_level(成员可选的最高权限等级:read_only 只读、confirm 修改前确认、auto_write 可恢复的修改直接执行,删除类仍需确认;默认 confirm)。成员在对话请求里用 assistant_access 选择自己的等级,服务端按空间上限截断。

default-settings 是空间默认模型配置,字段与替换语义见下方说明。默认搜索引擎仍由网络搜索服务的 is_default 决定(PATCH /api/v1/web-search-providers/:id)。

GET /api/v1/tenants/kv/:key ​

用途:读取空间级 KV 配置。权限:Viewer+;API key 需 manage_tenant_settings 或 full-access。Handler: internal/handler/tenant.go

响应:200 {"success":true,"data":{...对应配置对象...}}

bash
curl $BASE/api/v1/tenants/kv/retrieval-config -H "Authorization: Bearer $TOKEN"

PUT /api/v1/tenants/kv/:key ​

用途:更新空间级 KV 配置。权限:Admin+;API key 需 manage_tenant_settings 或 full-access。请求体:与 :key 对应的配置 JSON 对象。Handler: internal/handler/tenant.go

响应:200 {"success":true,"message":"Configuration updated"}

bash
curl -X PUT $BASE/api/v1/tenants/kv/web-search-config -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"enabled":true}'

空间默认模型:GET / PUT /api/v1/tenants/kv/default-settings ​

GET 需要 Viewer+,PUT 需要 Admin+;API key 还需 manage_tenant_settings 或 full-access。空间取自认证上下文。界面入口为设置 → 默认设置。

字段类型模型要求
chat_model_idstring对话模型 KnowledgeQA
utility_model_idstring短文本辅助任务使用的 KnowledgeQA;空时跟随对话默认
embedding_model_idstring向量模型 Embedding
rerank_model_idstring重排模型 Rerank
vlm_model_idstringVLLM,或启用视觉能力的 KnowledgeQA
asr_model_idstring语音识别模型 ASR

PUT 替换整个对象,应提交全部六项;遗漏的字段等同于空字符串。模型 ID 会去除首尾空白,新选择的非空 ID 必须在当前空间可用、已启用且能力匹配,否则返回 400。未改动的失效 ID 可以保留,便于逐项修复;清空字段则恢复回退行为。

智能体、知识库或任务显式选择的模型优先于空间默认。未设置或已失效的空间默认会回退到部署默认,再选择第一个可用模型;utility_model_id 为空或失效时跟随对话默认。GET /api/v1/models 的 default_for 标注空间指定的用途(如 KnowledgeQA、VLLM、Utility);is_default 只表示模型原生类型的默认标记,不能单靠它识别辅助任务或跨类型视觉默认。这里不会覆盖部署配置或已有资源保存的模型 ID。

GET 返回 {"success":true,"data":{...六项配置...}},尚未设置的值为空字符串。下面的 PUT 示例清空空间覆盖,恢复默认回退:

bash
curl -X PUT "$BASE/api/v1/tenants/kv/default-settings" \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"chat_model_id":"","utility_model_id":"","embedding_model_id":"","rerank_model_id":"","vlm_model_id":"","asr_model_id":""}'

PUT 成功返回 {"success":true,"data":{...保存后的六项配置...},"message":"Default settings updated successfully"}。实现:internal/handler/tenant_default_settings.go、internal/types/default_settings.go。

API Key 与 API 主体 ​

GET /api/v1/tenants/:id/api-keys ​

用途:列出空间 API key(掩码显示)。权限:Owner,仅 JWT(API key 默认拒绝)。Handler: internal/handler/tenant.go

响应:200 {"success":true,"data":[{id,scope_type,name,api_key(掩码),full_access,knowledge_base_ids,capabilities,last_used_at,expires_at,created_at}]}

bash
curl $BASE/api/v1/tenants/1/api-keys -H "Authorization: Bearer $TOKEN"

POST /api/v1/tenants/:id/api-keys ​

用途:创建空间 API key(明文仅返回一次)。权限:Owner,仅 JWT。Handler: internal/handler/tenant.go

字段类型必填说明
namestring是key 名称
full_accessbool否空间全权 key(默认 false)
knowledge_base_ids[]string否KB 白名单(scoped key)
capabilities[]string否capability 列表(见总览)
expires_at_unix*int64否过期时间戳

响应:201 {"success":true,"data":{...,"api_key":"<明文>","token":"<明文>"}}

bash
curl -X POST $BASE/api/v1/tenants/1/api-keys -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"name":"ingest-bot","capabilities":["ingest","retrieve"],"knowledge_base_ids":["kb-1"]}'

PUT /api/v1/tenants/:id/api-keys/:key_id ​

Owner,仅 JWT。更新已有 Key 的 name、full_access、knowledge_base_ids、capabilities、expires_at_unix,授权字段按整份配置提交;不是只改一个字段的 PATCH。expires_at_unix 省略或 null 会清除已有到期时间。更改权限后使用同一 token,新授权在后续认证时生效,不重新返回明文。

返回 200 {success,data:APIKeyResponse},Key 脱敏;非法能力/知识库范围返回 400,不存在返回 404。

bash
curl -X PUT "$BASE/api/v1/tenants/1/api-keys/5" \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"name":"search-bot","full_access":false,"knowledge_base_ids":["kb-1"],"capabilities":["retrieve"]}'

DELETE /api/v1/tenants/:id/api-keys/:key_id ​

用途:删除 API key。权限:Owner,仅 JWT。路径参数:key_id。

响应:200 {"success":true}

bash
curl -X DELETE $BASE/api/v1/tenants/1/api-keys/5 -H "Authorization: Bearer $TOKEN"

GET /api/v1/tenants/:id/api-principal-config ​

用途:读取 API 外部用户主体配置。权限:Owner,仅 JWT。Handler: internal/handler/tenant.go

响应:200 {"success":true,"data":{"mode":"tenant|direct|signed_token","direct_header_name","signed_token_header_name","require_direct_header","has_hmac_secret"}}

bash
curl $BASE/api/v1/tenants/1/api-principal-config -H "Authorization: Bearer $TOKEN"

PUT /api/v1/tenants/:id/api-principal-config ​

用途:更新 API 外部用户主体配置。权限:Owner,仅 JWT。

字段类型必填说明
modestring是tenant / direct / signed_token
require_direct_headerbool否direct 模式是否强制 Header
hmac_secret*string否signed_token 模式密钥(传 *** 保留原值)

响应:200,同 GET。

bash
curl -X PUT $BASE/api/v1/tenants/1/api-principal-config -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"mode":"signed_token","hmac_secret":"topsecret"}'

POST /api/v1/tenants/:id/api-principal-test-token ​

用途:签发用于测试的外部用户 JWT。权限:Owner,仅 JWT。

字段类型必填说明
external_user_idstring是外部用户 ID(≤128 字符)
expires_in_secondsint否1-3600,默认 900

响应:200 {"success":true,"data":{"token","header_name","expires_in_seconds","expires_at_unix","external_user_id"}}

bash
curl -X POST $BASE/api/v1/tenants/1/api-principal-test-token -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"external_user_id":"u-123"}'

成员管理(/tenants/:id/members) ​

Handler: internal/handler/tenant_member.go。API key 需 manage_members 或 full-access。

GET /api/v1/tenants/:id/members ​

用途:成员列表。权限:Viewer+。

查询参数类型必填说明
qstring否邮箱/用户名过滤
page / page_sizeint否分页

响应:200 {"success":true,"data":{"members":[{user_id,email,username,avatar,role,status,invited_by,joined_at}],"total","page","page_size"}}

bash
curl $BASE/api/v1/tenants/1/members -H "Authorization: Bearer $TOKEN"

POST /api/v1/tenants/:id/members ​

用途:直接添加成员。权限:Owner。

字段类型必填说明
emailstring是(binding:"required,email")成员邮箱(须已注册)
rolestring是(binding:"required")owner/admin/contributor/viewer

响应:201 {"success":true,"data":{成员对象}}

bash
curl -X POST $BASE/api/v1/tenants/1/members -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"email":"b@ex.com","role":"contributor"}'

PUT /api/v1/tenants/:id/members/:user_id ​

用途:修改成员角色。权限:Owner。请求体:{"role":"admin"}(binding:"required")。

响应:200 {"success":true}

bash
curl -X PUT $BASE/api/v1/tenants/1/members/u-123 -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"role":"admin"}'

DELETE /api/v1/tenants/:id/members/:user_id ​

用途:移除成员。权限:Owner。

响应:200 {"success":true}

bash
curl -X DELETE $BASE/api/v1/tenants/1/members/u-123 -H "Authorization: Bearer $TOKEN"

POST /api/v1/tenants/:id/leave ​

用途:退出空间(任何成员可自行退出;服务层拒绝导致空间无 Owner 的退出)。权限:Viewer+,仅 JWT。

响应:200 {"success":true}

bash
curl -X POST $BASE/api/v1/tenants/1/leave -H "Authorization: Bearer $TOKEN"

Handler: internal/handler/tenant_invitation.go、internal/handler/tenant_invite_link.go。API key 需 manage_members 或 full-access。

GET /api/v1/tenants/:id/invitations ​

用途:空间邀请列表。权限:Viewer+。

查询参数类型必填说明
include_terminalbool否包含已完结邀请
page / page_sizeint否分页

响应:200 {"success":true,"data":{"invitations":[{id,tenant_id,invitee_email,inviter_email,role,status,message,expires_at,is_share_link,accepted_count,...}],"total","page","page_size"}}

bash
curl $BASE/api/v1/tenants/1/invitations -H "Authorization: Bearer $TOKEN"

POST /api/v1/tenants/:id/invitations ​

用途:邀请成员(被邀请人在 /me/invitations 确认后才入库)。权限:Owner。

字段类型必填说明
emailstring是(binding:"required,email")被邀请邮箱
rolestring是(binding:"required")授予角色
messagestring否附言

响应:201 {"success":true,"data":{TenantInvitationResponse}}

bash
curl -X POST $BASE/api/v1/tenants/1/invitations -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"email":"c@ex.com","role":"viewer"}'

DELETE /api/v1/tenants/:id/invitations/:inv_id ​

用途:撤销邀请。权限:Owner。

响应:200 {"success":true}

bash
curl -X DELETE $BASE/api/v1/tenants/1/invitations/12 -H "Authorization: Bearer $TOKEN"

POST /api/v1/tenants/:id/invite-links ​

用途:创建分享链接(多次可用的注册邀请链接)。权限:Owner。Handler: internal/handler/tenant_invite_link.go

字段类型必填说明
rolestring是(binding:"required")链接授予的角色
messagestring否附言

响应:201 {"success":true,"data":{id,token,invite_url,role,status,expires_at,is_share_link:true,accepted_count}}

bash
curl -X POST $BASE/api/v1/tenants/1/invite-links -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"role":"viewer"}'

审计日志 ​

Handler: internal/handler/audit_log.go。游标分页。

GET /api/v1/tenants/:id/audit-log ​

用途:空间审计日志(含被拒绝操作记录)。权限:Admin+,仅 JWT。

查询参数类型必填说明
after_idint否游标(上次响应 next_cursor)
limitint否1-100,默认 50
actionstring否按动作过滤(如 rbac.member_added)
outcomestring否success / denied
actorstring否按操作者 user_id 过滤

响应:200 {"success":true,"data":[AuditLog],"next_cursor":N}

bash
curl "$BASE/api/v1/tenants/1/audit-log?limit=50" -H "Authorization: Bearer $TOKEN"

GET /api/v1/knowledge-bases/:id/activity ​

用途:单个 KB 的活动流(只读审计)。权限:KB 创建者 OR Admin+,且对 KB 有 read 权限;仅 JWT。查询参数同上(after_id/limit/action/outcome/actor)。注册于 RegisterKnowledgeBaseActivityRoutes。

响应:200 {"success":true,"data":[AuditLog],"next_cursor":N}。details 为动作负载;若该条由 API Key 触发,会包含 api_key_id 与 api_key_name(名称快照,不含明文 Key)。

bash
curl $BASE/api/v1/knowledge-bases/kb-1/activity -H "Authorization: Bearer $TOKEN"

实现参考 ​

路由注册:internal/router/routes_auth_tenant.go 的 RegisterTenantRoutes。Handler:internal/handler/tenant.go、internal/handler/tenant_member.go、internal/handler/tenant_invitation.go、internal/handler/tenant_invite_link.go、internal/handler/audit_log.go。