cloudforbots-com Run Memory API
The run-memory API from cloudforbots-com — 5 operation(s) for run-memory.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cloudforbots-com:cloudforbots-com-run-memory-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Cloud for Bots Run Memory API
version: 1.0.0
description: 'One API for every Cloud for Bots tool: loop detection, run memory (checkpoint/resume), run budgets, approval rules and scheduled wake-ups for AI agents. **Auth:** `Authorization: Bearer `. Any one of your keys works for every tool. Free keys: https://cloudforbots.com/offer
**Retries:** read actions retry automatically on 502/503/504. Send `Idempotency-Key` to make writes safe to retry. **Limits:** 20 requests/second per key (429 + `Retry-After`). **Webhooks:** signed with `cfb-signature: t=,v1=`, where v1 = HMAC-SHA256(secret, t + "." + raw body). Retries: 1m, 5m, 30m, 2h, 6h. **MCP:** https://cloudforbots.com/mcp (Streamable HTTP). **Status:** https://cloudforbots.com/status
**SDKs:** TypeScript/JS (types) · Python
# Quickstart
Get a free key at cloudforbots.com/offer (one email, keys show right away). Any one of your keys works for every tool. Keep it in an environment variable:
```bash
export CLOUDFORBOTS_API_KEY=mb_your_key_here
```
## TypeScript / JavaScript
No install needed: the SDK is one zero-dependency ES module (Node 18+, Deno, Bun, browsers). ```bash
curl -o cloudforbots.mjs https://cloudforbots.com/sdk/cloudforbots.mjs
curl -o cloudforbots.d.ts https://cloudforbots.com/sdk/cloudforbots.d.ts # types for TypeScript
```
```ts
import { CloudForBots, CloudForBotsError } from "./cloudforbots.mjs";
const cfb = new CloudForBots(); // reads CLOUDFORBOTS_API_KEY
// 1. After each agent step, ask Loop Breaker if the run is stuck
const step = await cfb.loop.checkStep({ run_id: "invoice-run-42", tool: "search_crm", args: { customer: 4471 }, error: "timeout after 30s" });
if (step.halt) throw new Error("Loop detected: " + step.outcome);
// 2. Save progress so a crashed run can resume
await cfb.memory.saveCheckpoint({ run_id: "invoice-run-42", step: "invoice-312", state: { done: 312 } }, { idempotencyKey: "invoice-run-42:312" });
const resume = await cfb.memory.resume({ run_id: "invoice-run-42" });
// 3. Errors carry the HTTP status, type and request id
try { await cfb.approve.checkAction({ action: "delete 40 customer records" }); }
catch (e) { if (e instanceof CloudForBotsError) console.error(e.status, e.type, e.requestId); }
```
## Python
Standard library only (Python 3.8+). ```bash
curl -o cloudforbots.py https://cloudforbots.com/sdk/cloudforbots.py
```
```python
from cloudforbots import CloudForBots, CloudForBotsError
cfb = CloudForBots() # reads CLOUDFORBOTS_API_KEY
step = cfb.loop.check_step(run_id="invoice-run-42", tool="search_crm", args={"customer": 4471}, error="timeout after 30s")
if step.get("halt"):
raise SystemExit("Loop detected: " + step["outcome"])
cfb.memory.save_checkpoint(run_id="invoice-run-42", step="invoice-312", state={"done": 312}, idempotency_key="invoice-run-42:312")
print(cfb.memory.resume(run_id="invoice-run-42"))
try:
cfb.approve.check_action(action="delete 40 customer records")
except CloudForBotsError as e:
print(e.status, e.type, e.request_id)
```
## Webhooks
```python
from cloudforbots import verify_webhook
# Flask example: raw bytes, exactly as received
ok = verify_webhook(WEBHOOK_SECRET, request.headers["cfb-signature"], request.get_data())
```
Register an endpoint with `cfb.webhooks_add("https://you.example/hook", ["loop.halted", "budget.stopped"])` (Python) or `cfb.webhooks.add(url, events)` (JS). The secret is returned once. Rotate it with `cfb.webhooks_rotate(url)`: the old secret keeps working for 24 hours, and during that window `cfb-signature` carries two `v1=` values (`verify_webhook` accepts either). See failed deliveries with `cfb.webhooks_deliveries("failed")` and resend one with `cfb.webhooks_redeliver(id)`. Events: `loop.halted`, `budget.stopped`, `approval.held`, `call.failed`, `key.cap_warning`, `key.cap_reached`, `key.expiring`, `key.expired`. ## MCP
Point any MCP client at `https://cloudforbots.com/mcp` with header `Authorization: Bearer $CLOUDFORBOTS_API_KEY`.'
servers:
- url: https://cloudforbots.com
security:
- bearer: []
tags:
- name: run-memory
paths:
/api/v1/run-memory/save_checkpoint:
post:
operationId: run_memory__save_checkpoint
tags:
- run-memory
summary: save checkpoint
description: 'Call after each completed step with the state you would need to continue (cursor, ids done, partial results; up to 256 KB JSON). Pro saves it (last 20 per run, kept 30 days). Free watch-only saves nothing and returns would_save: exactly what would have been stored. Never put passwords or API keys in state.'
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
maxLength: 128
description: Makes the call safe to retry; the same key returns the stored reply for 24h.
- name: X-Request-Id
in: header
required: false
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
run_id:
type: string
description: A stable id for this job that survives a crash, e.g. "invoice-import-oct". Use the same id when you restart.
step:
type: string
description: The step you just finished, e.g. "imported page 3 of 10".
state:
type: object
description: JSON state needed to resume.
done:
type: array
items:
type: string
description: Optional list of completed item ids, so a resume skips them.
required:
- run_id
- step
- state
responses:
'200':
description: Tool result (always includes request_id).
headers:
x-request-id:
schema:
type: string
x-ratelimit-remaining:
schema:
type: integer
content:
application/json:
schema:
type: object
additionalProperties: true
'400':
description: Bad JSON
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'401':
description: Missing or bad key
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'403':
description: Key limits (scopes) do not allow this tool or action
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'409':
description: Same Idempotency-Key still running
'422':
description: Idempotency-Key reused on another route
'429':
description: Over 20 requests/second for this key, or free daily limit
headers:
retry-after:
schema:
type: integer
'504':
description: Tool did not answer in time; retry with the same Idempotency-Key
/api/v1/run-memory/resume:
post:
operationId: run_memory__resume
tags:
- run-memory
summary: resume
description: 'Call FIRST when a run starts. If a checkpoint exists for run_id (Pro), returns the last step, state and done list: continue from there and skip finished work. If none, start fresh.'
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
maxLength: 128
description: Makes the call safe to retry; the same key returns the stored reply for 24h.
- name: X-Request-Id
in: header
required: false
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
run_id:
type: string
description: A stable id for this job that survives a crash, e.g. "invoice-import-oct". Use the same id when you restart.
required:
- run_id
responses:
'200':
description: Tool result (always includes request_id).
headers:
x-request-id:
schema:
type: string
x-ratelimit-remaining:
schema:
type: integer
content:
application/json:
schema:
type: object
additionalProperties: true
'400':
description: Bad JSON
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'401':
description: Missing or bad key
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'403':
description: Key limits (scopes) do not allow this tool or action
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'409':
description: Same Idempotency-Key still running
'422':
description: Idempotency-Key reused on another route
'429':
description: Over 20 requests/second for this key, or free daily limit
headers:
retry-after:
schema:
type: integer
'504':
description: Tool did not answer in time; retry with the same Idempotency-Key
/api/v1/run-memory/list_checkpoints:
post:
operationId: run_memory__list_checkpoints
tags:
- run-memory
summary: list checkpoints
description: List recent checkpoints (step, size, time) for one run or all runs on your key.
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
maxLength: 128
description: Makes the call safe to retry; the same key returns the stored reply for 24h.
- name: X-Request-Id
in: header
required: false
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
run_id:
type: string
description: A stable id for this job that survives a crash, e.g. "invoice-import-oct". Use the same id when you restart.
responses:
'200':
description: Tool result (always includes request_id).
headers:
x-request-id:
schema:
type: string
x-ratelimit-remaining:
schema:
type: integer
content:
application/json:
schema:
type: object
additionalProperties: true
'400':
description: Bad JSON
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'401':
description: Missing or bad key
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'403':
description: Key limits (scopes) do not allow this tool or action
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'409':
description: Same Idempotency-Key still running
'422':
description: Idempotency-Key reused on another route
'429':
description: Over 20 requests/second for this key, or free daily limit
headers:
retry-after:
schema:
type: integer
'504':
description: Tool did not answer in time; retry with the same Idempotency-Key
/api/v1/run-memory/weekly_report:
post:
operationId: run_memory__weekly_report
tags:
- run-memory
summary: weekly report
description: 'Draft a plain-English report of the last 7 days: runs, checkpoints saved (Pro) or that would have been saved (free). Read-only; sends nothing.'
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
maxLength: 128
description: Makes the call safe to retry; the same key returns the stored reply for 24h.
- name: X-Request-Id
in: header
required: false
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: {}
responses:
'200':
description: Tool result (always includes request_id).
headers:
x-request-id:
schema:
type: string
x-ratelimit-remaining:
schema:
type: integer
content:
application/json:
schema:
type: object
additionalProperties: true
'400':
description: Bad JSON
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'401':
description: Missing or bad key
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'403':
description: Key limits (scopes) do not allow this tool or action
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'409':
description: Same Idempotency-Key still running
'422':
description: Idempotency-Key reused on another route
'429':
description: Over 20 requests/second for this key, or free daily limit
headers:
retry-after:
schema:
type: integer
'504':
description: Tool did not answer in time; retry with the same Idempotency-Key
/api/v1/run-memory/usage_and_upgrade:
post:
operationId: run_memory__usage_and_upgrade
tags:
- run-memory
summary: usage and upgrade
description: 'Show today''s usage for your key or IP and the $49/month All Access upgrade link (cloudforbots.com/offer). Free tier: 500 calls/day. Not metered.'
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
maxLength: 128
description: Makes the call safe to retry; the same key returns the stored reply for 24h.
- name: X-Request-Id
in: header
required: false
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: {}
responses:
'200':
description: Tool result (always includes request_id).
headers:
x-request-id:
schema:
type: string
x-ratelimit-remaining:
schema:
type: integer
content:
application/json:
schema:
type: object
additionalProperties: true
'400':
description: Bad JSON
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'401':
description: Missing or bad key
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'403':
description: Key limits (scopes) do not allow this tool or action
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
const: false
error:
type: object
properties:
type:
type: string
message:
type: string
request_id:
type: string
'409':
description: Same Idempotency-Key still running
'422':
description: Idempotency-Key reused on another route
'429':
description: Over 20 requests/second for this key, or free daily limit
headers:
retry-after:
schema:
type: integer
'504':
description: Tool did not answer in time; retry with the same Idempotency-Key
components:
securitySchemes:
bearer:
type: http
scheme: bearer