跳转到主要内容
使用单个 API 调用处理文档(用于创建处理事务、上传文件并启动处理事务)的典型流程包括以下步骤:
  1. 获取所有可用 Skill 的列表
  2. 创建并启动处理事务
  3. 监控处理事务状态
  4. 下载源文件和结果文件
发送到服务器的每个请求都必须包含身份验证信息。更多信息请参阅身份验证 如果您只有一个小于 30 MB 的文件,且不需要编辑该文件的图像,请使用此方案。

获取所有可用 Skill 的列表

为此,请向 skills 资源发送一个 GET 请求:
GET https://your-server/api/publicapi/v1/skills
运行以下命令: Windows:
curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
Linux:
curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'
因此,您将收到关于添加到该应用实例的所有 Skill 的信息。

创建并启动处理事务

为此,请向 transactions/launch 资源发送 POST 请求:
POST https://your-server/api/publicapi/v1/transactions/launch
在请求正文中,指定先前 API 调用返回的 skillId,并发送要处理的文件。请求正文示例如下:
{
  "settings": {
    "skillId": "00000000-0000-0000-0000-000000000001"
  },
  "files": [
    {
      "file": "image content"
    }
  ]
}
运行以下命令: Windows:
curl -X POST "https://your-server/api/publicapi/v1/transactions/launch" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"settings\": {
     \"skillId\": \"00000000-0000-0000-0000-000000000001\"
   },
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Linux:
curl -X POST 'https://your-server/api/publicapi/v1/transactions/launch' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "settings": {
     "skillId": "00000000-0000-0000-0000-000000000001"
   },
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
因此,您将收到一个响应,其中包含已创建的处理事务的 id

监控处理事务的状态

为此,请向 transactions 资源发送 GET 请求:
GET https://your-server/api/publicapi/v1/transactions/transaction-id
运行以下命令: Windows:
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
Linux 版:
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'
因此,您将收到一个包含处理事务状态的响应。处理事务可能处于以下状态之一:
  • New。处理事务已创建,但尚未加入处理队列。
  • Queued。处理事务已加入处理队列。
  • InProgress。处理事务正在处理。
  • Processed。处理事务已成功处理。
  • ProcessedWithWarnings。处理事务已处理,但出现了警告。
  • NotProcessed。由于错误,处理事务未被处理。
  • Deleted。处理事务被用户删除,或因保留策略而自动删除。
如果处理事务的状态为 ProcessedProcessedWithWarnings,请转到步骤 4。

下载源文件和结果文件

要下载源文件,请向 transactions/files/download 资源发送 GET 请求,并在其中指定文件 ID(该 ID 在上一次请求中获取):
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download
运行以下命令: Windows:
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
适用于 Linux:
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'