Skip to content

OpenAPI 接口说明

本文档用于说明云扉平台对外开放的 算力与资源管理 API 接口以及ComfyUI API 接口,面向需要通过程序化方式管理 GPU 实例、镜像与算力生命周期的开发者与系统集成方。

算力相关接口,开发者可以完成以下核心能力:

  • 查询可用算力 SKU 与区域资源
  • 创建、查询、控制与释放算力实例
  • 管理实例运行状态(开机 / 关机 / 状态查询)
  • 实例续租与计费周期控制
  • 将实例保存为镜像并管理个人镜像资源

ComfyUI 相关接口,开发者可以完成以下核心能力:

  • 查询可用 ComfyUI 应用、任务与生成结果
  • 下载生成文件

所有接口均基于 HTTP + JSON 协议,统一使用 Bearer Token 进行身份认证,并提供多语言调用示例,便于快速集成。


认证与访问令牌(Access Token)

所有 OpenAPI 接口均需要通过访问令牌(Access Token)进行身份认证。

在调用接口前,用户需先获取 Access Token,并在每一次请求中通过 HTTP Header 传递该令牌。

请求 Header 示例

http
Authorization: Bearer <AccessToken>

准备工作

在调用云扉平台的 OpenAPI 或 ComfyUI API 之前,请务必完成以下准备工作。

1. 获取 Access Token

前往 控制台->开发选项,在令牌管理中新增令牌

新增令牌


2. 创建 ComfyUI 应用并获取应用 ID(appId)

ComfyUI 相关 API 均以 应用(App) 为基础进行调用。

创建ComfyUI应用

创建应用成功后,可查看该应用的 appId,该参数在后续所有 ComfyUI 任务接口中均为必填。


相关 API 文档

  • OpenAPI 接口文档
    用于算力实例、镜像与资源生命周期管理
    👉 请前往:OpenAPI 接口文档
  • ComfyUI API 接口文档
    用于 ComfyUI 应用、任务与生成结果管理
    👉 请前往:ComfyUI API 接口文档