货物 API
类型脚本客户端 货物 API. 使用它来管理数据模型,协调工作流程,构建AI代理,并和来自Node.js或浏览器的Cargo平台相融合.
API 参考 : 文件.getcargo.ai/参考/介绍
安装
npm install @cargo-ai/api
同伴依赖关系
@cargo-ai/api 取决于 @ cargo-ai/ 类型 财务报告和审定财务报表 @ cargo-ai/ 用户并同时出版。 如果您的环境尚未提供, 请安装 :
npm install @cargo-ai/types @cargo-ai/utils
使用量
构建 API 客户端
通过调用创建 API 客户端 buildApi 使用您的 API 令牌( 守护符 ) :
import { buildApi } from "@cargo-ai/api";
const api = buildApi({
accessToken: "YOUR_API_TOKEN",
});
// Use domain APIs
const datasets = await api.storage.dataset.all();
const workflows = await api.orchestration.workflow.all();
baseUrl 默认为 https://api.getcargo.io。如果需要针对不同的环境:
const api = buildApi({
baseUrl: "https://custom-api.example.com",
accessToken: "YOUR_API_TOKEN",
});
客户行为 : HTTP请求使用6分钟超时. 长期运行的操作(如同步,运行)可能需要通过其他方式进行民意调查或观察;参见API参考.
域客户端和类型
软件包导出类型 域名 命名空间和 API 模块用于:
- 爱 - AI资源、代理、MCP服务器、文件
- 计费 - 订阅和账单
- 连接 - 连接器、集成器、过滤器
- 内容 - 知识档案和图书馆
- A. 背景情况 - 上下文存储器、运行时沙盒、知识图
- 表达式 - 表达式和公式助手
- 托管 - 货物托管应用程序、工人、部署、inv vars、定制域
- 管弦 - 工作流程、剧作、工具、模板
- 收入组织 - 成员、能力、领土
- 分块 - 部分,变化
- 存储 - 数据集、模型、关系、列
- 记录系统集成 - 记录系统,客户
- 用户管理 - 用户和权限
- 工作空间管理 - 工作空间、文件夹、角色、符号
每个域都暴露 子区域 在API的例子。 实例:
| 域名 | 分地区(如:. api.<domain>.<sub>(中文(简体) ) |
|---|---|
| 爱 | 模板、代理、发布、聊天、消息、投票、文档、mcpServer、mcpClient、 即时、内存、文件、建议的行动 |
| 计费 | 使用、订阅 |
| 连接 | 连接器、 集成、 本地集成 |
| 内容 | 文件, 库 |
| A. 背景情况 | 仓库、运行时间、图表 |
| 表达式 | 最喜欢的食谱、食谱、表达式 |
| 托管 | 应用、工人、部署、掩体、自定义域 |
| 管弦 | 批量、工作流程、播放、工具、发布、草稿、释放、运行、记录、节点、模板 |
| 收入组织 | 分配、能力、成员、领土 |
| 分块 | 段、 更改、 记录 |
| 存储 | 列、数据集、模型、关系、运行、记录 |
| 记录系统集成 | 系统记录、客户端、日志 |
| 用户管理 | 用户 |
| 工作空间管理 | 工作空间、文件、用户、符号、角色、文件夹 |
使用域类型(来自 @cargo-ai/api 或者说 @cargo-ai/types请求/答复打字和API实例api.storage, (中文(简体) ), api.connection等),用于HTTP呼叫.
更多使用实例
// Create a connector – a dataset is automatically created for each connector.
const { connector, dataset } = await api.connection.connector.create({
name: "My HubSpot",
slug: "my-hubspot",
integrationSlug: "hubspot",
config: {
/* integration-specific credentials / settings */
},
});
// List storage runs for a model
const runs = await api.storage.run.list({ modelUuid: "...", limit: 20 });
// List orchestration runs with filters
const orchestrationRuns = await api.orchestration.run.list({
workflowUuid: "...",
statuses: ["success"],
});
处理错误
import { determineIfIsFetcherError, type FetcherError } from "@cargo-ai/api";
try {
await api.storage.dataset.get("...");
} catch (err) {
if (determineIfIsFetcherError(err)) {
const fetcherError = err as FetcherError;
console.error(fetcherError.status, fetcherError.body);
}
}
所需资源
- 节点.js 22.x
- 类型脚本( 类型)
资源
- 货物 API 参考文献 - 终点、认证和平台概念(Datasets、模型、连接器、工具、游戏、代理等)
- API 令牌: 在您的工作空间中创建 设置 – API
许可证
许可证信息请参见寄存器的根.