Skip to content

Cerul developer surface

Cerul turns video and other long-form media into searchable evidence and structured artifacts. This repository is the public integration surface for the Cerul platform.

The product implementation is private. This repository contains only:

  • the sanitized OpenAPI 3.1 contract;
  • the TypeScript and Python SDKs;
  • the cerul command-line client;
  • MCP and Claude Code integrations;
  • public examples, compatibility notes, and release links.

Local and cloud runtimes use the same contract. Choose a base URL:

Cloud: https://api.cerul.ai/v1
Local: http://127.0.0.1:<dynamic-port>/v1

The local runtime requires its installation token. The cloud runtime accepts a Workspace API key or OAuth access token. Call GET /v1/capabilities before requesting optional capabilities; clients must not assume local and cloud offer identical execution.

Packages

Path Purpose
packages/js Generated TypeScript schema plus a small runtime client
packages/python Python client and generated operation registry
apps/cli CLI commands for search, ask, AgentSession, jobs, and export
integrations/mcp Remote MCP projection of the Capability Registry
integrations/claude-code Installable Claude Code integration

Verify

corepack pnpm install --frozen-lockfile
corepack pnpm check
python3 -m unittest discover -s packages/python/tests
cargo test --manifest-path apps/cli/Cargo.toml --locked

The public OpenAPI and generated SDK surfaces are produced from the private cerul-platform/contracts/openapi.yaml; they are not independently authored here. See ARCHITECTURE.md for the publication boundary.

No package publishing, binary release, or production deployment occurs from a source change alone.

Releases

Packages

Contributors

Languages