Tổng quan
Imbrace SDK là client chính thức cho Imbrace Gateway, có sẵn cho TypeScript và Python. Cả hai SDK đều bao bọc cùng một Gateway API với cùng các resource namespaces, cùng mô hình xác thực, và cùng ngữ nghĩa thử lại/lỗi — hãy chọn ngôn ngữ phù hợp với stack của bạn.
Tính năng chính
| Tính năng | Chi tiết |
|---|---|
| An toàn kiểu dữ liệu | TypeScript types và Python type hints trên mọi resource |
| Hai loại thông tin xác thực | apiKey hoặc accessToken — xem Xác thực |
| Tự động thử lại | Thử lại 429 và 5xx với exponential backoff, không cần cấu hình |
| Streaming AI | SSE / async iterator cho streamChat và AI completions |
| Async & đồng bộ (Py) | ImbraceClient (đồng bộ) và AsyncImbraceClient (bất đồng bộ) |
| Hủy (TS) | Truyền AbortSignal để hủy tác vụ đang thực hiện |
Cài đặt
npm install @imbrace/sdkpip install imbraceHello, world
import { ImbraceClient } from "@imbrace/sdk"
const client = new ImbraceClient({ accessToken: process.env.IMBRACE_ACCESS_TOKEN })const me = await client.platform.getMe()from imbrace import ImbraceClient
with ImbraceClient(access_token=os.environ["IMBRACE_ACCESS_TOKEN"]) as client: me = client.platform.get_me()Các resource có sẵn
Mọi namespace đều có trên cả hai SDK. Các phương thức tuân theo quy ước ngôn ngữ — client.aiAgent.streamChat() trong TS, client.ai_agent.stream_chat() trong Python.
| Namespace | Microservice | Mục đích |
|---|---|---|
client.aiAgent / client.ai_agent | ai-agent | Streaming AI chat, embeddings, parquet, chat-client sub-API |
client.chatAi / client.chat_ai | ai-service-v2 | AI Agent CRUD (tạo/cập nhật/xóa/danh sách) |
client.documentAi / client.document_ai | ai-service-v2 | Phân tích tài liệu, trích xuất, AI trên tệp |
client.agent | marketplace | Mẫu AI agent + use-case (tạo nguyên tử assistant + workflow + channel qua createUseCase) |
client.workflows | workflow-engine | Tự động hóa workflow — flows, triggers, runs |
client.boards | data-board | CRM boards — CRUD, items, fields, search, segments, CSV; KnowledgeHub thư mục & tệp |
client.platform, client.organizations, client.teams | platform | Người dùng, tổ chức, nhóm, business unit |
client.contacts, client.conversations, client.messages, client.channel, client.categories, client.campaign, client.outbound | channel-service | Liên hệ, hội thoại, tin nhắn, quản lý kênh/chiến dịch |
client.marketplace | marketplace | Tệp marketplace, mẫu email, workflow kênh |
client.fileService | file-service | Tải tệp theo ngữ cảnh (đính kèm board, tệp liên hệ, tệp tài chính, presigned URL) |
client.ips, client.schedule | ips | Lịch / quy tắc tự động giữa các tiến trình |
client.ai | ai-service-v2 | Completions/embeddings tương thích OpenAI, providers, guardrails |
client.auth | platform / backend cũ | Đăng nhập (OTP, mật khẩu, SSO), exchange token |
Để xem danh sách đầy đủ và tài liệu tham khảo phương thức, hãy xem Resources.
Khi nào nên chọn loại thông tin xác thực nào
| API Key | Access Token | |
|---|---|---|
| Vai trò của Imbrace? | Một tính năng bên trong backend của bạn | Imbrace LÀ backend của bạn |
| Người dùng của ai? | Của bạn | Của Imbrace |
| Phù hợp nhất cho | Server-to-server, script nội bộ, tích hợp CRM | Ứng dụng hướng đến người dùng cuối, nơi mỗi người dùng đăng nhập |
Cây quyết định đầy đủ: Xác thực →.
Các bước tiếp theo
- Cài đặt → — thiết lập gói và thông tin xác thực
- Quick Start → — thực hiện lời gọi đầu tiên trong 60 giây
- Hướng dẫn toàn diện → — hướng dẫn từ đầu đến cuối cho bốn quy trình làm việc chính (AI agents, workflows, knowledge hub, boards)