Get Started
Protocol flow

How requests become executions.

KeeperKit is the protocol boundary. A host application resolves a workflow, ensures it is ready to run, executes it through the SDK, and then polls execution status and logs until the run completes or fails.

Lifecycle

The SDK README describes a consistent four-step loop. This site keeps that logic visible so developers can implement reliable integrations.

1

Discover the workflow

Use listWorkflows() or the namespaced workflows.list() method and narrow by project, tag, or pagination.

2

Prepare the target

Read the workflow, confirm it is enabled, and enable it if the host app needs to run it immediately.

3

Execute the workflow

The execute call returns an executionId quickly, so callers can keep their UI responsive.

4

Observe progress

Poll status and logs with execution helpers until the run reaches success, error, or cancelled.

Why the SDK exists

Typed, ergonomic access

Developers should not need to write raw HTTP requests or manually map responses. The SDK wraps the KeeperHub API with typed helpers and documented defaults.

What the SDK does

Normalizes transport behavior

The client manages auth headers, request timeouts, safe retries, and typed error classes so application code can focus on workflow logic.

Suggested implementation pattern

This is the basic pattern used throughout the README: resolve, enable if necessary, execute, and then wait for completion.

import { KeeperKit } from "keeperkit";

const client = new KeeperKit({ apiKey: process.env.KEEPERHUB_API_KEY });

const workflows = await client.listWorkflows({ page: 1, limit: 20 });
const target = workflows.find((workflow) => workflow.name.includes("Savings Vault"));

if (!target?.enabled) {
  await client.enableWorkflow(target.id);
}

const execution = await client.executeWorkflow(target.id);
const result = await client.waitForExecution(target.id, execution.executionId, {
  timeoutMs: 60000,
  pollIntervalMs: 2000,
});
Modules

Workflows and executions

The protocol page maps directly to workflows and executions modules, which are the core runtime primitives.

Extensions

Chains and integrations

Protocols often depend on chain metadata and integration records. The SDK includes modules for both and keeps them typed.

Discovery

Marketplace and schema endpoints

Listed workflows and MCP schema discovery let apps build richer UIs and call public workflows with the correct payment flow.

When the backend accepts an execution but the status record is not indexed yet, callers should treat early 404s as temporary and retry for a short window instead of failing immediately.