REST & SSE API
Most apps use the React hooks — but agents and tools can also call Flowstack over HTTP directly. This is the Sage Data Science Agent API (v2.0.0): 337 operations across 50 areas. The contract is the backend's own auto-generated OpenAPI 3.1 document — never hand-written, so it can't drift.
Machine-readable
openapi.json
Full OpenAPI 3.1 spec (288 paths) — point your client or agent here.
Live spec
Source of truth on the backend. Snapshot synced 2026-07-05.
Library · 29
| Method | Path | Summary |
|---|---|---|
GET | /library/code | List Library Code |
DELETE | /library/code/{name} | Delete Library Code |
GET | /library/code/{name} | Get Library Code |
GET | /library/conversations | List Conversations |
DELETE | /library/conversations/{conversation_id} | Delete Conversation |
GET | /library/conversations/{conversation_id} | Get Conversation |
DELETE | /library/conversations/{conversation_id}/star | Unstar Conversation |
POST | /library/conversations/{conversation_id}/star | Star Conversation |
GET | /library/conversations/recent | List Recent Conversations |
GET | /library/datasets | List Library Datasets |
DELETE | /library/datasets/{name} | Delete Library Dataset |
GET | /library/datasets/{name} | Get Library Dataset |
GET | /library/documents | List Library Documents |
DELETE | /library/documents/{name} | Delete Library Document |
GET | /library/documents/{name} | Get Library Document |
GET | /library/models | List Library Models |
DELETE | /library/models/{name} | Delete Library Model |
GET | /library/models/{name} | Get Library Model |
GET | /library/reports | List Library Reports |
DELETE | /library/reports/{name} | Delete Library Report |
GET | /library/reports/{name} | Get Library Report |
GET | /library/search | Search Library |
DELETE | /library/trash | Empty Trash |
GET | /library/trash | List Trash |
DELETE | /library/trash/{item_type}/{name} | Hard Delete Trashed Item |
POST | /library/trash/{item_type}/{name}/restore | Restore Trashed Item |
GET | /library/visualizations | List Library Visualizations |
DELETE | /library/visualizations/{name} | Delete Library Visualization |
GET | /library/visualizations/{name} | Get Library Visualization |
Sites · 27
| Method | Path | Summary |
|---|---|---|
GET | /api/v1/sites | List Sites |
POST | /api/v1/sites | Create Site |
DELETE | /api/v1/sites/{site_id} | Delete Site |
GET | /api/v1/sites/{site_id} | Get Site |
PATCH | /api/v1/sites/{site_id} | Rename Site Endpoint |
GET | /api/v1/sites/{site_id}/agents | List Site Agents |
POST | /api/v1/sites/{site_id}/agents | Create Site Agent |
PATCH | /api/v1/sites/{site_id}/agents/{agent_name} | Update Site Agent |
DELETE | /api/v1/sites/{site_id}/alias | Remove Alias |
POST | /api/v1/sites/{site_id}/alias | Set Alias |
GET | /api/v1/sites/{site_id}/data-plan | Get Site Data Plan |
PUT | /api/v1/sites/{site_id}/data-plan | Set Site Data Plan |
PUT | /api/v1/sites/{site_id}/files/{file_path} | Stage Site File |
POST | /api/v1/sites/{site_id}/import-library | Import Library Item |
POST | /api/v1/sites/{site_id}/promote | Promote Version |
POST | /api/v1/sites/{site_id}/publish | Publish Staged Site Endpoint |
POST | /api/v1/sites/{site_id}/publish-github | Publish To Github |
GET | /api/v1/sites/{site_id}/source | Get Site Source |
DELETE | /api/v1/sites/{site_id}/staged | Clear Staged Files |
GET | /api/v1/sites/{site_id}/staged | List Staged Files |
POST | /api/v1/sites/{site_id}/staged | Stage Site Files |
POST | /api/v1/sites/{site_id}/upload-source | Upload Source |
GET | /api/v1/sites/{site_id}/versions | Get Site Versions |
DELETE | /api/v1/sites/{site_id}/versions/{version} | Delete Version |
POST | /api/v1/sites/daily/generate | Generate Daily Site |
GET | /api/v1/sites/daily/latest | Get Latest Daily Site |
POST | /api/v1/sites/migrate-legacy | Migrate Legacy Sites |
Billing · 19
| Method | Path | Summary |
|---|---|---|
GET | /billing/agent/balance | Get Agent Balance |
POST | /billing/agent/sponsor-gas | Sponsor Agent Gas |
GET | /billing/credits/purchased | Get Purchased Credits |
GET | /billing/credits/status | Get Credit Status |
GET | /billing/infer/balance | Get Infer Balance |
GET | /billing/plans | Get Plans |
POST | /billing/stripe/buy-agent | Create Agent Checkout |
POST | /billing/stripe/checkout | Create Checkout Session |
POST | /billing/stripe/mint-retry | Retry Stripe Mint |
GET | /billing/stripe/mint/health | Stripe Mint Health |
GET | /billing/stripe/mints | List Stripe Mints |
POST | /billing/stripe/subscribe | Create Subscription Checkout |
POST | /billing/stripe/webhook | Stripe Webhook |
POST | /billing/subscription/cancel | Cancel Subscription |
GET | /billing/subscription/status | Get Subscription Status |
GET | /billing/usage | Get Usage |
GET | /billing/usage/monthly | Get Monthly Usage |
GET | /billing/usage/today | Get Today Usage |
GET | /billing/usage/user | Get User Usage |
Admin · 15
| Method | Path | Summary |
|---|---|---|
GET | /admin/keys | Admin List Keys |
POST | /admin/keys/{key_id}/revoke | Admin Revoke Key |
GET | /admin/mongo-capacity | Mongo Capacity |
POST | /admin/query | Process Query |
GET | /admin/requests | Admin List Requests |
POST | /admin/requests/{request_id}/approve | Admin Approve Request |
POST | /admin/requests/{request_id}/deny | Admin Deny Request |
POST | /admin/reset-context | Reset Conversation Context |
GET | /admin/roles | Admin List Roles |
GET | /admin/session | Get Session Info |
DELETE | /admin/sessions/{session_id}/clear | Clear Session Conversation Endpoint |
POST | /admin/subscriptions/grant | Grant Subscription |
GET | /admin/users | Admin List Users |
GET | /admin/users/{user_id} | Admin Get User |
POST | /admin/visualize | Create Visualization |
Provider Credentials · 15
| Method | Path | Summary |
|---|---|---|
GET | /api/v1/user/provider-credentials | List Provider Credentials |
POST | /api/v1/user/provider-credentials | Create Provider Credential |
DELETE | /api/v1/user/provider-credentials/{credential_id} | Delete Provider Credential |
GET | /api/v1/user/provider-credentials/{credential_id} | Get Provider Credential |
PUT | /api/v1/user/provider-credentials/{credential_id} | Update Provider Credential |
POST | /api/v1/user/provider-credentials/{credential_id}/set-default | Set Default Provider Credential |
GET | /api/v1/user/provider-credentials/code-interpreter | Get Code Interpreter Credential |
POST | /api/v1/user/provider-credentials/code-interpreter | Create Code Interpreter Credential |
GET | /api/v1/user/provider-credentials/components | Get All Component Credentials |
GET | /api/v1/user/provider-credentials/default | Get Default Provider Credential |
GET | /api/v1/user/provider-credentials/purpose/{purpose} | Get Credential For Purpose |
POST | /api/v1/user/provider-credentials/purpose/{purpose} | Create Credential For Purpose |
GET | /api/v1/user/provider-credentials/purposes | Get Supported Purposes |
GET | /api/v1/user/provider-credentials/routing-preference | Get Routing Preference |
PUT | /api/v1/user/provider-credentials/routing-preference | Set Routing Preference |
Workspaces · 14
| Method | Path | Summary |
|---|---|---|
GET | /api/v1/workspaces | List Workspaces V1 |
DELETE | /api/v1/workspaces/{workspace_id}/pii-allowlist | Remove Pii Allowlist Term |
GET | /api/v1/workspaces/{workspace_id}/pii-allowlist | Get Pii Allowlist |
POST | /api/v1/workspaces/{workspace_id}/pii-allowlist | Add Pii Allowlist Term |
GET | /api/v1/workspaces/{workspace_id}/pii-settings | Get Pii Settings |
PATCH | /api/v1/workspaces/{workspace_id}/pii-settings | Update Pii Settings |
GET | /tenants/{tenant_id}/workspaces | List Tenant Workspaces |
POST | /tenants/{tenant_id}/workspaces | Create Workspace |
DELETE | /tenants/{tenant_id}/workspaces/{workspace_id} | Delete Workspace |
GET | /tenants/{tenant_id}/workspaces/{workspace_id} | Get Workspace Details |
PATCH | /tenants/{tenant_id}/workspaces/{workspace_id} | Update Workspace |
GET | /tenants/{tenant_id}/workspaces/{workspace_id}/usage | Get Workspace Usage |
POST | /workspaces/{workspace_id}/query | Query Workspace |
GET | /workspaces/{workspace_id}/sessions | List Workspace Sessions |
Authentication · 12
| Method | Path | Summary |
|---|---|---|
POST | /auth/auth/token/refresh | Refresh Token |
POST | /auth/google/login | Google Login |
POST | /auth/login | Login User |
POST | /auth/register | Register User |
POST | /auth/resend-verification | Resend Verification |
POST | /auth/user/login | User Login |
GET | /auth/user/me | User Me |
POST | /auth/user/register | User Register |
GET | /auth/user/status | User Registration Status |
POST | /auth/user/verify | User Verify |
GET | /auth/user/verify/{token} | User Verify Link |
POST | /auth/verify | Verify Email |
Automations · 11
| Method | Path | Summary |
|---|---|---|
GET | /automations | List Automations |
POST | /automations | Create Automation |
GET | /automations/_meta/limits | Get Automation Limits |
DELETE | /automations/{automation_id} | Delete Automation |
GET | /automations/{automation_id} | Get Automation |
PUT | /automations/{automation_id} | Update Automation |
POST | /automations/{automation_id}/pause | Pause Automation |
POST | /automations/{automation_id}/resume | Resume Automation |
POST | /automations/{automation_id}/run | Run Automation Now |
GET | /automations/{automation_id}/runs | List Automation Runs |
GET | /automations/{automation_id}/runs/{run_id} | Get Automation Run |
Files · 10
| Method | Path | Summary |
|---|---|---|
GET | /api/v1/user/artifacts | List User Artifacts |
GET | /api/v1/user/documents | List User Documents |
DELETE | /data/cleanup/{session_id} | Cleanup Session Data |
GET | /data/download/{session_id}/{file_type}/{filename} | Download File |
GET | /data/files/{session_id} | List Session Files |
POST | /data/sync/{session_id} | Sync Session To Local |
POST | /data/upload/{session_id} | Upload File To Session |
POST | /load-from-url | Load Dataset From Url |
POST | /upload | Upload File |
POST | /upload-document | Upload Document |
Agents · 9
| Method | Path | Summary |
|---|---|---|
GET | /agents/registry | List Agent Registry |
POST | /agents/route | Route Agent |
GET | /agents/spend | Agent Spend |
GET | /library/agents | List Agents |
DELETE | /library/agents/{name} | Delete Agent |
GET | /library/agents/{name} | Get Agent |
POST | /library/agents/{name}/invoke | Invoke Agent |
GET | /library/agents/{name}/runs | List Agent Runs |
POST | /library/agents/upload | Upload Agent |
Social OAuth · 9
| Method | Path | Summary |
|---|---|---|
GET | /auth/reddit/callback | Reddit Callback |
GET | /auth/reddit/start | Reddit Start |
GET | /auth/reddit/status | Reddit Status |
GET | /auth/strava/callback | Strava Callback |
GET | /auth/strava/start | Strava Start |
GET | /auth/strava/status | Strava Status |
GET | /auth/twitter/callback | Twitter Callback |
GET | /auth/twitter/start | Twitter Start |
GET | /auth/twitter/status | Twitter Status |
Streaming · 9
| Method | Path | Summary |
|---|---|---|
GET | /agents | List Agents |
POST | /prewarm | Prewarm Swarm Endpoint |
POST | /stream | Stream Query |
POST | /stream-simple | Stream Query Simple |
POST | /stream/interrupt | Interrupt Stream |
POST | /stream/pii-preview | Pii Preview |
POST | /stream/resume | Resume From Interrupt |
GET | /stream/status | Agent Status |
GET | /swarm-cache-stats | Get Swarm Cache Stats |
Conversations · 8
| Method | Path | Summary |
|---|---|---|
GET | /conversations | Get Conversation History |
DELETE | /conversations/{session_id} | Soft Delete Conversation |
GET | /conversations/{session_id}/messages | Get Conversation Messages |
POST | /conversations/{session_id}/title | Rename Conversation |
POST | /conversations/backfill-titles | Backfill Auto Titles |
GET | /conversations/context | Get Conversation Context |
GET | /conversations/scope | List Conversations For Scope |
POST | /conversations/search | Search Conversations |
Digest · 8
| Method | Path | Summary |
|---|---|---|
GET | /api/v1/digest/feed-catalog | Get Feed Catalog |
POST | /api/v1/digest/generate | Generate Digest Endpoint |
GET | /api/v1/digest/interests | Get Interests |
POST | /api/v1/digest/interests | Update Interests |
GET | /api/v1/digest/rss-feeds | List Rss Feeds |
POST | /api/v1/digest/rss-feeds | Add Rss Feed |
DELETE | /api/v1/digest/rss-feeds/{feed_id} | Remove Rss Feed |
GET | /api/v1/digest/sources | List Digest Sources |
MCP · 8
| Method | Path | Summary |
|---|---|---|
GET | /mcp | Streamable Http Get |
POST | /mcp | Streamable Http Endpoint |
GET | /mcp/ | Streamable Http Get |
POST | /mcp/ | Streamable Http Endpoint |
POST | /mcp/messages | Messages Endpoint |
GET | /mcp/oauth/authorization-server | Oauth Metadata |
POST | /mcp/oauth/token | Oauth Token |
GET | /mcp/sse | Sse Endpoint |
Admin - Providers · 7
| Method | Path | Summary |
|---|---|---|
GET | /admin/provider-credentials | List Admin Provider Credentials |
POST | /admin/provider-credentials | Create Admin Provider Credential |
DELETE | /admin/provider-credentials/{credential_id} | Delete Admin Provider Credential |
GET | /admin/provider-credentials/am-i-admin | Am I Tenant Admin |
GET | /admin/provider-credentials/existing | List Existing Credentials |
GET | /admin/provider-credentials/live-model-map | Get Live Model Map |
POST | /admin/provider-credentials/promote | Promote Existing Credential |
Data Sources · 7
| Method | Path | Summary |
|---|---|---|
GET | /data-sources | List Data Sources |
POST | /data-sources | Create Data Source |
DELETE | /data-sources/{source_id} | Delete Data Source |
GET | /data-sources/{source_id} | Get Data Source |
PUT | /data-sources/{source_id} | Update Data Source |
POST | /data-sources/{source_id}/test | Test Data Source Connection |
POST | /data-sources/test-connection | Test New Connection |
GitHub · 7
| Method | Path | Summary |
|---|---|---|
POST | /api/v1/github/import | Import Repo |
GET | /api/v1/github/repos | List Repos |
POST | /api/v1/github/webhook | Github Webhook |
GET | /auth/github/callback | Github Callback |
POST | /auth/github/disconnect | Github Disconnect |
GET | /auth/github/start | Github Start |
GET | /auth/github/status | Github Status |
App Billing · 6
| Method | Path | Summary |
|---|---|---|
POST | /billing/app-access/checkout | Create App Checkout |
GET | /billing/app-access/monetization/{site_id} | Get Site Monetization |
POST | /billing/app-access/monetization/{site_id} | Set Site Monetization Config |
GET | /billing/app-access/status | Get App Access Status |
POST | /billing/app-access/subscribe | Create App Subscription Checkout |
POST | /billing/app-access/subscription/cancel | Cancel App Subscription |
Health Data · 6
| Method | Path | Summary |
|---|---|---|
GET | /api/v1/health-data/analysis/{analysis_id} | Get Analysis Result |
GET | /api/v1/health-data/follow-up | Follow Up Query |
POST | /api/v1/health-data/ingest | Ingest Health Data |
POST | /api/v1/health-data/register-phone | Register Phone |
GET | /api/v1/health-data/report-preview | Preview Health Report |
POST | /api/v1/health-data/test-mms | Test Mms Delivery |
Registrar · 6
| Method | Path | Summary |
|---|---|---|
POST | /api/v1/registrar/{domain}/toggle-renewal | Toggle Renewal |
POST | /api/v1/registrar/{domain}/transfer-out | Transfer Out |
GET | /api/v1/registrar/check | Check Availability |
GET | /api/v1/registrar/my-domains | List My Domains |
GET | /api/v1/registrar/prices | Get Prices |
POST | /api/v1/registrar/purchase | Purchase Domain |
User Data · 6
| Method | Path | Summary |
|---|---|---|
GET | /api/v1/user/collections | List User Collections |
DELETE | /api/v1/user/collections/{collection} | Delete User Collection |
GET | /api/v1/user/collections/{collection}/documents | Get Collection Documents |
POST | /api/v1/user/collections/{collection}/export | Export User Collection |
GET | /api/v1/user/collections/{collection}/schema | Get Collection Schema |
GET | /api/v1/user/data-overview | Get Data Overview |
Wallet Auth · 6
| Method | Path | Summary |
|---|---|---|
POST | /auth/guest | Issue Guest Token |
POST | /auth/privy-refresh | Privy Refresh |
POST | /auth/privy-verify | Privy Verify |
POST | /auth/wallet/link | Link Wallet |
GET | /auth/wallet/nonce | Get Siwe Nonce |
POST | /auth/wallet/verify | Siwe Verify |
App Messaging · 5
| Method | Path | Summary |
|---|---|---|
GET | /apps/{app_scope}/messages | Get Messages |
POST | /apps/{app_scope}/messages | Send Message |
POST | /apps/{app_scope}/messages/{message_id}/read | Mark Message Read |
GET | /apps/{app_scope}/threads | Get Threads |
POST | /apps/{app_scope}/threads/{pair_key}/consent | Open Thread |
Custom Domains · 5
| Method | Path | Summary |
|---|---|---|
GET | /api/v1/apps/{site_id}/domains | List Domains |
POST | /api/v1/apps/{site_id}/domains | Connect Domain |
DELETE | /api/v1/apps/{site_id}/domains/{domain} | Disconnect Domain |
POST | /api/v1/apps/{site_id}/domains/{domain}/activate | Activate Domain |
GET | /api/v1/apps/{site_id}/domains/{domain}/status | Domain Status |
Google OAuth · 5
| Method | Path | Summary |
|---|---|---|
GET | /auth/google/callback | Oauth Callback |
POST | /auth/google/revoke | Revoke Oauth |
GET | /auth/google/start | Start Oauth Flow |
GET | /auth/google/status | Get Oauth Status |
GET | /auth/google/test | Test Oauth Connection |
Integrations · 5
| Method | Path | Summary |
|---|---|---|
GET | /integrations | List Integrations |
POST | /integrations | Create Integration |
DELETE | /integrations/{integration_id} | Delete Integration |
GET | /integrations/{integration_id} | Get Integration |
PUT | /integrations/{integration_id} | Update Integration |
Scripts · 5
| Method | Path | Summary |
|---|---|---|
GET | /scripts | List Scripts |
GET | /scripts/{script_name} | Get Script |
GET | /scripts/{script_name}/download | Download Script |
GET | /scripts/detailed | List Scripts Detailed |
GET | /tenants/{tenant_id}/scripts | List Tenant Scripts |
Sessions · 5
| Method | Path | Summary |
|---|---|---|
PUT | /session/{session_id}/activity | Heartbeat |
GET | /session/{session_id}/lock-status | Get Lock Status |
POST | /session/claim | Claim Session |
GET | /session/current | Get Current Session |
POST | /session/release | Release Session |
API Keys · 4
| Method | Path | Summary |
|---|---|---|
GET | /tenants/{tenant_id}/api-keys | List Tenant Api Keys |
POST | /tenants/{tenant_id}/api-keys | Create Tenant Api Key |
DELETE | /tenants/{tenant_id}/api-keys/{key_id} | Revoke Tenant Api Key |
GET | /tenants/{tenant_id}/api-keys/stats | Get Tenant Api Key Stats |
Builder Payouts · 4
| Method | Path | Summary |
|---|---|---|
GET | /billing/builder/earnings | Builder Earnings |
POST | /billing/builder/payout | Builder Payout |
POST | /billing/connect/onboard | Connect Onboard |
GET | /billing/connect/status | Connect Status |
Collections · 4
| Method | Path | Summary |
|---|---|---|
POST | /collections/delete | Delete Documents |
POST | /collections/insert | Insert Documents |
GET | /collections/query | Query Collection |
POST | /collections/update | Update Documents |
Datasets · 4
| Method | Path | Summary |
|---|---|---|
GET | /datasets | List Datasets |
GET | /datasets/{dataset_name}/download | Download Dataset |
GET | /session/{session_id}/visualizations | Get Session Visualizations |
GET | /visualizations | List Visualizations |
Identity · 4
| Method | Path | Summary |
|---|---|---|
POST | /auth/identity/link | Link Identity |
GET | /auth/identity/links | List My Links |
DELETE | /auth/identity/links/{auth_method_user_id} | Unlink Identity |
GET | /auth/identity/orphaned-data | Get Orphaned Data |
Observability · 4
| Method | Path | Summary |
|---|---|---|
GET | /observability/billing-metrics | Get Billing Metrics |
GET | /observability/session/{session_id} | Get Session Telemetry |
GET | /observability/tools-analytics | Get Tools Analytics |
GET | /observability/workspace/{workspace_id} | Get Workspace Telemetry |
Tools · 4
| Method | Path | Summary |
|---|---|---|
GET | /tools | List Tools |
POST | /tools/execute | Execute Tool |
GET | /tools/schemas | Get Tool Schemas |
GET | /tools/summary | Get Tools Summary |
Models · 3
| Method | Path | Summary |
|---|---|---|
GET | /models | List Models |
GET | /models/{model_name} | Get Model |
GET | /models/{model_name}/download | Download Model |
Reports · 3
| Method | Path | Summary |
|---|---|---|
GET | /reports | List Reports |
GET | /reports/{report_id} | Get Report |
GET | /reports/{report_id}/download | Download Report |
User Preferences · 3
| Method | Path | Summary |
|---|---|---|
GET | /user/model-preference | Get Model Preference |
PUT | /user/model-preference | Set Model Preference |
GET | /user/model-preference/options | List Model Preference Options |
Visualizations · 3
| Method | Path | Summary |
|---|---|---|
GET | /tenants/{tenant_id}/datasets | List Tenant Datasets |
GET | /tenants/{tenant_id}/visualizations | List Tenant Visualizations |
GET | /tenants/{tenant_id}/workspaces/{workspace_id}/visualizations | List Workspace Visualizations |
Health · 2
| Method | Path | Summary |
|---|---|---|
GET | /health | Health Check |
GET | /health/detailed | Detailed Health Check |
Mono-Sage · 2
| Method | Path | Summary |
|---|---|---|
GET | /mono/health | Mono Health |
POST | /mono/stream | Mono Stream |
Public Collections · 2
| Method | Path | Summary |
|---|---|---|
GET | /public/collections/{collection}/documents | Public Query |
POST | /public/collections/{collection}/insert | Public Insert |
Capabilities · 1
| Method | Path | Summary |
|---|---|---|
GET | /capabilities | Get Capabilities |
Other · 1
| Method | Path | Summary |
|---|---|---|
GET | / | Root |
Public Analytics · 1
| Method | Path | Summary |
|---|---|---|
GET | /analytics/public/agents | Public Agents |
Recipes · 1
| Method | Path | Summary |
|---|---|---|
GET | /recipes.json | Get Recipes |
Short URLs · 1
| Method | Path | Summary |
|---|---|---|
GET | /s/{short_id} | Short Url Redirect |
Tool Invoke · 1
| Method | Path | Summary |
|---|---|---|
POST | /tool/invoke | Invoke Tool |
Webhooks · 1
| Method | Path | Summary |
|---|---|---|
POST | /webhooks/twilio/inbound | Twilio Inbound Sms |