Skip to main content
控制平面 API 是 LangSmith 部署 的一部分。通过控制平面 API,您可以以编程方式创建、管理和自动化您的 Agent Server 部署——例如,作为自定义 CI/CD 工作流的一部分。 在侧边栏的 控制平面 API 部分浏览完整的 API 参考,或参考以下端点分组:

主机地址

云数据区域的控制平面主机地址: 注意:LangSmith 的自托管部署将拥有自定义的控制平面主机地址。控制平面 API 可通过路径 /api-host 访问。例如,http(s)://<主机地址>/api-host/v2/deployments。更多详情请参阅 自托管使用指南

认证

要使用控制平面 API 进行认证,请将 X-Api-Key 请求头设置为有效的 LangSmith API 密钥,并将 X-Tenant-Id 请求头设置为要操作的有效工作区 ID。 curl 命令示例:

版本控制

每个端点路径都带有版本前缀(例如 v1v2)。

快速开始

  1. 调用 POST /v2/deployments 创建新的部署。响应体包含部署 ID (id) 和最新(也是第一个)修订版本的 ID (latest_revision_id)。
  2. 调用 GET /v2/deployments/{deployment_id} 获取部署信息。将 URL 中的 deployment_id 设置为部署 ID (id) 的值。
  3. 通过调用 GET /v2/deployments/{deployment_id}/revisions/{latest_revision_id} 轮询修订版本的 status,直到 status 变为 DEPLOYED
  4. 调用 PATCH /v2/deployments/{deployment_id} 更新部署。

示例代码

以下是示例 Python 代码,演示了如何编排控制平面 API 来创建部署、更新部署和删除部署。