Skip to content
SLOE OS
API
API
OpenAPI
MCP
work.sloelabs.com
API version
v0.1.0+8bf142be
/
Overview
Capability
Overview
Search the live scoped capability registry before claiming a capability is absent.
Connection
Overview
Get one connection for your tenant by service (tenant-scoped read-back).
List the external-account connections wired for your tenant (Phase D).
Revoke your tenant's connection for a service.
Start or complete actor-bound consent, revoke an account, or manage an explicit expiring share.
Contact
Overview
Create a new contact (person or company)
Get a single contact by id (tenant-scoped)
List contacts for the current tenant (tenant-scoped read-back)
Update an existing contact
Decision
Overview
List/search the tenant decision log (semantic).
Record a settled decision with its WHY (and optional supersedes: D-NNN).
Document
Overview
Generate a document from a template
Summarize a document or text
Email
Overview
Render a polished, on-brand HTML + plain-text email from a spec against the shared email vocabulary (templates: notic...
Event
Overview
Emit a substrate event for other systems to react to
File
Overview
Store a file in R2 storage
Guide
Overview
List the guides currently live on a product's help centre (reads its guides.json manifest) — the corpus the in-app He...
Publish a user guide to a product's help centre (Cloudflare Pages) and return its public URL.
Integration
Overview
Discover approved tools or list the authenticated principal connections.
Execute one version-pinned tool using an explicit owned or shared connection and server policy.
App
Overview
SloeIntegrations: list the firm's connected accounts, and which apps' Connect will succeed (null = see toolkits).
SloeIntegrations: list the tools of one of the firm's connections, classed read / write / destructive.
SloeIntegrations: run a tool on one of the firm's connections for the named signed-in user.
SloeIntegrations: search the apps a firm can connect, and how each signs in (signIn.oauth / signIn.key); with {toolki...
SloeIntegrations: start a sign-in (returns the consent URL), finish it after consent, connect with the firm's own key...
Key
Overview
List API keys — never the secrets.
Mint a new API key for a tenant.
Revoke a key immediately (takes effect within the 30s auth cache).
Rotate a key: mints a successor with the same tenant/name/scopes (raw key returned ONCE) and gives the old key an exp...
What can THIS key do — tenant, the abilities it may call (expanded), collections, sub-tenant flag, admin, and — once ...
Lead
Overview
Create a new lead in the pipeline
Get one lead by id, scoped to your tenant
List leads for your tenant, optionally filtered by status
Update a lead status (new, qualified, won, lost)
Lesson
Overview
Append a lesson to the SLOE OS lessons inbox for the consolidator pipeline (dedupe -> skills regen -> guardrail promo...
Memory
Overview
Delete points from a scoped collection by id list or payload filter.
Embed and store a text memory into a scoped collection (gemini-embedding-001@768, stamped with embedder id + timestam...
Search a scoped collection and return the top matches formatted as a ready-to-inject context block.
Semantic search over a scoped memory collection.
Message
Overview
Send a message through any channel
Send an email rendered from markdown to styled HTML.
Meta
Overview
Health check
List the abilities
Run any ability by id
Payment
Overview
Get a payment's current status (tenant-scoped read-back)
Initiate a payment, invoice, or charge.
List payments for the current tenant (tenant-scoped)
Payout
Overview
Disburse a single payment (e.g.
Disburse many payments in one run (e.g.
Get a payout's current status (tenant-scoped read-back).
Get the tenant's payout provider balance / financial-account balance (feeds a float widget).
List payouts for the current tenant (tenant-scoped).
Validate a beneficiary bank account (AVS) on the tenant's payout provider before paying.
Plan
Overview
Create an execution plan from a goal — breaks into phases with dependencies, checks templates and lessons
Execute a specific phase of a plan — runs the ability chain for that phase
Extract lessons from a completed plan — saves template for reuse, feeds learning engine
Verify a phase completed successfully — checks all ability results
QA
Overview
Headless real-browser QA pass against a public URL: loads it in Chromium, returns HTTP status, title, console errors,...
Checklist
Overview
Generate a branded, hosted QA checklist for any Sloe Labs product.
Research
Overview
Search current web sources and capture registered official pages.
Sim
Overview
Generate a playable case study from a GitHub PR and publish it to sims.sloelabs.com.
List the playable case studies live on sims.sloelabs.com (reads the site's sims.json manifest).
Skill
Overview
List the available skill/knowledge packs (auto-generated from lessons) with one-line descriptions.
Load a skill/knowledge pack by name (e.g.
Task
Overview
Create a task for a human or agent
Get one task by id, scoped to your tenant
List tasks for your tenant, optionally filtered by status
Update a task status (pending, in_progress, done, cancelled)
Trust
Overview
Create a time-bounded run and single-use permits for exact actions.
Publish a structured answer with observed, inference, or unverified labels.
Read a run, its block reasons, deadline and action outcomes.
Vertical
Overview
Get a vertical's SURFACE manifest — the runtime half: nouns, screens as gen-UI node types with bindings, capture type...
List the verticals the substrate serves (from each vertical's manifest): id, name, version, whether a SURFACE manifes...
Web
Overview
Answer a question from the open web: searches, reads the top pages, and writes an answer where every claim cites its ...
Do a task on the web with a real browser (hosted, off SLOE's network): the agent looks at the page and clicks, types,...
Workflow
Overview
Trigger an n8n workflow or multi-step process
Workspace
Overview
Doc
Overview
Change a hosted document by block.
Comment on a hosted document, optionally anchored to one block and threaded under a parent comment.
Create a hosted, block-addressed working document.
Freeze a hosted document as a record.
List this tenant's hosted documents, newest first, with how many sections are still pending.
Read a hosted document: every block with its id and rev, plus its share links.
API version
v0.1.0+8bf142be
API Reference
Meta
Health check
View as Markdown
Health check
GET
/health
Returns
Section titled “Returns”
status
string
optional
abilities
number
optional