Pricing and Models30 min read

Valstorm API Route Catalog & Pricing Tiers

Explore Valstorm's catalog of 360 backend API routes and a detailed breakdown of operational pricing tiers for AI compute, telephony, workflows, and data.

This document provides a comprehensive, categorized inventory of all 360 backend API routes in the Valstorm FastAPI platform, detailing their HTTP methods, handler functions, and operational pricing tiers.


🎯 API Pricing Tier Structure

TierPrice per RequestScope & Rationale
AI & Intelligent Compute$0.0100 / call (1.00¢)High-compute LLM orchestration, VFS AI Hybrid Search & RAG synthesis (/search, /search/stream), Support Ask AI (/support/ask), embedding generation, streaming chat, and voice AI pipelines.
Automation & Workflow Engine$0.0100 / call (1.00¢)Multi-step graph evaluations, Celery task dispatches, webhook triggers, and event loops.
Document Generation & Templates$0.0100 / call (1.00¢)Headless PDF rendering, template parsing, invoice/contract generation, and document export.
Telephony & Communications (Twilio)$0.0030 / call (0.30¢)Softphone call dispatching, IVR event loops, webhook relays, and SMS message routing.
Standard Operations, Mutations & Public VFS$0.0010 / call (0.10¢)Record CUD mutations, batch updates, file uploads/writes, schema alterations, unauthenticated public VFS / website fetching (/v1/vfs/public/*, /v1/public/*), and external integrations.
Data Fetching, Queries, Auth & System Health$0.0000 / call (Free)Fetching data is free: Authenticated SQL queries (/query), MongoDB queries (/query/mongo), GraphQL (/graphql), schema inspection, authenticated internal VFS document & vault fetching (/files/{id}, /vfs/file/{id}, /vfs/vault/{id}, /vfs/tree), all authentication & OAuth flows, and health checks.

📊 Category Summary (360 Total Routes)

Category / SubsystemRoute CountDefault Price Tier
System Health & Documentation10$0.0000 (Free)
AI & Intelligent Services26$0.0100
Authentication, OAuth & User Management30$0.0000 (Free)
Public Endpoints2$0.0010 (AI Question $0.0100)
Notifications, Alerts & System Handlers61$0.0010 (GraphQL & Auth Free, AI $0.0100)
Automation & Workflow Engine7$0.0100
Document Generation & Template Engine6$0.0100
Telephony & Communications (Twilio)73$0.0030
Core Data Engine, CUD & SQL Queries15Free ($0.0000) for Queries / $0.0010 for Mutations
Virtual File System & Storage (VFS/S3)37Free ($0.0000) for Internal Reads / $0.0010 for Writes & Public VFS
Third-Party Email, Calendar & Messaging Integrations68$0.0010
Custom App Builder, Portals & Marketing13$0.0010
Billing & Stripe Payments12$0.0010

System Health & Documentation (10 Routes)

MethodEndpoint PathPriceHandler / Description
GET/docs$0.0000 (Free)Redoc Html
GET/docs/oauth2-redirect$0.0000 (Free)Swagger Ui Redirect
GET/swagger$0.0000 (Free)Swagger Ui Html
GET/v1/openapi.json$0.0000 (Free)Openapi
GET/v1/status$0.0000 (Free)Health Check Endpoint
POST/v1/status/availability$0.0000 (Free)Available Route
GET/v1/status/me$0.0000 (Free)Me
POST/v1/status/user/status$0.0000 (Free)User Status
GET/v1/status/user/{user_id}$0.0000 (Free)Get A User
GET/v1/status/users$0.0000 (Free)Get All Users

AI & Intelligent Services (26 Routes)

MethodEndpoint PathPriceHandler / Description
POST/v1/ai/agent/chat$0.0100Chat With Data Route
POST/v1/ai/agent/confirm$0.0100Confirm Agent Tool Route
POST/v1/ai/agent/runtime/run$0.0100Proxies run creation directly to the Cloud Agent Runtime (Port 8660 / VALSTORM_AGENT_CLOUD_RUNTIME_URL).
GET/v1/ai/agent/runtime/run/{run_id}/events$0.0100Proxies real-time Server-Sent Events (SSE) from the Cloud Agent Runtime.
GET/v1/ai/agent/runtime/status$0.0100Returns live connectivity and health status for local desktop (8650) and cloud runtime (8660).
GET/v1/ai/agent/{agent_id}/tools$0.0100Returns the list of tools configured for a specific agent.
GET/v1/ai/assembly-token$0.0100Mints a short-lived temporary token for AssemblyAI realtime WebSocket connections.
POST/v1/ai/audio/transcribe$0.0100Transcribes audio using Gemini.
POST/v1/ai/chat/completions$0.0100OpenAI-compatible chat completions route powered by Gemini under the hood.
POST/v1/ai/chat/{chat_id}/desktop-sync$0.0100Desktop Sync Route
DELETE/v1/ai/memory/fact$0.0100Removes declarative facts matching old_text substring.
POST/v1/ai/memory/fact$0.0100Adds a declarative fact to the user's working memory in tenant MongoDB.
POST/v1/ai/memory/pin-asset$0.0100Pins or updates a high-affinity asset for the user.
GET/v1/ai/memory/working-context$0.0100Returns the pre-computed working memory card and Turn 0 envelope for the user.
POST/v1/ai/onboarding/complete-step$0.0100Executes real workspace mutations for the interactive Chief of Staff Onboarding flow.
POST/v1/ai/project/orchestrate$0.0100Orchestrate Project Route
POST/v1/ai/project/{project_id}/optimize$0.0100Optimize Project Schedule Route
GET/v1/ai/project/{project_id}/stage-review$0.0100Get Project Stage Review Route
POST/v1/ai/prompt$0.0100OpenAI-compatible chat completions route powered by Gemini under the hood.
GET/v1/ai/speech/azure/token$0.0100Issues a short-lived (10-minute) Azure Cognitive Services Speech authorization token.
GET/v1/ai/speech/credentials$0.0100Issues short-lived speech credentials for the active STT provider (Deepgram / Azure).
GET/v1/ai/speech/deepgram/token$0.0100Issues a short-lived (10-minute) Deepgram scoped API key.
POST/v1/ai/task/orchestrate$0.0100Centralized server-side task orchestration endpoint.
POST/v1/ai/task/{task_id}/orchestrate$0.0100Convenience route allowing task_id in path.
GET/v1/ai/test-model$0.0100Test Model
GET/v1/ai/tools$0.0100Returns the list of all available platform tools that the AI can use.

Authentication, OAuth & User Management (30 Routes)

MethodEndpoint PathPriceHandler / Description
POST/v1/auth/approve-2fa$0.0000 (Free)Approve 2Fa Route
POST/v1/auth/cli-browser-token$0.0000 (Free)Generate a short-lived, single-use token to exchange for a browser session.
POST/v1/auth/consume-cli-token$0.0000 (Free)Consume a CLI exchange token and return standard web session tokens.
GET/v1/auth/load$0.0000 (Free)Initial Load
POST/v1/auth/login-as-user$0.0000 (Free)Login As
GET/v1/auth/login-status$0.0000 (Free)Login Status Route
POST/v1/auth/logout$0.0000 (Free)Logout
GET/v1/auth/organizations$0.0000 (Free)Get User Organizations Api
GET/v1/auth/pats$0.0000 (Free)List Pats
POST/v1/auth/pats$0.0000 (Free)Create Pat
DELETE/v1/auth/pats/{pat_id}$0.0000 (Free)Revoke Pat
POST/v1/auth/portal/forgot-password$0.0000 (Free)Portal Forgot Password
POST/v1/auth/portal/login$0.0000 (Free)Portal Login
POST/v1/auth/portal/request-magic-code$0.0000 (Free)Portal Request Magic Code
GET/v1/auth/portal/reset-callback$0.0000 (Free)Portal Reset Callback
POST/v1/auth/portal/reset-password$0.0000 (Free)Portal Reset Password
POST/v1/auth/portal/verify-2fa$0.0000 (Free)Portal Verify 2Fa
POST/v1/auth/reject-2fa$0.0000 (Free)Reject 2Fa Route
POST/v1/auth/request-magic-code$0.0000 (Free)Request Magic Code Route
POST/v1/auth/switch$0.0000 (Free)Switch Org
POST/v1/oauth2/approve-2fa$0.0000 (Free)Approve 2Fa Route
GET/v1/oauth2/authorize$0.0000 (Free)Authorize Get Route
POST/v1/oauth2/authorize$0.0000 (Free)Authorize Route
POST/v1/oauth2/code$0.0000 (Free)Code Route
POST/v1/oauth2/login$0.0000 (Free)Login Route
GET/v1/oauth2/login-status$0.0000 (Free)Login Status Route
POST/v1/oauth2/refresh$0.0000 (Free)Refresh Token Route
POST/v1/oauth2/reject-2fa$0.0000 (Free)Reject 2Fa Route
POST/v1/oauth2/token$0.0000 (Free)Token Route
POST/v1/oauth2/verify-2fa$0.0000 (Free)Verify 2Fa Route

Public Endpoints (2 Routes)

MethodEndpoint PathPriceHandler / Description
GET/v1/public/apps$0.0010Get Apps
POST/v1/public/question$0.0100Question Route

Notifications, Alerts & System Handlers (61 Routes)

MethodEndpoint PathPriceHandler / Description
POST/v1/alerts/email$0.0010Send Email
POST/v1/csv-to-json$0.0010Convert uploaded CSV file to JSON format.
GET/v1/decrypt/{api_name}$0.0010Decrypt Record Route
GET/v1/device$0.0010Get Devices
PATCH/v1/device$0.0010Update Device
POST/v1/device$0.0010Create Device
DELETE/v1/device/{device_id}$0.0010Delete Device
POST/v1/forgot-password$0.0000 (Free)Initiates the password reset flow.
POST/v1/formula/evaluate$0.0010Evaluate Formula
GET/v1/graphql$0.0000 (Free)Graphql Gui
POST/v1/graphql$0.0000 (Free)Graphql Endpoint
POST/v1/marketing/campaign/bulk-send$0.0010Endpoint to send bulk outreach.
POST/v1/marketing/campaign/csv-to-json$0.0010Convert uploaded CSV file to JSON format.
POST/v1/marketing/campaign/import-contacts$0.0010Import contacts into a campaign based on a SQL query.
POST/v1/merge$0.0010Merge Records Api
POST/v1/notifications$0.0010Summary: Send a notification to a user.
POST/v1/notifications/dynamic$0.0010Summary: Send a dynamic notification without needing a predefined setting.
POST/v1/notifications/mark-read$0.0010Mark Notification As Read
POST/v1/notifications/mark-read-by-key-value$0.0010Mark Notification Data As Read
POST/v1/notifications/send$0.0010Send Notification
POST/v1/notifications/set-token$0.0010Set Notification Token
POST/v1/object/export$0.0010Export Records Api
POST/v1/object/hydrate-batch$0.0010Hydrate Batch Api
DELETE/v1/object/{api_name}$0.0010Delete Records Api
PATCH/v1/object/{api_name}$0.0010Update Records Api
POST/v1/object/{api_name}$0.0010Create Records Api
POST/v1/object/{api_name}/import$0.0010Import Records Csv
POST/v1/object/{api_name}/import/vcard$0.0010Import Records Vcard
DELETE/v1/object/{api_name}/{record_id}$0.0010Delete Record Api
DELETE/v1/organization/{organization_id}$0.0010Delete Organization Route
POST/v1/register$0.0000 (Free)Register User
POST/v1/register/activate$0.0000 (Free)Activate User
POST/v1/register/activate-invite$0.0000 (Free)Activate Invite
GET/v1/register/portal/accept-invite$0.0000 (Free)Handles accept-invite link clicks from email invitations and redirects guest to password setup.
POST/v1/register/portal/activate$0.0000 (Free)Activates an invited portal user.
POST/v1/register/portal/invite$0.0000 (Free)Legacy individual guest invitation route relocated from registration.
POST/v1/register/portal/setup-password$0.0000 (Free)Sets up portal password for an invited user.
POST/v1/register/resend-otp$0.0000 (Free)Resend Otp
POST/v1/register/user$0.0000 (Free)Registers a user to an organization.
POST/v1/register/verify-otp$0.0000 (Free)Verify Otp
GET/v1/routes$0.0010List Routers
GET/v1/salesforce/auth/callback$0.0010Handles the callback from Salesforce.
GET/v1/salesforce/auth/login$0.0010Redirects the user to Salesforce's login page.
GET/v1/sandbox$0.0010Lists all sandbox environments associated with the active production organization.
POST/v1/sandbox$0.0010Creates a new isolated sandbox environment by copying production configurations, schemas, and users.
DELETE/v1/sandbox/{name}$0.0010Permanently deletes a sandbox environment and all its isolated databases and configurations.
POST/v1/sandbox/{name}/refresh$0.0010Wipes and refreshes an existing sandbox environment, restoring it to match the production state.
POST/v1/sandbox/{name}/users$0.0010Adds one or more users to a sandbox environment.
DELETE/v1/sandbox/{name}/users/{userIds}$0.0010Removes one or more users from a sandbox environment.
GET/v1/sandbox/{sandboxId}/users$0.0010Lists all users available in the parent production organization for this sandbox ID.
POST/v1/sandbox/{source}/app/{app_name}/push/{target}$0.0010Extracts an app's configuration from the source and deploys it to the target environment.
POST/v1/search$0.0100Unified Hybrid Search Non-Streaming REST Endpoint
POST/v1/search/stream$0.0100Unified Hybrid Search & RAG Streaming Route (SSE)
POST/v1/support/ask$0.0100Dedicated AI Support Endpoint:
POST/v1/support/telemetry$0.0010Tracks support deflection vs escalation metrics.
POST/v1/support/tickets$0.0010Publicly accessible support ticket endpoint leveraging PlatformContext.
POST/v1/tasks/reconcile-twilio-convos$0.0010Fix Convos Task
POST/v1/tasks/system-alert$0.0010System Alert
GET/v1/ws/create$0.0010Create Websocket
POST/v1/ws/desktop/execute$0.0010Desktop Execute
POST/v1/ws/send_message$0.0010Send Message Route

Automation & Workflow Engine (7 Routes)

MethodEndpoint PathPriceHandler / Description
POST/v1/automation$0.0100Runs a new automation from a raw payload (JSON, form-data, etc.).
POST/v1/automation/function$0.0100Run Function Automation Route
POST/v1/automation/function/validate$0.0100Validate Function Route
POST/v1/automation/resume/{run_id}$0.0100Automatically resumes a workflow from where it last stopped.
POST/v1/automation/run-partial/{run_id}$0.0100Run Partial Automation Route
POST/v1/automation/{automation_id}$0.0100Runs a saved automation by its ID, using the incoming request body as inputs.
POST/v1/public/automation/{org_id}/{automation_id}$0.0100Run Public Automation Route

Document Generation & Template Engine (6 Routes)

MethodEndpoint PathPriceHandler / Description
POST/v1/document/generate-contract$0.0100Generates a new contract document from a template and originating record.
POST/v1/document/internal/finalize$0.0100Finalizes an internally filled document, applying any manual signatures/text
POST/v1/document/internal/init$0.0100Initializes an internal document fill session.
POST/v1/document/preview$0.0100Generates a PDF preview by merging the provided fields and data.
GET/v1/public/document/{token}$0.0000 (Free)Publicly fetches the document to be signed, given a valid JWT token.
POST/v1/public/document/{token}/sign$0.0100Publicly submits signatures and applies them to the document.

Telephony & Communications (Twilio) (73 Routes)

MethodEndpoint PathPriceHandler / Description
GET/v1/twilio/account/application$0.0030Get Route
PATCH/v1/twilio/account/application$0.0030Patch Route
POST/v1/twilio/account/application$0.0030Post Route
POST/v1/twilio/account/subaccount$0.0030Post Subaccount Route
PATCH/v1/twilio/call$0.0030Update Call Route
POST/v1/twilio/call/available$0.0030Available Route
POST/v1/twilio/call/callback/{org_id}$0.0030Call Callback Route
POST/v1/twilio/call/client/{user_id}$0.0030Client Route
POST/v1/twilio/call/conference-callback/{org_id}$0.0030Conference Callback
GET/v1/twilio/call/fetch/{call_id}$0.0030Call Route
GET/v1/twilio/call/lookup$0.0030Lookup Route
POST/v1/twilio/call/recording/callback/{org_id}$0.0030Recording Callback Route
GET/v1/twilio/call/recording/{recording_id}$0.0030Recording Route
POST/v1/twilio/call/salesforce-click-to-dial$0.0030Salesforce Click To Dial
POST/v1/twilio/call/salesforce-navigate-to-record$0.0030Salesforce Sucks Route
POST/v1/twilio/call/save-client-call/{sid}$0.0030Save Client Call Route
POST/v1/twilio/call/studio/{org_id}$0.0030Studio Route
GET/v1/twilio/call/token$0.0030Token Route
GET/v1/twilio/call/token/{platform}$0.0030Platform Token Route
POST/v1/twilio/call/update/{sid}$0.0030Update Call Route Sid
POST/v1/twilio/call/voicemail/callback/{org_id}$0.0030Voicemail Callback Route
POST/v1/twilio/call/voicemail/force/{org_id}$0.0030Force Voicemail Route
POST/v1/twilio/call/voicemail/recording/{org_id}$0.0030Voicemail Recording Callback Route
POST/v1/twilio/call/voicemail/start/{org_id}$0.0030Voicemail Start Route
POST/v1/twilio/call/voicemail/{org_id}$0.0030Post Voicemail Route
POST/v1/twilio/call/{org_id}$0.0030Post Call Route
POST/v1/twilio/call/{org_id}/test$0.0030Handle Inbound Call Route Test
GET/v1/twilio/conversation$0.0030Get Route
POST/v1/twilio/conversation$0.0030Create Route
GET/v1/twilio/conversation/count$0.0030Get Conversation Count
GET/v1/twilio/conversation/page$0.0030Get Conversation Page
POST/v1/twilio/conversation/reconcile$0.0030Reconcile Twilio Data
GET/v1/twilio/conversation/token$0.0030Token Route
GET/v1/twilio/conversation/webhooks$0.0030Get Conversation Webhooks
POST/v1/twilio/conversation/webhooks$0.0030Update Webhook
POST/v1/twilio/conversation/with-participants$0.0030Create Route
DELETE/v1/twilio/conversation/{conversation_id}$0.0030Delete a conversation
POST/v1/twilio/conversation/{org_id}/post-webhook$0.0030Create Conversation Webhooks
GET/v1/twilio/conversation/{service_id}$0.0030Get Route
DELETE/v1/twilio/conversation/{service_id}/{conversation_id}$0.0030Delete a conversation from a service
GET/v1/twilio/conversation/{service_id}/{conversation_id}$0.0030Get Route By Service And Conversation
PUT/v1/twilio/conversation/{service_id}/{conversation_id}$0.0030Update Route
POST/v1/twilio/conversational-intelligence$0.0030Creates a new Twilio Conversational Intelligence Service.
POST/v1/twilio/conversational-intelligence/transcribe$0.0030Creates a new transcription for a given Twilio recording.
GET/v1/twilio/conversational-intelligence/transcription/{sid}$0.0030Retrieves a transcription by its SID.
GET/v1/twilio/conversational-intelligence/transcription/{sid}/sentences$0.0030Retrieves a transcription by its SID.
POST/v1/twilio/conversational-intelligence/webhook/{organization_id}$0.0030Webhook endpoint to receive events from Twilio Conversational Intelligence.
POST/v1/twilio/iam/keys$0.0030Post Route
GET/v1/twilio/media/recording/{sid}$0.0030Get Recording
GET/v1/twilio/media/{service_sid}$0.0030Get Media
POST/v1/twilio/media/{service_sid}$0.0030Creates a new media resource in Twilio by fetching an existing file from S3.
POST/v1/twilio/message$0.0030Create Message
GET/v1/twilio/message/{service_sid}/{conversation_sid}$0.0030Get Messages
GET/v1/twilio/message/{service_sid}/{conversation_sid}/{message_sid}$0.0030Get Message
GET/v1/twilio/message/{service_sid}/{conversation_sid}/{message_sid}/receipts$0.0030Get Message Receipts
POST/v1/twilio/participant$0.0030Create Route
DELETE/v1/twilio/participant/{conversation_id}/{participant_id}$0.0030Delete Route
DELETE/v1/twilio/participant/{service_id}/{conversation_id}/{participant_id}$0.0030Service Delete Route
GET/v1/twilio/participant/{service_sid}/{conversation_id}$0.0030Description: Get all Twilio participants by conversation id
GET/v1/twilio/participant/{service_sid}/{conversation_id}/{participant_id}$0.0030Description: Get a Twilio participant by conversation id and participant id
GET/v1/twilio/phone$0.0030Get Route
PATCH/v1/twilio/phone$0.0030Patch Route
POST/v1/twilio/phone/address/{service_sid}$0.0030Create Phone Address
GET/v1/twilio/phone/lookup$0.0030Lookup Route
POST/v1/twilio/phone/purchase$0.0030Purchase Phone Address
GET/v1/twilio/phone/search$0.0030Find Phone Address
GET/v1/twilio/service$0.0030Get Route
POST/v1/twilio/service$0.0030Post Route
POST/v1/twilio/service/push-credential$0.0030Post Push Credential
POST/v1/twilio/sms$0.0030Send Sms Route
POST/v1/twilio/sms/callback/{org_id}$0.0030Sms Callback Route
POST/v1/twilio/sms/inbound/{org_id}$0.0030Sms Inbound Route
GET/v1/twilio/sms/{sms_sid}$0.0030Get Sms Route

Core Data Engine, CUD & SQL Queries (15 Routes)

MethodEndpoint PathPriceHandler / Description
GET/v1/query$0.0000 (Free)Description
POST/v1/query$0.0000 (Free)Sql Query Post Route
POST/v1/query/mongo$0.0000 (Free)Direct MongoDB Aggregation Endpoint (V2) - Async
GET/v1/schema$0.0000 (Free)Get Schemas
PATCH/v1/schema$0.0010Update Schema
POST/v1/schema$0.0010Create Schema
PATCH/v1/schema/field$0.0010Update Schema Field
POST/v1/schema/field$0.0010Create Schema Field
POST/v1/schema/generate/$0.0010Generate Schema
POST/v1/schema/{object_id}/validation-rule$0.0010Create Validation Rule
DELETE/v1/schema/{object_id}/validation-rule/{rule_api_name}$0.0010Delete Validation Rule
PATCH/v1/schema/{object_id}/validation-rule/{rule_api_name}$0.0010Update Validation Rule
DELETE/v1/schema/{object_id}/{field_name}$0.0010Delete Schema Field
GET/v1/schema/{object}$0.0000 (Free)Get Schema
DELETE/v1/schema/{schema_id}$0.0010Delete Schema Route

Virtual File System & Storage (VFS/S3) (37 Routes)

MethodEndpoint PathPriceHandler / Description
POST/v1/files$0.0010Handles multiple file uploads.
POST/v1/files/batch-content$0.0010Updates content for multiple files concurrently using asyncio.gather.
POST/v1/files/location$0.0000 (Free)Streams a file directly from S3 given its full location key.
POST/v1/files/presigned-upload$0.0010Generates a presigned POST configuration for direct browser upload to S3/Spaces.
GET/v1/files/presigned-url/{file_id}$0.0000 (Free)Returns a direct, short-lived presigned GET URL for streaming/downloading from S3.
POST/v1/files/register$0.0010Registers the direct uploaded file record in MongoDB and triggers processing if needed.
GET/https://api.valstorm.com/v1/files/stream$0.0000 (Free)Streams a file by location (deprecated/compatibility).
GET/https://api.valstorm.com/v1/files/stream/{file_id}$0.0000 (Free)Streams a file by ID using a query token for authentication.
POST/v1/files/token$0.0010Generates a short-lived (5 min) access token.
POST/v1/files/update-location$0.0010Critcial internal route: updates a file's location metadata WITHOUT triggering the standard async triggers.
DELETE/v1/files/{file_id}$0.0010Deletes a file from DB and S3 via the service layer.
GET/v1/files/{file_id}$0.0000 (Free)Finds a file by its ID in the database and streams it from S3.
POST/v1/files/{file_id}/active-version/{version_id}$0.0010Promotes a specific file_version to be the canonical active_version.
POST/v1/files/{file_id}/content$0.0010Direct single-roundtrip endpoint to update file text/raw content.
POST/v1/files/{file_id}/rollback$0.0010Rolls back to a target version by publishing a forward copy as a new head version.
GET/v1/files/{file_id}/versions$0.0000 (Free)Returns all historical file_version records for a file, ordered by version_number DESC.
DELETE/v1/files/{file_id}/versions/{version_number}$0.0010Deletes a specific historical file_version snapshot and removes its S3 object.
GET/v1/files/{file_id}/versions/{version_number}$0.0000 (Free)Fetches metadata, presigned URL, and text_content for a specific file version.
GET/v1/files/{file_id}/versions/{version_number}/download$0.0000 (Free)Streams a specific historical file version from S3.
POST/v1/vfs/batch-move$0.0010Moves multiple items (vaults or files) atomically in a single batch.
POST/v1/vfs/cache/rebuild$0.0010Forcefully clears and rebuilds the VFS cache for the user's organization from MongoDB.
GET/v1/vfs/download/{file_id}$0.0000 (Free)Streams a file for download.
GET/v1/vfs/file/{file_id}$0.0000 (Free)Loads full file metadata and content or presigned URL in a single high-performance roundtrip.
POST/v1/vfs/move$0.0010Moves an item (vault or record) from one vault to another.
GET/v1/vfs/path/{string_path:path}$0.0000 (Free)Resolves a string path (e.g., 'Marketing/2026') to a Vault ID,
GET/v1/vfs/public/file/{file_id}$0.0010Returns public file metadata and inline content if markdown/text.
GET/v1/vfs/public/stream$0.0010Streams a public file by file_id or location directly to internet visitors without requiring auth tokens.
GET/v1/vfs/public/stream/{file_id}$0.0010Streams a public file by file_id or location directly to internet visitors without requiring auth tokens.
GET/v1/vfs/public/vault/{vault_id}$0.0010Returns the public folders and files within a public vault folder.
GET/v1/vfs/public/vault/{vault_id}/tree$0.0010Returns the recursive hierarchy of all public subfolders and files for a public vault.
POST/v1/vfs/query$0.0000 (Free)Dedicated query endpoint for VFS.
GET/v1/vfs/snapshot$0.0000 (Free)Generates a full VFS hierarchy snapshot for the current user.
GET/v1/vfs/tree$0.0000 (Free)Returns all vaults the current user has access to.
POST/v1/vfs/upload$0.0010Uploads a single file to a specific vault via VFS.
GET/v1/vfs/vault/{vault_id}$0.0000 (Free)Returns the contents of a specific Vault folder with role-based access control.
POST/v1/vfs/vaults/batch$0.0000 (Free)Fetches contents for multiple vaults concurrently.
DELETE/v1/vfs/{item_id}$0.0010Deletes an item from the VFS.

Third-Party Email, Calendar & Messaging Integrations (68 Routes)

MethodEndpoint PathPriceHandler / Description
POST/v1/email-services/preview-template$0.0010Preview Template
POST/v1/email-services/sendgrid/messages/search$0.0010Search Messages
POST/v1/email-services/sendgrid/messages/{message_id}$0.0010Get Message Details
POST/v1/email-services/sendgrid/send$0.0010Send Email
POST/v1/email-services/sendgrid/webhook/{organization_id}$0.0010Webhook received and being processed
POST/v1/email-services/strip-html$0.0010Strip Html
POST/v1/email-services/validate-email$0.0010Validate Email
POST/v1/google-workspace/admin/setup$0.0010IT Admin setup route for Google Workspace Domain-Wide Delegation (DwD).
GET/v1/google-workspace/calendar/list$0.0010Get Calendar List Route
POST/v1/google-workspace/calendar/pub-sub/{user_id}/{org_id}/{account_email}/{calendar_id}$0.0010Webhook endpoint to handle incoming Google Calendar push notifications.
POST/v1/google-workspace/calendar/pub-sub/{user_id}/{org_id}/{calendar_id}$0.0010Webhook endpoint to handle incoming Google Calendar push notifications.
POST/v1/google-workspace/calendar/sync$0.0010Calendar Sync Route
POST/v1/google-workspace/calendar/watch/{calendar_id}$0.0010Watch Calendar Route
POST/v1/google-workspace/create/drive/subscription$0.0010Create Drive Subscription Route
GET/v1/google-workspace/drive/file/content/{file_id}$0.0010Get Drive File Content Route
GET/v1/google-workspace/drive/file/export/{file_id}$0.0010Export Drive File Route
GET/v1/google-workspace/drive/file/{file_id}$0.0010Get Drive File Route
GET/v1/google-workspace/drive/files/list$0.0010Get Drive File List Route
GET/v1/google-workspace/drive/list$0.0010Get Drive List Route
POST/v1/google-workspace/drive/sync$0.0010Drive Sync Route
POST/v1/google-workspace/drive/watch/{file_id}$0.0010Watch Drive File Route
GET/v1/google-workspace/emails$0.0010Fetch emails for any user in the organization using Domain-Wide Delegation (impersonation).
GET/v1/google-workspace/events/list$0.0010Get Event List Route
GET/v1/google-workspace/events/{event_id}$0.0010Get Event Route
POST/v1/google-workspace/gmail/send$0.0010Route to send an email via Google Gmail API.
DELETE/v1/google-workspace/pub-sub/subscription$0.0010Deletes the Pub/Sub subscription for the organization.
POST/v1/google-workspace/pub-sub/subscription$0.0010Creates a Pub/Sub topic and push subscription for the organization.
POST/v1/google-workspace/pub-sub/{org_id}$0.0010Webhook endpoint to handle incoming Google Pub/Sub notifications (Gmail history changes).
POST/v1/google-workspace/sync$0.0010Triggers an asynchronous full historic Gmail sync for a user using Service Account (DwD).
POST/v1/google-workspace/watch$0.0010Registers a Gmail push watch for a specific email address (impersonation).
POST/v1/google-workspace/watch/stop$0.0010Terminates a Gmail push watch for a specific email address (impersonation).
GET/v1/microsoft/auth/callback$0.0010Handles the callback from Microsoft.
GET/v1/microsoft/auth/login$0.0010Login Microsoft
GET/v1/microsoft/calendar$0.0010Get Microsoft Calendar
GET/v1/microsoft/calendar/events$0.0010List Microsoft Events
POST/v1/microsoft/calendar/{calendar_id}/stop$0.0010Stops watching a specific Microsoft Graph calendar.
POST/v1/microsoft/calendar/{calendar_id}/sync$0.0010Triggers an initial full sync or a delta sync of the user's Outlook calendar.
POST/v1/microsoft/calendar/{calendar_id}/watch$0.0010Sets up a Microsoft Graph subscription (webhook) for real-time calendar notifications.
GET/v1/microsoft/calendars$0.0010List Microsoft Calendars
POST/v1/microsoft/email/send$0.0010Sends an email via Microsoft Graph API.
POST/v1/microsoft/email/stop$0.0010Stops watching the Microsoft Graph mailbox by deleting the active subscription.
POST/v1/microsoft/email/sync$0.0010Triggers a sync of the user's Outlook inbox.
POST/v1/microsoft/email/watch$0.0010Sets up a Microsoft Graph subscription (webhook) for real-time email notifications.
POST/v1/microsoft/email/{message_id}/reply$0.0010Replies to a specific message via Microsoft Graph API.
GET/v1/microsoft/list-inbox$0.0010List Microsoft Inbox
GET/v1/microsoft/me$0.0010Get Microsoft Profile
GET/v1/microsoft/subscriptions$0.0010Lists all Microsoft Graph subscriptions for the user.
POST/v1/microsoft/subscriptions$0.0010Creates a new Microsoft Graph subscription.
DELETE/v1/microsoft/subscriptions/{subscription_id}$0.0010Deletes a specific Microsoft Graph subscription.
GET/v1/microsoft/subscriptions/{subscription_id}$0.0010Retrieves a specific Microsoft Graph subscription.
PATCH/v1/microsoft/subscriptions/{subscription_id}$0.0010Updates a specific Microsoft Graph subscription.
POST/v1/microsoft/webhook/calendar/notifications/{org_id}/{user_id}/{calendar_id}$0.0010Public endpoint to receive Microsoft Graph webhook notifications for calendar events.
POST/v1/microsoft/webhook/notifications/{org_id}/{user_id}$0.0010Public endpoint to receive Microsoft Graph webhook notifications.
GET/v1/slack/auth/callback$0.0010Public OAuth v2 callback endpoint. Validates anti-CSRF state against Redis,
POST/v1/slack/auth/disconnect$0.0010Revokes Slack tokens and marks connection as disconnected.
GET/v1/slack/auth/login$0.0010Login Slack
GET/v1/slack/auth/status$0.0010Returns current Slack integration connection status and workspace metadata.
GET/v1/slack/channels$0.0010Lists channels in the connected Slack workspace.
POST/v1/slack/chat/delete$0.0010Deletes a message from a Slack channel.
GET/v1/slack/chat/history$0.0010Retrieves recent message history (or thread) from a Slack channel.
POST/v1/slack/chat/post$0.0010Posts a message to a channel or thread.
POST/v1/slack/chat/update$0.0010Updates an existing message in a Slack channel.
POST/v1/slack/events$0.0010Public Slack Events Webhook endpoint.
GET/v1/slack/oidc/callback$0.0010Handles OpenID Connect sign-in callback from Slack.
GET/v1/slack/oidc/login$0.0010Initiates Sign in with Slack (OpenID Connect flow).
POST/v1/slack/reactions/add$0.0010Adds an emoji reaction to a message.
GET/v1/slack/users$0.0010Lists users in the Slack workspace.
GET/v1/slack/users/{user_id}/profile$0.0010Retrieves a specific Slack user's profile (name, email, title, avatar).

Custom App Builder, Portals & Marketing (13 Routes)

MethodEndpoint PathPriceHandler / Description
POST/v1/analytics/report$0.0010Report Frontend
POST/v1/apps/app-update-subscribers$0.0010Updates all organizations subscribed to the provided App concurrently
POST/v1/apps/apply-apps$0.0010Bulk installs a list of Apps by ID via the dedicated CICD background worker.
PUT/v1/apps/deploy$0.0010Receives an app package from CICD and deploys it to the Current User's Organization.
GET/v1/apps/deploy/{app_id_or_name}$0.0010Triggers an environment promotion by sending the App Data to the CICD service.
POST/v1/apps/marketplace-deployment$0.0010Asynchronously deploys the current app state to the 'Base' database (The Marketplace)
POST/v1/apps/onboard-app$0.0010Retrieves a list of onboarded apps for the current user's organization.
POST/v1/portal$0.0010Creates a new portal experience under the parent production tenant.
DELETE/v1/portal/{portal_id}$0.0010Deletes a portal and drops its associated database entirely.
PATCH/v1/portal/{portal_id}$0.0010Updates an existing portal's name or custom domain.
GET/v1/portal/{portal_id}/users$0.0010Lists all authorized users registered inside a portal's local database.
POST/v1/portal/{portal_id}/users$0.0010Invites a guest user to a portal, auto-linking existing global accounts if they exist.
DELETE/v1/portal/{portal_id}/users/{user_id}$0.0010Removes a guest user's access from a portal and drops their membership documents.

Billing & Stripe Payments (12 Routes)

MethodEndpoint PathPriceHandler / Description
POST/v1/billing/create-credit-checkout-session$0.0010Creates a Stripe Hosted Checkout Session for one-time credit purchases.
POST/v1/billing/create-registration-checkout-session$0.0010Create Registration Checkout Session
POST/v1/billing/hooks$0.0010Hooks Route
GET/v1/billing/portal$0.0010Creates a Stripe Customer Portal session for managing cards, billing, and invoices.
POST/v1/billing/sync-twilio-usage$0.0010Triggers the daily or multi-day range Twilio usage sync for the entire system.
GET/v1/billing/verify-credit-session/{session_id}$0.0010Verifies a credit checkout session status and fulfills credit balance idempotently.
POST/v1/stripe/auth/claim$0.0010Claims previously cached Stripe credentials using a secure claim token
GET/v1/stripe/auth/login$0.0010Initiates the Stripe OAuth / App installation flow by generating a unique
POST/v1/stripe/fetch$0.0010Authenticated generic proxy endpoint that maps API requests to standard
GET/v1/stripe/public/auth/callback$0.0010Handles the OAuth2 callback from Stripe Apps.
POST/v1/stripe/public/webhook$0.0010Receives and routes Stripe Connect/App webhook events.
POST/v1/stripe/sync/historical$0.0010Authenticated endpoint that enqueues a background task to sync all historical