LangSmith 的 API 支持通过 API 密钥以编程方式访问 UI 中所有可用的操作,只有少数例外在仅用户端点中注明。
有一些限制将很快取消
- LangSmith SDK 尚不支持这些组织管理操作。
- 具有组织管理员权限的组织范围服务密钥可用于这些操作。
使用 X-Tenant-Id 标头指定要定位的工作区。如果不存在此标头,则操作将默认为 API 密钥最初创建时所在的工作区(如果它不是组织范围的)。如果使用组织范围的 API 密钥访问工作区范围的资源时未指定 X-Tenant-Id,则请求将失败并返回 403 Forbidden。
下面列出了一些常用的端点和用例。有关可用端点的完整列表,请参阅API 文档。所有请求都应包含 X-Organization-Id 标头,并且针对特定工作区的请求应包含 X-Tenant-Id 标头。
工作区
用户管理
RBAC
成员管理
RBAC下的列出角色应在检索这些操作的角色 ID 时使用。列出[组织|工作区]成员端点(如下所示)的响应中的"id"应作为这些操作中的identity_id使用。 组织级别:
工作区级别
这些参数应省略:read_only(已弃用)、password 和 full_name(仅限基本身份验证)
API 密钥
安全设置
您可以在工作区的设置 > 共享选项卡下或通过 API 更新这些设置
- 更新组织共享设置
- 使用
unshare_all 取消共享组织中所有共享资源 - 使用 disable_public_sharing 阻止将来共享资源
这些设置只能通过 API 编辑
- 禁用/启用 PAT 创建(适用于自托管,Helm chart 版本 0.11.25+ 可用)
- 使用
pat_creation_disabled 禁用整个组织的 PAT 创建。
- 有关无法创建 PAT 的组织查看者角色的信息,请参阅管理指南。
仅用户端点
这些端点是用户范围的,需要登录用户的 JWT,因此它们只能通过 UI 执行。
/api-key/current 端点:这些与用户的 PAT 相关
/sso/email-verification/send(仅限云):此端点与 SAML SSO 相关
示例代码
下面的示例代码演示了一些与组织管理相关的常见工作流程。请务必在代码中所有出现 <replace_me> 的地方进行必要的替换。
import os
import requests
def main():
api_key = os.environ["LANGSMITH_API_KEY"]
# LANGSMITH_ORGANIZATION_ID is not a standard environment variable in the SDK, just used for this example
organization_id = os.environ["LANGSMITH_ORGANIZATION_ID"]
base_url = os.environ.get("LANGSMITH_ENDPOINT") # or "https://api.smith.langchain.com". Update appropriately for self-hosted installations or the EU region
headers = {
"Content-Type": "application/json",
"X-API-Key": api_key,
"X-Organization-Id": organization_id,
}
session = requests.Session()
session.headers.update(headers)
workspaces_path = f"{base_url}/api/v1/workspaces"
orgs_path = f"{base_url}/api/v1/orgs/current"
api_keys_path = f"{base_url}/api/v1/api-key"
# Create a workspace
workspace_res = session.post(workspaces_path, json={"display_name": "My Workspace"})
workspace_res.raise_for_status()
workspace = workspace_res.json()
workspace_id = workspace["id"]
new_workspace_headers = {
"X-Tenant-Id": workspace_id,
}
# Grab roles - this includes both organization and workspace roles
roles_res = session.get(f"{orgs_path}/roles")
roles_res.raise_for_status()
roles = roles_res.json()
# system org roles are 'Organization Admin', 'Organization User'
# system workspace roles are 'Admin', 'Editor', 'Viewer'
org_roles_by_name = {role["display_name"]: role for role in roles if role["access_scope"] == "organization"}
ws_roles_by_name = {role["display_name"]: role for role in roles if role["access_scope"] == "workspace"}
# Invite a user to the org and the new workspace, as an Editor.
# workspace_role_id is only allowed if RBAC is enabled (an enterprise feature).
new_user_email = "<replace_me>"
new_user_res = session.post(
f"{orgs_path}/members",
json={
"email": new_user_email,
"role_id": org_roles_by_name["Organization User"]["id"],
"workspace_ids": [workspace_id],
"workspace_role_id": ws_roles_by_name["Editor"]["id"],
},
)
new_user_res.raise_for_status()
# Add a user that already exists in the org to the new workspace, as a Viewer.
# workspace_role_id is only allowed if RBAC is enabled (an enterprise feature).
existing_user_email = "<replace_me>"
org_members_res = session.get(f"{orgs_path}/members")
org_members_res.raise_for_status()
org_members = org_members_res.json()
existing_org_member = next(
(member for member in org_members["members"] if member["email"] == existing_user_email), None
)
existing_user_res = session.post(
f"{workspaces_path}/current/members",
json={
"user_id": existing_org_member["user_id"],
"workspace_ids": [workspace_id],
"workspace_role_id": ws_roles_by_name["Viewer"]["id"],
},
headers=new_workspace_headers,
)
existing_user_res.raise_for_status()
# List all members of the workspace
members_res = session.get(f"{workspaces_path}/current/members", headers=new_workspace_headers)
members_res.raise_for_status()
members = members_res.json()
workspace_member = next(
(member for member in members["members"] if member["email"] == existing_user_email), None
)
# Update the user's workspace role to Admin (enterprise-only)
existing_user_id = workspace_member["id"]
update_res = session.patch(
f"{workspaces_path}/current/members/{existing_user_id}",
json={"role_id": ws_roles_by_name["Admin"]["id"]},
headers=new_workspace_headers,
)
update_res.raise_for_status()
# Update the user's organization role to Organization Admin
update_res = session.patch(
f"{orgs_path}/members/{existing_org_member['id']}",
json={"role_id": org_roles_by_name["Organization Admin"]["id"]},
)
update_res.raise_for_status()
# Create a new Service key
api_key_res = session.post(
api_keys_path,
json={"description": "my key"},
headers=new_workspace_headers,
)
api_key_res.raise_for_status()
api_key_json = api_key_res.json()
api_key = api_key_json["key"]
if __name__ == "__main__":
main()