API reference

Every endpoint below is a deployed Supabase Edge Function. The catalog is regenerated on every build from supabase/functions/*/index.ts — if it’s listed here, it’s live in production. If you ship a new edge function and want it documented, the build script picks it up automatically; if you want a richer summary than the auto-extracted JSDoc, edit the FEATURED map in docs-site/scripts/build-api-catalog.mjs.

Base URL

https://api.sprintloop.ai

All endpoints route through the workspace’s region (us-east-1 or eu-west-1). The base URL is region-agnostic — the workspace handle in the bearer token determines which region serves the request.

Authentication

All endpoints expect a bearer token in the Authorization header:

Authorization: Bearer sl_pat_...

Tokens are minted in Settings → API tokens in the workspace web app. Each token carries a scope set; calls outside scope return 403 SCOPE_DENIED with the missing scope name in the body.

Public endpoints (no token required) are tagged auth: public in the listing below. They include the badge renderer, the auth provider lookup (used by SSO bootstrap), and the federation verify endpoint.

Errors

All endpoints return JSON. Errors carry a code, a human-readable message, and an opaque request_id you can quote when filing a support ticket:

{
  "error": {
    "code": "POLICY_DENIED",
    "message": "Dispatch blocked by policy rule 'no-direct-billing-edits'.",
    "request_id": "req_8K3p..."
  }
}

Common codes: UNAUTHORIZED, SCOPE_DENIED, POLICY_DENIED, LANE_SCOPE_DENIED, RATE_LIMITED, NOT_FOUND, VALIDATION_FAILED, INTERNAL. The full list is in the OpenAPI spec at https://api.sprintloop.ai/openapi.json.

Rate limits

Default rate limits per token:

Endpoint family	Limit
Read (*-list, *-get, audit-*)	120 req/min
Write (agent-run, agent-cancel, *-publish)	30 req/min
Bulk export (audit-export)	6 req/min

Workspace-tier paid plans (Team / Enterprise) get 5× and 20× these limits respectively. Exceed your limit and you get 429 RATE_LIMITED with a Retry-After header.

Featured endpoints

The endpoints below are the ones you’ll reach for first.

POST /functions/v1/agent-run agent-run

Dispatch a new agent lane: pick a harness, hand it a brief, return a run id.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.agent_run

POST /functions/v1/agent-cancel agent-cancel

Stop a running lane and roll back its scope claim.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.agent_cancel

POST /functions/v1/agent-pause agent-pause

Pause a running lane while preserving its scope claim and tool log.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.agent_pause

POST /functions/v1/agent-interrupt agent-interrupt

Send an out-of-band signal (notes, redirection) into an active agent.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.agent_interrupt

POST /functions/v1/agent-tool-invoke agent-tool-invoke

Invoke a registered MCP / tool against the active lane.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.agent_tool_invoke

POST /functions/v1/bmad-query bmad-query

Query the Context Engine (BMAD): five-dimension product / system / style / policy / memory.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.bmad_query

POST /functions/v1/bmad-extract-from-repo bmad-extract-from-repo

Bootstrap the Context Engine from a connected repo.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.bmad_extract_from_repo

POST /functions/v1/api-token-issue api-token-issue

Mint a scoped API token for SSO / SCIM / webhook integrations.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.api_token_issue

POST /functions/v1/api-token-revoke api-token-revoke

Revoke a previously issued API token.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.api_token_revoke

POST /functions/v1/audit-export audit-export

Export a workspace audit log range (signed JSON or NDJSON).

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.audit_export

POST /functions/v1/ci-event-ingest ci-event-ingest

Ingest a CI status event from GitHub / GitLab into a lane.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.ci_event_ingest

POST /functions/v1/changelog-publish changelog-publish

Publish a public changelog entry from a merged PR.

Auth: bearer Region: us-east-1, eu-west-1 SDK: sprintloop.changelog_publish

Full edge-function index

Every public-facing edge function in the deployment, sorted alphabetically. Click into any of them to see its current signature in the source.

Name	Method	Auth	Description
ace-create-pr	POST	bearer	Edge function: ace-create-pr.
ace-mention-dispatch	POST	bearer	Edge function: ace-mention-dispatch.
ace-mention-translator	POST	bearer	Edge function: ace-mention-translator.
adapter-ingest	POST	bearer	Edge function: adapter-ingest.
admin-magic-link	POST	bearer	Issue an admin sign-in link (workspace owner only).
agent-cancel	POST	bearer	Stop a running lane and roll back its scope claim.
agent-interrupt	POST	bearer	Send an out-of-band signal (notes, redirection) into an active agent.
agent-pause	POST	bearer	Pause a running lane while preserving its scope claim and tool log.
agent-run	POST	bearer	Dispatch a new agent lane: pick a harness, hand it a brief, return a run id.
agent-tool-invoke	POST	bearer	Invoke a registered MCP / tool against the active lane.
ai-assistant	POST	bearer	Edge function: ai-assistant.
ai-conflict-resolve	POST	bearer	Edge function: ai-conflict-resolve.
ai-doc-generate	POST	bearer	Edge function: ai-doc-generate.
ai-doc-submit	POST	bearer	Edge function: ai-doc-submit.
ai-memory-embed	POST	bearer	Edge function: ai-memory-embed.
ai-memory-recall	POST	bearer	Edge function: ai-memory-recall.
ai-summarize-meeting	POST	bearer	Edge function: ai-summarize-meeting.
ai-summarize-thread	POST	bearer	Edge function: ai-summarize-thread.
ai-test-generate	POST	service-role	Edge function: ai-test-generate.
annual-contract-create	POST	bearer	Edge function: annual-contract-create.
api-token-issue	POST	bearer	Mint a scoped API token for SSO / SCIM / webhook integrations.
api-token-revoke	POST	bearer	Revoke a previously issued API token.
api-v1	POST	bearer	Top-level v1 router: catch-all REST surface for first-party clients.
apply-workspace-template	POST	bearer	Edge function: apply-workspace-template.
audit-export	POST	bearer	Export a workspace audit log range (signed JSON or NDJSON).
audit-log-export	POST	bearer	Stream the federation audit log for a date range.
auth-providers-for-email	POST	public	List the SSO / OAuth providers configured for an email domain.
badge	POST	public	Render a public badge (status, build, coverage) for a workspace.
billing-create-checkout	POST	bearer	Edge function: billing-create-checkout.
billing-portal	POST	bearer	Edge function: billing-portal.
bitbucket-oauth-callback	POST	bearer	Edge function: bitbucket-oauth-callback.
bitbucket-oauth-start	POST	bearer	Edge function: bitbucket-oauth-start.
bitbucket-sync	POST	bearer	Edge function: bitbucket-sync.
bitbucket-webhook	POST	service-role	Edge function: bitbucket-webhook.
bmad-confidence-decay-tick	POST	bearer	Edge function: bmad-confidence-decay-tick.
bmad-extract-from-repo	POST	bearer	Bootstrap the Context Engine from a connected repo.
bmad-query	POST	bearer	Query the Context Engine (BMAD): five-dimension product / system / style / policy / memory.
canvas-snapshot	POST	bearer	Edge function: canvas-snapshot.
changelog-publish	POST	bearer	Publish a public changelog entry from a merged PR.
ci-dispatch	GET	bearer	Edge function: ci-dispatch.
ci-event-ingest	POST	bearer	Ingest a CI status event from GitHub / GitLab into a lane.
ci-runner-tick	POST	service-role	Edge function: ci-runner-tick.
ci-runner-trigger	POST	service-role	Edge function: ci-runner-trigger.
ci-status	POST	bearer	Edge function: ci-status.
cmdk-refresh	POST	bearer	Edge function: cmdk-refresh.
cmdk-search	POST	bearer	Edge function: cmdk-search.
cockpit-dispatch-builder	POST	bearer	Edge function: cockpit-dispatch-builder.
cockpit-interrupt	POST	bearer	Edge function: cockpit-interrupt.
cockpit-interrupt-tick	POST	service-role	Edge function: cockpit-interrupt-tick.
cockpit-share-token	POST	bearer	Edge function: cockpit-share-token.
collab-cleanup	POST	service-role	Edge function: collab-cleanup.
community-meta	POST	public	Edge function: community-meta.
compliance-snapshot	POST	bearer	Edge function: compliance-snapshot.
conflict-detect-tick	POST	bearer	Edge function: conflict-detect-tick.
cost-alert-tick	POST	service-role	Edge function: cost-alert-tick.
cost-ceiling-tick	POST	service-role	Edge function: cost-ceiling-tick.
cost-routing-resolve	POST	bearer	Edge function: cost-routing-resolve.
cost-summary	POST	bearer	Edge function: cost-summary.
cs-health-snapshot	POST	bearer	Edge function: cs-health-snapshot.
daily-digest-test	POST	bearer	Edge function: daily-digest-test.
daily-digest-tick	POST	bearer	Edge function: daily-digest-tick.
demo-content-refresh-tick	POST	service-role	Edge function: demo-content-refresh-tick.
demo-replay-tick	POST	service-role	Edge function: demo-replay-tick.
demo-workspace-tick	POST	bearer	Edge function: demo-workspace-tick.
deploy-log-stream	POST	bearer	Edge function: deploy-log-stream.
dispatch-status-tick	POST	service-role	Edge function: dispatch-status-tick.
dm-ai-respond	POST	bearer	Edge function: dm-ai-respond.
email-optout	POST	service-role	Edge function: email-optout.
enterprise-rollup-summary	POST	bearer	Edge function: enterprise-rollup-summary.
federation-accept-invite	POST	bearer	Edge function: federation-accept-invite.
federation-cert-create	POST	bearer	Edge function: federation-cert-create.
federation-cert-get	POST	service-role	Edge function: federation-cert-get.
federation-cert-revoke	POST	bearer	Edge function: federation-cert-revoke.
federation-fetch-remote-head	POST	bearer	Edge function: federation-fetch-remote-head.
federation-publish	POST	bearer	Edge function: federation-publish.
federation-publish-head	POST	bearer	Edge function: federation-publish-head.
federation-verify	POST	public	Edge function: federation-verify.
file-signed-url	POST	bearer	Edge function: file-signed-url.
first-run-dispatch	POST	bearer	Edge function: first-run-dispatch.
first-run-merge-pr	POST	bearer	Edge function: first-run-merge-pr.
github-install-callback	POST	bearer	Edge function: github-install-callback.
github-install-url	POST	bearer	Edge function: github-install-url.
github-link-pr	POST	bearer	Edge function: github-link-pr.
github-outbound-worker	POST	bearer	Edge function: github-outbound-worker.
github-post-comment	POST	bearer	Edge function: github-post-comment.
github-pr-thread-spawn	POST	bearer	Edge function: github-pr-thread-spawn.
github-sync-objects	POST	bearer	Edge function: github-sync-objects.
github-sync-projects	POST	bearer	Edge function: github-sync-projects.
github-webhook	POST	service-role	Edge function: github-webhook.
gitlab-oauth-callback	POST	bearer	Edge function: gitlab-oauth-callback.
gitlab-oauth-start	POST	bearer	Edge function: gitlab-oauth-start.
gitlab-sync	POST	bearer	Edge function: gitlab-sync.
gitlab-webhook	POST	service-role	Edge function: gitlab-webhook.
hangout-token	POST	bearer	Edge function: hangout-token.
harness-dispatch	POST	bearer	Edge function: harness-dispatch.
harness-event	POST	service-role	Edge function: harness-event.
harness-heartbeat	POST	bearer	Edge function: harness-heartbeat.
harness-register	POST	bearer	Edge function: harness-register.
harness-revoke	POST	bearer	Edge function: harness-revoke.
health	POST	service-role	Edge function: health.
heartbeat-runner	POST	bearer	Edge function: heartbeat-runner.
import-slack-bundle	POST	bearer	Edge function: import-slack-bundle.
import-start	POST	bearer	Edge function: import-start.
import-status	POST	bearer	Edge function: import-status.
import-teams-bundle	POST	bearer	Edge function: import-teams-bundle.
import-worker	POST	service-role	Edge function: import-worker.
importer-tick	POST	bearer	Edge function: importer-tick.
inbound-email	POST	service-role	Edge function: inbound-email.
investor-snapshot-pdf	POST	bearer	Edge function: investor-snapshot-pdf.
investor-snapshot-tick	POST	bearer	Edge function: investor-snapshot-tick.
jira-oauth-callback	POST	service-role	Edge function: jira-oauth-callback.
jira-oauth-start	POST	bearer	Edge function: jira-oauth-start.
jira-sync	POST	service-role	Edge function: jira-sync.
jira-webhook	POST	service-role	Edge function: jira-webhook.
knowledge-export	POST	bearer	Edge function: knowledge-export.
knowledge-graph-snapshot	POST	bearer	Edge function: knowledge-graph-snapshot.
lane-action-handoff-emit	POST	bearer	Edge function: lane-action-handoff-emit.
lane-diff-tick	POST	bearer	Edge function: lane-diff-tick.
lane-diff-timeline	POST	bearer	Edge function: lane-diff-timeline.
lane-plain-english-summary	POST	bearer	Edge function: lane-plain-english-summary.
lane-replay-gif	POST	bearer	Edge function: lane-replay-gif.
lanes-generate-key	POST	bearer	Edge function: lanes-generate-key.
linear-oauth-callback	POST	service-role	Edge function: linear-oauth-callback.
linear-oauth-start	POST	bearer	Edge function: linear-oauth-start.
linear-sync	POST	service-role	Edge function: linear-sync.
linear-webhook	POST	service-role	Edge function: linear-webhook.
llm-call	POST	service-role	Edge function: llm-call.
mcp-server	GET	bearer	Edge function: mcp-server.
meetings-create-room	POST	bearer	Edge function: meetings-create-room.
meetings-end-recording	POST	bearer	Edge function: meetings-end-recording.
meetings-send-invite-ics	POST	bearer	Edge function: meetings-send-invite-ics.
meetings-token	POST	bearer	Edge function: meetings-token.
mention-indexer	POST	bearer	Edge function: mention-indexer.
migration-assistant	POST	bearer	Edge function: migration-assistant.
mint-demo-jwt	POST	service-role	Edge function: mint-demo-jwt.
mux-create-upload	POST	bearer	Edge function: mux-create-upload.
mux-webhook	POST	service-role	Edge function: mux-webhook.
notification-dispatch	POST	bearer	Edge function: notification-dispatch.
notification-group-tick	POST	bearer	Edge function: notification-group-tick.
notification-prioritize-tick	POST	bearer	Edge function: notification-prioritize-tick.
notification-snooze-tick	POST	bearer	Edge function: notification-snooze-tick.
notifications-digest	POST	bearer	Edge function: notifications-digest.
observability-snapshot	POST	bearer	Edge function: observability-snapshot.
onboarding-email-schedule	POST	bearer	Edge function: onboarding-email-schedule.
onboarding-email-tick	POST	bearer	Edge function: onboarding-email-tick.
outbound-webhook-tick	POST	service-role	Edge function: outbound-webhook-tick.
pack-install	POST	bearer	Edge function: pack-install.
pack-uninstall	POST	bearer	Edge function: pack-uninstall.
palette-cross-workspace-search	GET	bearer	Edge function: palette-cross-workspace-search.
parse-voice-event	POST	bearer	Edge function: parse-voice-event.
permission-grant	POST	bearer	Edge function: permission-grant.
permission-revoke	POST	bearer	Edge function: permission-revoke.
pr-comment-sync	POST	bearer	Edge function: pr-comment-sync.
pr-merge-with-admin-bypass	POST	bearer	Edge function: pr-merge-with-admin-bypass.
pr-review-runner	POST	service-role	Edge function: pr-review-runner.
pr-review-sidebar	POST	bearer	Edge function: pr-review-sidebar.
presence-cleanup	POST	service-role	Edge function: presence-cleanup.
process-notification-outbox	POST	bearer	Edge function: process-notification-outbox.
provenance-audit-tick	POST	service-role	Edge function: provenance-audit-tick.
pulse-digest	POST	bearer	Edge function: pulse-digest.
push-notification-action	POST	bearer	Edge function: push-notification-action.
push-notification-send	POST	bearer	Edge function: push-notification-send.
recurring-pipeline-tick	POST	bearer	Edge function: recurring-pipeline-tick.
region-discovery	POST	service-role	Edge function: region-discovery.
repo-map-extract	POST	bearer	Edge function: repo-map-extract.
review-committee-auto-fire	POST	bearer	Edge function: review-committee-auto-fire.
review-committee-tick	POST	service-role	Edge function: review-committee-tick.
review-committee-trigger	POST	service-role	Edge function: review-committee-trigger.
rls-smoke-test	POST	public	Edge function: rls-smoke-test.
roadmap-vote	POST	bearer	Edge function: roadmap-vote.
sdlc-transition	POST	bearer	Edge function: sdlc-transition.
seed-public-demo-content	POST	bearer	Edge function: seed-public-demo-content.
seed-tick	POST	bearer	Edge function: seed-tick.
seed-workspace	POST	bearer	Edge function: seed-workspace.
semantic-embed-worker	POST	bearer	Edge function: semantic-embed-worker.
semantic-repo-index	POST	bearer	Edge function: semantic-repo-index.
semantic-search	POST	bearer	Edge function: semantic-search.
send-invite	POST	bearer	Edge function: send-invite.
send-push	POST	service-role	Edge function: send-push.
share-link-create	POST	bearer	Edge function: share-link-create.
share-link-resolve	POST	bearer	Edge function: share-link-resolve.
skill-install	POST	bearer	Edge function: skill-install.
skill-publisher-submit	POST	bearer	Edge function: skill-publisher-submit.
smart-resume-summary	POST	bearer	Edge function: smart-resume-summary.
spec-autocomplete	POST	bearer	Edge function: spec-autocomplete.
spec-draft	POST	bearer	Edge function: spec-draft.
spec-next-action-suggest	POST	bearer	Edge function: spec-next-action-suggest.
spec-pipeline-deploy	POST	bearer	Edge function: spec-pipeline-deploy.
spec-pipeline-deploy-tick	POST	bearer	Edge function: spec-pipeline-deploy-tick.
spec-pipeline-start	POST	bearer	Edge function: spec-pipeline-start.
spec-pipeline-tick	POST	bearer	Edge function: spec-pipeline-tick.
sprint-plan	POST	bearer	Edge function: sprint-plan.
sso-callback	POST	service-role	Edge function: sso-callback.
sso-config-update	POST	bearer	Edge function: sso-config-update.
sso-initiate	POST	service-role	Edge function: sso-initiate.
sso-metadata	POST	service-role	Edge function: sso-metadata.
standup-tick	POST	bearer	Edge function: standup-tick.
status-incident-publish	POST	bearer	Edge function: status-incident-publish.
status-incident-write	POST	service-role	Edge function: status-incident-write.
status-probe-tick	POST	bearer	Edge function: status-probe-tick.
status-snapshot	POST	public	Edge function: status-snapshot.
status-subscribe	POST	bearer	Edge function: status-subscribe.
status-subscribe-confirm	POST	service-role	Edge function: status-subscribe-confirm.
stripe-checkout-session	POST	bearer	Edge function: stripe-checkout-session.
stripe-create-checkout	POST	bearer	Edge function: stripe-create-checkout.
stripe-customer-portal	POST	bearer	Edge function: stripe-customer-portal.
stripe-webhook	POST	service-role	Edge function: stripe-webhook.
summary-tick	POST	service-role	Edge function: summary-tick.
support-ticket-create	POST	bearer	Edge function: support-ticket-create.
trace-to-fix	POST	bearer	Edge function: trace-to-fix.
transcribe-audio	POST	bearer	Edge function: transcribe-audio.
trial-onboarding-init	POST	bearer	Edge function: trial-onboarding-init.
trial-seed-workspace	POST	bearer	Edge function: trial-seed-workspace.
unfurl-link	POST	bearer	Edge function: unfurl-link.
verify-download-access	POST	service-role	Edge function: verify-download-access.
verify-lane	POST	service-role	Edge function: verify-lane.
voice-channel-transcribe	POST	bearer	Edge function: voice-channel-transcribe.
voice-command-parse	POST	bearer	Edge function: voice-command-parse.
voice-transcribe	POST	bearer	Edge function: voice-transcribe.
vscode-presence	POST	bearer	Edge function: vscode-presence.
webhook-deliver	POST	service-role	Edge function: webhook-deliver.
webhook-enqueue	POST	bearer	Edge function: webhook-enqueue.
workspace-bootstrap	POST	bearer	Edge function: workspace-bootstrap.
workspace-export	POST	bearer	Edge function: workspace-export.
workspace-export-tick	POST	service-role	Edge function: workspace-export-tick.
workspace-previews	POST	bearer	Edge function: workspace-previews.
workspace-set-region	POST	bearer	Edge function: workspace-set-region.

OpenAPI spec

The full machine-readable schema for every endpoint above is at https://api.sprintloop.ai/openapi.json. It conforms to OpenAPI 3.1, includes JSON Schema for every input and output shape, and is what the SDK generators consume. If you’re integrating SprintLoop into an existing tool that supports OpenAPI directly (Postman, Insomnia, Bruno, your own codegen), point it at that URL.

A pinned snapshot of the spec is shipped with every release tag in the public repo at https://github.com/SamSnead85/SprintLoop-Communicator/tree/main/openapi.