logologoDocsDownloadPricingChangelogBlog
CommunityLogin

Cloud Function API Overview

If you want to use a published OOMOL function from Codex, Claude Code, or a regular terminal session, start with the CLI guide. This page covers the lower-level programmatic integration layer.

OOMOL Cloud Function currently exposes its task execution layer through the Cloud Task v3 endpoints and SDKs. In the product UI and docs, Cloud Function is the feature name; Cloud Task is the current API and package naming used for direct integrations.

This API lets you submit serverless block runs, poll for status, fetch results, manage your queue, and upload input files.

What You Can Build​

  • Trigger a published block from your own application
  • Poll long-running jobs until they finish
  • Upload files before task creation and pass the returned URL into inputValues
  • Pause or resume the current user's queue
  • Expose Cloud Task as MCP tools for AI agents

Current Scope​

The current SDKs in this repo target Cloud Task API v3 and focus on one workload type:

  • serverless

Task creation always targets:

  • packageName
  • packageVersion
  • blockName
  • optional inputValues

Choose The Right Integration​

OptionBest forInstall
CLICodex, Claude Code, terminal usage, and individual users who want the simplest pathbun install -g @oomol-lab/oo-cli
TypeScript / JavaScript SDKWeb apps, Node.js services, browser-side integrationsnpm install oomol-cloud-task-sdk
Python SDKPython backends, scripts, data toolingpip install oomol-cloud-task-sdk
MCP SDKMCP Server wrappers for AI tools and agentsnpm install oomol-cloud-mcp-sdk
HTTP with curlMinimal integrations, debugging, non-SDK environmentsNo SDK required

Authentication​

Cloud Task v3 supports two authentication modes:

  • Bearer Token: pass an API key to the SDK, or send Authorization: Bearer <apiKey>
  • Cookie: keep the oomol-token cookie attached to requests

Core Workflow​

  1. Create a task.
  2. Store the returned taskID.
  3. Poll the task result until it reaches success or failed.
  4. Read resultURL or resultData when the task succeeds.

Common Task States​

  • In progress: queued, scheduling, scheduled, running
  • Final: success, failed