Skip to main content
LangSmith 的 API 支持通过 API 密钥进行编程访问,涵盖 UI 中所有可用的操作,仅有少数例外情况在仅限用户的端点中注明。
在深入此内容之前,阅读以下内容可能有所帮助:
有一些限制即将解除:
  • LangSmith SDK 尚不支持这些组织管理操作。
  • 具有组织管理员权限的组织范围服务密钥可用于执行这些操作。
使用 X-Tenant-Id 头来指定目标工作区。如果未提供该头,操作将默认在密钥最初创建的工作区中进行(如果该密钥不是组织范围的)。如果使用组织范围的服务密钥访问工作区范围的资源时未指定 X-Tenant-Id,请求将失败并返回 403 Forbidden
下面列出了一些常用的端点和用例。有关可用端点的完整列表,请参阅 API 文档所有请求都应包含 X-Organization-Id 头,而针对特定工作区的请求还应包含 X-Tenant-Id 头。

工作区

用户管理

基于角色的访问控制 (RBAC)

成员管理

应使用 RBAC 下的 列出角色 来检索这些操作的角色 ID。列出 [组织|工作区] 成员 端点(如下)响应中的 "id" 应作为这些操作中的 identity_id 使用。 组织级别: 工作区级别:
应省略以下参数:read_only(已弃用)、passwordfull_name(仅限基本认证

API 密钥

安全设置

进行这些更改需要组织管理员权限。
此处的“共享资源”指公共提示共享运行共享数据集
更新这些设置会影响组织中的所有资源
您可以在工作区的 设置 > 共享 选项卡下更新这些设置,也可以通过 API 更新:
  • 更新组织共享设置
    • 使用 unshare_all 取消共享所选工作区的所有共享资源 - 使用 disable_public_sharing 防止未来共享资源
这些设置只能通过 API 编辑:

仅限用户的端点

这些端点是用户范围的,需要已登录用户的 JWT,因此应仅通过 UI 执行。
  • /api-key/current 端点:与用户的个人访问令牌 (PAT) 相关
  • /sso/email-verification/send(仅限云版本):此端点与 SAML SSO 相关

示例代码

下面的示例代码演示了几个与组织管理相关的常见工作流。请确保在代码中出现 <replace_me> 的地方进行必要的替换。