云函数 API 概览

如果你想在 Codex、Claude Code 或普通终端里直接使用已经发布的 OOMOL 函数, 应该先看 oo-cli 指南。如果你需要当前 CLI 的具体 命令模型和示例,请同时查看 命令参考。这一页介绍的是 更底层的程序化接入层。

OOMOL 云函数当前通过 Cloud Task v3 这组接口和 SDK 暴露任务执行能力。对外的产品名称是“云函数”,而 Cloud Task 是当前直连接入时会看到的 API 和包名。

你可以用这组接口提交 serverless 区块任务、轮询任务状态、读取结果、管理队列,以及上传输入文件。

可以用来做什么

  • 在你自己的应用里触发已发布的 block
  • 轮询长任务直到完成
  • 先上传文件,再把返回的 URL 填进 inputValues
  • 暂停或恢复当前用户队列
  • 通过 MCP 把 Cloud Task 能力暴露给 AI Agent

当前支持范围

当前仓库中的 SDK 对接的是 Cloud Task API v3,聚焦一种 workload:

  • serverless

创建任务时核心参数是:

  • packageName
  • packageVersion
  • blockName
  • 可选的 inputValues

怎么选接入方式

方式适合场景安装命令
oo-cliCodex、Claude Code、终端使用、需要混合搜索 package 和 connector 的场景,以及想走最简单路径的个人用户wget -qO - https://cli.oomol.com/install.sh | bashcurl -fsSL https://cli.oomol.com/install.sh | bash
TypeScript / JavaScript SDKWeb 应用、Node.js 服务、浏览器侧集成npm install oomol-cloud-task-sdk
Python SDKPython 后端、脚本、数据工具pip install oomol-cloud-task-sdk
MCP SDK给 AI 工具或 Agent 提供 MCP Servernpm install oomol-cloud-mcp-sdk
HTTP + curl极简接入、调试、非 SDK 场景不需要 SDK

鉴权

Cloud Task v3 支持两种鉴权方式:

  • Bearer Token:在 SDK 里传 API Key,或手动发送 Authorization: Bearer <apiKey>
  • Cookie:请求里携带 oomol-token

典型调用流程

  1. 创建任务。
  2. 记录返回的 taskID
  3. 轮询任务结果直到进入 successfailed
  4. 成功后读取 resultURLresultData

常见任务状态

  • 进行中:queuedschedulingscheduledrunning
  • 终态:successfailed

相关文档