API Reference

Full REST API with 80+ endpoints covering agents, brain documents, connectors, billing, and more. All authenticated endpoints require a Bearer token from Supabase Auth.

Base URL: https://api.keely.aiAuth: Bearer <jwt>Tenant prefix: /api/v1/t/:tenantSlug/

Health & Metrics

Service health checks, system metrics, and alerting — no authentication required.

GET/healthBasic health check

GET/health/detailedDetailed health with system counts

GET/health/metricsAggregated metric summaries

GET/health/metrics/rawRaw metric data points

GET/health/alertsActive alert rules

Authentication

Sync Supabase Auth users and manage profiles.

POST/api/v1/auth/syncSync user from Supabase auth

GET/api/v1/auth/meGet current user profile

PATCH/api/v1/auth/meUpdate user profile

Workspaces

Create and manage multi-tenant workspaces.

GET/api/v1/tenantsList user workspaces

POST/api/v1/tenantsCreate workspace

GET/api/v1/tenants/:slugGet workspace details

PATCH/api/v1/tenants/:slugUpdate workspace

Brain Documents

Company knowledge base — 13 document types that power agent context.

GET/api/v1/t/:slug/brainList all brain documents

GET/api/v1/t/:slug/brain/:docTypeGet brain document

PUT/api/v1/t/:slug/brain/:docTypeUpdate brain document

GET/api/v1/t/:slug/brain/:docType/historyVersion history

Agents

AI agent configuration — enable/disable, override prompts, and manage tool allowlists.

GET/api/v1/t/:slug/agentsList all agents with config

PATCH/api/v1/t/:slug/agents/:keyUpdate agent config

Agent Runs

Execute AI agent workflows and track execution history.

POST/api/v1/t/:slug/runsCreate and execute a run

GET/api/v1/t/:slug/runsList runs with pagination

GET/api/v1/t/:slug/runs/:runIdGet run with artifacts

GET/api/v1/t/:slug/runs/:runId/stepsGet execution trace

POST/api/v1/t/:slug/runs/:runId/cancelCancel a running execution

POST/api/v1/t/:slug/runs/:runId/replayReplay a completed run

GET/api/v1/t/:slug/runs/diagnostics/stuckDiagnose stuck runs

Approvals

Human-in-the-loop approval workflow for agent actions.

GET/api/v1/t/:slug/approvalsList approval requests

GET/api/v1/t/:slug/approvals/:idGet approval detail

POST/api/v1/t/:slug/approvals/:id/decideApprove, reject, or request changes

GET/api/v1/t/:slug/approvals/policies/listList approval policies

PUT/api/v1/t/:slug/approvals/policiesCreate/update approval policy

Connectors

Manage tool integrations — connect GitHub, Stripe, Slack, and more via OAuth or API key.

GET/api/v1/t/:slug/connectorsList connected integrations

POST/api/v1/t/:slug/connectorsConnect a new integration

DELETE/api/v1/t/:slug/connectors/:idDisconnect integration

POST/api/v1/t/:slug/connectors/:id/oauth/startStart OAuth flow

GET/api/v1/t/:slug/connectors/freshnessCheck data freshness

POST/api/v1/t/:slug/connectors/:id/syncTrigger connector sync

Billing & Credits

Subscriptions, credit balances, add-on packs, and Stripe checkout.

GET/api/v1/t/:slug/billingGet subscription + usage summary

GET/api/v1/t/:slug/billing/plansList available plans

POST/api/v1/t/:slug/billing/checkoutCreate Stripe checkout session

POST/api/v1/t/:slug/billing/portalOpen Stripe billing portal

POST/api/v1/t/:slug/billing/addonPurchase credit add-on pack

GET/api/v1/t/:slug/billing/usageDetailed usage breakdown

GET/api/v1/t/:slug/billing/creditsCurrent credit balances

Artifacts

Files and reports generated by agent runs.

GET/api/v1/t/:slug/artifactsList run artifacts

GET/api/v1/t/:slug/artifacts/:idGet artifact detail

Memory

Long-term, episodic, and working memory with vector search.

GET/api/v1/t/:slug/memoryList memory entries

POST/api/v1/t/:slug/memoryCreate memory entry

POST/api/v1/t/:slug/memory/searchVector + keyword search

DELETE/api/v1/t/:slug/memory/:idDelete memory entry

GET/api/v1/t/:slug/memory/statsMemory statistics

GET/api/v1/t/:slug/memory/episodicList episodic events

GET/api/v1/t/:slug/memory/workingGet working memory

PUT/api/v1/t/:slug/memory/workingUpdate working memory

Tasks

Async task submission with SSE progress streaming.

POST/api/v1/t/:slug/tasksSubmit async task

GET/api/v1/t/:slug/tasksList tasks

GET/api/v1/t/:slug/tasks/:idGet task detail

POST/api/v1/t/:slug/tasks/:id/cancelCancel task

GET/api/v1/t/:slug/tasks/:id/streamSSE progress stream

Sandbox

Isolated code execution sessions with Docker/Fargate containers.

GET/api/v1/t/:slug/sandbox/sessionsList sandbox sessions

GET/api/v1/t/:slug/sandbox/sessions/:idGet session detail

GET/api/v1/t/:slug/sandbox/sessions/:id/logsGet execution logs

DELETE/api/v1/t/:slug/sandbox/sessions/:idTerminate session

Strategy Hub

Aggregated strategy data — health scores, risks, milestones, and AI insights.

GET/api/v1/t/:slug/strategyGet full strategy overview

Evidence

Execution evidence — screenshots, code outputs, and file artifacts.

GET/api/v1/t/:slug/evidenceList evidence items

GET/api/v1/t/:slug/evidence/:idGet evidence detail

GET/api/v1/t/:slug/evidence/:id/downloadGet presigned download URL

Team

Invitations, members, and role management.

POST/api/v1/t/:slug/invitationsInvite a team member

GET/api/v1/t/:slug/invitationsList pending invitations

DELETE/api/v1/t/:slug/invitations/:idRevoke invitation

POST/api/v1/invitations/:token/acceptAccept invitation by token

GET/api/v1/t/:slug/membersList workspace members

PATCH/api/v1/t/:slug/members/:idUpdate member role

DELETE/api/v1/t/:slug/members/:idRemove member

POST/api/v1/t/:slug/members/leaveLeave workspace

Activity

Audit log of workspace events.

GET/api/v1/t/:slug/activityGet activity feed

Notifications

Notification preferences and inbox.

GET/api/v1/t/:slug/notifications/preferencesGet preferences

PUT/api/v1/t/:slug/notifications/preferencesUpdate preferences

GET/api/v1/t/:slug/notificationsList notifications

POST/api/v1/t/:slug/notifications/:id/readMark as read

Onboarding

Guided setup flow with business-type-specific brain templates.

POST/api/v1/t/:slug/onboarding/business-typeSet business type

GET/api/v1/t/:slug/onboarding/templatesGet brain templates

GET/api/v1/t/:slug/onboarding/business-typesList business types

Webhooks

External webhook receivers — no authentication (uses provider signatures).

POST/webhooks/stripeStripe webhook receiver

Waitlist

Pre-launch waitlist sign-up — no authentication required.

POST/api/v1/waitlistJoin the waitlist

Interactive API Explorer

Try requests directly in the browser with our Swagger UI interface.

Open Swagger UI →

MCP Server

Connect from Claude Desktop or any MCP client at http://localhost:3003/sse

7 tools · 14 resources · 6 prompts