Block API
Block API 提供了对 AI 工作流程块的创建、管理、部署和运行等功能。这些接口允许你管理和操作工作流程块，包括创建新的块、更新现有块、删除块、测试和部署等操作。
获取块详情
获取指定工作流程块的详细信息。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| pageId | string | 是 | 块ID |
GET /block/block_123
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
获取块列表
获取指定项目下的工作流程块列表。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| projectId | string | 是 | 项目ID |
| page | integer | 否 | 页码，默认1 |
| size | integer | 否 | 每页数量 |
GET /block/list/project_123?page=1&size=10
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
创建块
在指定项目下创建新的工作流程块。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| projectId | string | 是 | 项目ID |
| name | string | 是 | 块名称 |
| description | string | 否 | 块描述 |
| type | string | 是 | 块类型 |
POST /block/project_123
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
{
"name": "新工作流",
"description": "这是一个新的工作流",
"type": "page"
}
更新块
更新指定工作流程块的信息。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| pageId | string | 是 | 块ID |
| name | string | 否 | 块名称 |
| description | string | 否 | 块描述 |
| content | object | 否 | 块内容 |
PUT /block/block_124
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
{
"name": "更新后的工作流",
"description": "这是更新后的工作流描述"
}
删除块
/block/:projectId/:pageId
删除指定的工作流程块。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| projectId | string | 是 | 项目ID |
| pageId | string | 是 | 块ID |
| confirm | boolean | 否 | 确认删除 |
DELETE /block/project_123/block_124?confirm=true
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
复制块
/block/:projectId/:pageId/duplicate
复制指定的工作流程块。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| projectId | string | 是 | 项目ID |
| pageId | string | 是 | 源块ID |
POST /block/project_123/block_124/duplicate
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
测试块
测试工作流程块的功能。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| inputs | object | 是 | 测试输入参数 |
POST /block/test
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
{
"inputs": {
"text": "测试文本",
"options": {
"language": "zh"
}
}
}
运行块
运行指定的工作流程块。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| pageId | string | 是 | 块ID |
| inputs | object | 是 | 运行输入参数 |
POST /block/block_124/run
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
{
"inputs": {
"text": "运行文本",
"options": {
"language": "zh"
}
}
}
部署块
部署工作流程块。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| blockId | string | 是 | 块ID |
| access | string | 是 | 访问权限 |
| version | string | 否 | 版本号 |
POST /block/block_124/deploy
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
{
"access": "public",
"version": "1.0.0"
}
获取下一个版本号
获取块的下一个可用版本号。请求参数
GET /block/block_124/next-version
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
更新部署配置
更新块的部署配置。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| bid | string | 是 | 块ID |
| inputs | array | 否 | 输入参数配置 |
| access | string | 否 | 访问权限 |
| deployType | string | 否 | 部署类型 |
| cover | string | 否 | 封面图片 |
PUT /block/block_124/deployment
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
{
"inputs": [
{
"name": "text",
"type": "string",
"required": true
}
],
"access": "public",
"deployType": "api",
"cover": "https://example.com/cover.jpg"
}
运行已部署的块
运行已部署的工作流程块。请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| bid | string | 是 | 块ID |
| runId | string | 否 | 运行ID |
| inputs | object | 否 | 输入参数 |
| version | string | 否 | 版本号 |
POST /block/block_124/api
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN
{
"inputs": {
"text": "测试文本"
},
"version": "1.0.0"
}
错误码说明
错误码说明
| 错误码 | 说明 |
|---|
| 400 | 请求参数错误 |
| 401 | 未授权或令牌无效 |
| 403 | 权限不足 |
| 404 | 块不存在 |
| 409 | 块名称已存在 |
| 422 | 请求参数验证失败 |
| 500 | 服务器错误 |
