概览

Imbrace SDK 是 Imbrace Gateway 的官方客户端，提供 TypeScript 和 Python 两种版本。两个 SDK 封装了相同的 Gateway API，具有相同的资源命名空间、相同的身份验证模型以及相同的重试/错误语义 — 选择适合你技术栈的语言即可。

在本站任意位置切换一次语言 Tab，其余文档将记住你的选择。

核心特性

特性	说明
类型安全	TypeScript 类型和 Python 类型提示覆盖每个资源
两种凭证类型	`apiKey` 或 `accessToken` — 参见身份验证
自动重试	429 和 5xx 使用指数退避自动重试，无需配置
AI 流式传输	SSE / async iterator 用于 `streamChat` 和 AI completions
Async & sync (Py)	`ImbraceClient`（同步）和 `AsyncImbraceClient`（异步）
取消请求 (TS)	`AbortSignal` 传播，用于取消进行中的请求

npm install @imbrace/sdk

pip install imbrace

Hello, world

TypeScript
Python

import { ImbraceClient } from "@imbrace/sdk"

const client = new ImbraceClient({ accessToken: "acc_your_token" })
const me = await client.platform.getMe()

from imbrace import ImbraceClient

with ImbraceClient(access_token="acc_your_token") as client:
    me = client.platform.get_me()

可用资源

每个命名空间在两个 SDK 上均可用。方法遵循语言约定 — TypeScript 中为 client.aiAgent.streamChat()，Python 中为 client.ai_agent.stream_chat()。

命名空间	用途
`client.aiAgent` / `client.ai_agent`	流式 AI 聊天、嵌入、parquet、chat-client 子 API
`client.chatAi` / `client.chat_ai`	助手 CRUD（创建/更新/删除/列出助手）
`client.activepieces`	工作流自动化 — flows、triggers、runs
`client.boards`	CRM 看板 — CRUD、条目、字段、搜索、段、CSV；KH 文件夹和文件
`client.platform`	用户、组织、权限
`client.contacts`, `client.conversations`, `client.messages`, `client.channel`	联系人 / 渠道层
`client.ai`	OpenAI 兼容的 completions 和 embeddings

完整列表和方法参考，请参阅资源参考。

选择哪种凭证

	API Key	Access Token
Imbrace 的角色？	你的后端中的某项功能	Imbrace 就是你的后端
谁的用户？	你的	Imbrace 的
最适合	服务端对服务端、内部脚本、CRM 集成	每个终端用户登录的面向用户应用

完整决策树：身份验证 →。

后续步骤

安装 → — 设置 package 和凭证
快速入门 → — 60 秒内完成第一次调用
完整流程指南 → — 四个主要工作流的端到端演练（assistants、workflows、knowledge hub、boards）