SaaSignal API
Serverless infrastructure API — KV, Locks, Sketches, Channels, Jobs, Workflows, Webhooks, Storage, Media, AI, and Decisioning primitives (Search, Matching, Ranking) on Cloudflare. Includes Logistics (geospatial, tracking, routing) and Delivery (order, driver, zone management) modules.
Infra > KV
Global key-value store backed by Cloudflare KV.
6 endpointsInfra > Locks
Distributed mutexes backed by Cloudflare Durable Objects for mutually exclusive access to keyed resources.
4 endpointsInfra > Sketches
Probabilistic analytics primitives such as HyperLogLog and Count-Min Sketch for high-throughput counting.
5 endpointsInfra > Channels
Real-time pub/sub powered by Cloudflare Durable Objects.
5 endpointsInfra > Jobs
Unified task, queue, and cron primitive.
11 endpointsInfra > Workflows
DAG-based orchestration on top of Jobs for resumable multi-step processes and compensating flows.
6 endpointsInfra > Webhooks
Webhook subscription management and event fan-out. Subscribe to topics like `kv.*`, `channels.*`, `jobs.*`, `logistics.*`, or `*` for all events. See the Webhook Topics section for the full topic reference.
9 endpointsInfra > Storage
File storage backed by Cloudflare R2. Upload, download, list, and delete objects with optional metadata.
11 endpointsInfra > Media
Image transformations and video encoding backed by Cloudflare Images and Cloudflare Stream.
7 endpointsInfra > AI
Atomic AI primitives: model catalog, responses, embeddings, rerank, moderation, audio, images, documents, and async operation tracking.
30 endpointsInfra > Decisioning > Search
Managed hybrid retrieval primitives backed by D1 metadata, FTS recall, optional Vectorize namespaces, and Workers AI embeddings or rerank.
13 endpointsInfra > Decisioning > Matching
Domain-agnostic constrained assignment and optimal matching primitives over caller-supplied nodes, capacities, and weighted edges.
10 endpointsInfra > Decisioning > Ranking
Ranking primitives for caller-owned collections, signals, recommendation queries, and related-item lookups.
13 endpointsCompat > OpenAI
OpenAI-compatible aliases for selected AI primitives exposed under `/v1/*`.
13 endpointsLogistics > Geo
Generic geospatial entity registration, status management, and proximity search.
6 endpointsLogistics > Tracking
Real-time GPS tracking with live WebSocket streaming.
4 endpointsLogistics > Geofencing
Define zones and receive enter/exit webhooks when tracked entities cross boundaries.
4 endpointsLogistics > ETA Fencing
Define destination points with time thresholds. Receive breach/cleared webhooks when a tracked entity's driving ETA drops below or rises above the configured threshold.
4 endpointsLogistics > Routing
Route calculation, stop optimization, distance matrices, dispatch, isochrone, and snap-to-road via Mapbox.
6 endpointsLogistics > Geocoding
Forward/reverse geocoding and address autocomplete via Mapbox.
3 endpointsModules > Delivery > Settings
Configure delivery module behavior per project.
2 endpointsModules > Delivery > Drivers
Manage delivery drivers, online/offline status, and location tracking.
7 endpointsModules > Delivery > Customers
Manage delivery customers and their saved addresses.
8 endpointsModules > Delivery > Vehicles
Manage delivery vehicles and assign them to drivers.
5 endpointsModules > Delivery > Orders
Create, track, and manage delivery orders through their lifecycle.
12 endpointsModules > Delivery > Stops
Manage pickup, dropoff, and waypoint stops within delivery orders.
8 endpointsModules > Delivery > Dispatch
Auto-assign drivers and suggest optimal driver matches for orders.
2 endpointsModules > Delivery > Dispatch Rules
Rule-based auto-dispatch: create, evaluate, and apply dispatch rules to automatically assign drivers to orders.
7 endpointsModules > Delivery > Tracking
Generate public tracking links, render tracking pages, and stream live delivery updates to customers and drivers.
11 endpointsModules > Delivery > Zones
Define delivery zones backed by logistics geofences.
5 endpointsModules > Delivery > Hubs
Manage delivery hubs (warehouses, kitchens, pickup points).
5 endpointsModules > Delivery > Notifications
Configure which delivery events trigger notifications.
2 endpointsModules > Delivery > Webhooks
Manage webhooks for delivery-specific event topics.
2 endpointsModules > Delivery > ETA Fences
Create and manage ETA fences for delivery destinations. Receive breach webhooks when a tracked entity's driving ETA drops below the configured threshold.
4 endpointsModules > Delivery > Analytics
Delivery performance analytics and driver statistics.
2 endpointsModules > Delivery > Export
Export delivery data in JSON or CSV format.
1 endpointsModules > Commerce > Settings
Configure commerce module behavior per project: currency, tax, inventory tracking, review moderation, cart TTL.
2 endpointsModules > Commerce > Catalogs
Manage product catalogs (storefronts) with multi-currency support.
5 endpointsModules > Commerce > Categories
Hierarchical product categories within catalogs, with tree traversal.
6 endpointsModules > Commerce > Products
Full product lifecycle: create, list, search, update, and archive products with pricing, variants, and inventory.
5 endpointsModules > Commerce > Variants
Product variants (size, color, material) with independent pricing and inventory tracking.
5 endpointsModules > Commerce > Inventory
Track stock levels, adjust quantities, and receive low-stock alerts.
4 endpointsModules > Commerce > Customers
Manage commerce customers with addresses, order history, and marketing preferences.
8 endpointsModules > Commerce > Carts
Shopping carts with item management, discount codes, and checkout to create orders.
8 endpointsModules > Commerce > Orders
Order lifecycle management with state machine transitions: pending → confirmed → processing → shipped → delivered → completed.
6 endpointsModules > Commerce > Payments
Payment records with state machine: pending → authorized → captured → refunded. Supports multiple gateways.
4 endpointsModules > Commerce > Reviews
Product reviews with ratings, verified purchase detection, and moderation workflow (pending → approved/rejected/flagged).
5 endpointsModules > Commerce > Discounts
Discount codes: percentage, fixed amount, free shipping, buy-X-get-Y. Usage limits, date ranges, and product targeting.
6 endpointsModules > Commerce > Webhooks
Manage webhooks for commerce-specific event topics (orders, payments, inventory, reviews).
2 endpointsModules > Commerce > Analytics
Commerce analytics: revenue summary, top products, and time-series revenue data.
3 endpointsModules > Commerce > Export
Export commerce data (orders, products, customers) in JSON or CSV format.
3 endpointsModules > Booking > Settings
Per-project booking configuration: timezone, slot duration, advance limits, and cancellation policy.
2 endpointsModules > Booking > Resources
Bookable resources (rooms, tables, staff, equipment) with capacity and metadata.
5 endpointsModules > Booking > Availability
Availability rules and slot computation for resources.
3 endpointsModules > Booking > Bookings
Reservations with status lifecycle: pending → confirmed → checked_in → completed / cancelled / no_show.
7 endpointsModules > Booking > Customers
Manage booking customers with contact details and booking history.
5 endpointsModules > Booking > Blockers
Calendar blocks (holidays, maintenance, staff leave) that override availability.
3 endpointsModules > Booking > Webhooks
Manage webhooks for booking-specific event topics (bookings, resources, availability).
2 endpointsModules > Booking > Analytics
Booking analytics: utilization rates, peak hours, and time-series booking data.
3 endpointsModules > Booking > Export
Export booking data (bookings, resources, customers) in JSON or CSV format.
3 endpointsModules > Messaging > Settings
Per-project messaging configuration: participant limits, message length, retention, reactions, and conversation numbering.
2 endpointsModules > Messaging > Conversations
Conversations with status lifecycle: open → archived / closed. Supports direct and group types with auto-numbering.
8 endpointsModules > Messaging > Participants
Manage conversation participants with roles (owner, member, readonly) and read receipts.
4 endpointsModules > Messaging > Messages
Send, list, edit, and soft-delete messages within conversations. Validates body length against project settings.
5 endpointsModules > Messaging > Reactions
Add and remove emoji reactions on messages. One reaction per participant per emoji per message.
2 endpointsModules > Messaging > Webhooks
Manage webhooks for messaging-specific event topics (conversations, participants, messages).
2 endpointsModules > Messaging > Analytics
Messaging analytics: conversation counts, message volumes, and time-series data.
3 endpointsModules > Messaging > Export
Export messaging data (conversations, messages) in JSON or CSV format.
2 endpointsCore > Organizations
Create and manage organizations.
10 endpointsCore > Projects
Projects live inside organizations and isolate KV namespaces, channels, jobs, and token balances.
4 endpointsCore > Tokens
Check project balances and query usage analytics.
7 endpointsCore > Billing
Subscription packages and usage data.
4 endpointsMCP
Model Context Protocol endpoint. SaaSignal exposes a stateless, POST-only MCP transport on `/mcp`; standalone SSE sessions are not provided, so unsupported GET/DELETE requests return `405 Method Not Allowed`. Primary auth is browser-based OAuth on the frontend host, with project API keys still supported as a manual fallback. OAuth tokens are filtered during `tools/list` and challenged with `insufficient_scope` when required. Documented HTTP routes are exposed automatically as MCP tools using their OpenAPI operationId values, while legacy operational aliases remain available.
2 endpointsMeta
Health check, API docs, OpenAPI specification, and AI-first documentation (agent skill, llms.txt, human-readable markdown, landing page).
13 endpointsAvailable formats
No separate URL to discover. Your AI agent hits this page directly and receives the token-optimized format — no /llms.txt convention required.
curl -H "Accept: text/markdown" https://api.saasignal.saastemly.com/
Authentication
This API supports the following authentication methods:
| Method | Header | Use case |
|---|---|---|
| API Key | X-API-Key: sk_<appId>_<hex> | Backend-to-backend. Create via POST /api-keys. |
Infra > KV
Global key-value store backed by Cloudflare KV.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /infra/kv/{key} | Get a value by key | API Key (X-API-Key) |
PUT | /infra/kv/{key} | Set a key-value pair | API Key (X-API-Key) |
DELETE | /infra/kv/{key} | Delete a key | API Key (X-API-Key) |
POST | /infra/kv/{key}/increment | Atomically increment a numeric value | API Key (X-API-Key) |
GET | /infra/kv | Scan keys by prefix | API Key (X-API-Key) |
POST | /infra/kv | Execute batch operations | API Key (X-API-Key) |
Infra > Locks
Distributed mutexes backed by Cloudflare Durable Objects for mutually exclusive access to keyed resources.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/locks/{key}/acquire | Acquire a lock | API Key (X-API-Key) |
POST | /infra/locks/{key}/release | Release a lock | API Key (X-API-Key) |
POST | /infra/locks/{key}/renew | Renew a lock | API Key (X-API-Key) |
GET | /infra/locks/{key} | Check lock status | API Key (X-API-Key) |
Infra > Sketches
Probabilistic analytics primitives such as HyperLogLog and Count-Min Sketch for high-throughput counting.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/sketches/hll/{key}/add | Add elements to a HyperLogLog | API Key (X-API-Key) |
GET | /infra/sketches/hll/{key}/count | Estimate HyperLogLog count | API Key (X-API-Key) |
POST | /infra/sketches/hll/merge | Merge HyperLogLogs | API Key (X-API-Key) |
POST | /infra/sketches/cms/{key}/increment | Increment Count-Min Sketch frequencies | API Key (X-API-Key) |
GET | /infra/sketches/cms/{key}/estimate | Estimate Count-Min Sketch frequency | API Key (X-API-Key) |
Infra > Channels
Real-time pub/sub powered by Cloudflare Durable Objects.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/channels/{channel}/publish | Publish an event to a channel | API Key (X-API-Key) |
POST | /infra/channels/publish | Batch publish events | API Key (X-API-Key) |
GET | /infra/channels/{channel}/subscribe | Subscribe to a channel | API Key (X-API-Key) |
GET | /infra/channels/{channel}/presence | Get channel presence | API Key (X-API-Key) |
GET | /infra/channels/{channel}/history | Get channel message history | API Key (X-API-Key) |
Infra > Jobs
Unified task, queue, and cron primitive.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/jobs | Create a job | API Key (X-API-Key) |
GET | /infra/jobs | List jobs | API Key (X-API-Key) |
POST | /infra/jobs/batch | Batch create jobs | API Key (X-API-Key) |
POST | /infra/jobs/claim | Claim a pull job | API Key (X-API-Key) |
GET | /infra/jobs/{job_id} | Get a job | API Key (X-API-Key) |
PATCH | /infra/jobs/{job_id} | Update a job | API Key (X-API-Key) |
DELETE | /infra/jobs/{job_id} | Cancel a job | API Key (X-API-Key) |
POST | /infra/jobs/{job_id}/ack | Acknowledge a claimed job | API Key (X-API-Key) |
POST | /infra/jobs/{job_id}/trigger | Manually trigger a scheduled job | API Key (X-API-Key) |
POST | /infra/jobs/{job_id}/retry | Retry a failed job | API Key (X-API-Key) |
GET | /infra/jobs/{job_id}/runs | List job runs | API Key (X-API-Key) |
Infra > Workflows
DAG-based orchestration on top of Jobs for resumable multi-step processes and compensating flows.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/workflows/blueprints | Create a workflow blueprint | API Key (X-API-Key) |
GET | /infra/workflows/blueprints | List workflow blueprints | API Key (X-API-Key) |
POST | /infra/workflows/blueprints/{blueprint_id}/trigger | Trigger a workflow execution | API Key (X-API-Key) |
GET | /infra/workflows/executions/{execution_id} | Get workflow execution status | API Key (X-API-Key) |
POST | /infra/workflows/executions/{execution_id}/cancel | Cancel a workflow execution | API Key (X-API-Key) |
POST | /infra/workflows/executions/{execution_id}/resume | Resume a workflow execution | API Key (X-API-Key) |
Infra > Webhooks
Webhook subscription management and event fan-out. Subscribe to topics like `kv.*`, `channels.*`, `jobs.*`, `logistics.*`, or `*` for all events. See the Webhook Topics section for the full topic reference.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/webhooks | Create a webhook | API Key (X-API-Key) |
GET | /infra/webhooks | List webhooks | API Key (X-API-Key) |
POST | /infra/webhooks/publish | Publish a custom event | API Key (X-API-Key) |
GET | /infra/webhooks/{webhook_id} | Get a webhook | API Key (X-API-Key) |
PATCH | /infra/webhooks/{webhook_id} | Update a webhook | API Key (X-API-Key) |
DELETE | /infra/webhooks/{webhook_id} | Delete a webhook | API Key (X-API-Key) |
POST | /infra/webhooks/{webhook_id}/test | Test a webhook | API Key (X-API-Key) |
GET | /infra/webhooks/{webhook_id}/deliveries | List webhook deliveries | API Key (X-API-Key) |
POST | /infra/webhooks/{webhook_id}/deliveries/{delivery_id}/retry | Retry a webhook delivery | API Key (X-API-Key) |
Infra > Storage
File storage backed by Cloudflare R2. Upload, download, list, and delete objects with optional metadata.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/storage/buckets | Create a bucket | API Key (X-API-Key) |
GET | /infra/storage/buckets | List buckets | API Key (X-API-Key) |
GET | /infra/storage/buckets/{bucketId} | Get a bucket | API Key (X-API-Key) |
DELETE | /infra/storage/buckets/{bucketId} | Delete a bucket | API Key (X-API-Key) |
PUT | /infra/storage/buckets/{bucketId}/objects/* | Upload an object | API Key (X-API-Key) |
GET | /infra/storage/buckets/{bucketId}/objects/* | Download an object | API Key (X-API-Key) |
DELETE | /infra/storage/buckets/{bucketId}/objects/* | Delete an object | API Key (X-API-Key) |
GET | /infra/storage/buckets/{bucketId}/objects | List objects | API Key (X-API-Key) |
POST | /infra/storage/buckets/{bucketId}/signed-url | Generate a signed URL | API Key (X-API-Key) |
GET | /infra/storage/signed/{token} | Consume a signed download URL | None required |
PUT | /infra/storage/signed/{token} | Consume a signed upload URL | None required |
Infra > Media
Image transformations and video encoding backed by Cloudflare Images and Cloudflare Stream.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/media/assets | Upload a media asset | API Key (X-API-Key) |
GET | /infra/media/assets | List media assets | API Key (X-API-Key) |
GET | /infra/media/assets/{assetId} | Get a media asset | API Key (X-API-Key) |
DELETE | /infra/media/assets/{assetId} | Delete a media asset | API Key (X-API-Key) |
POST | /infra/media/assets/{assetId}/transform/image | Generate a transformed image URL | API Key (X-API-Key) |
POST | /infra/media/assets/{assetId}/transform/video | Start a video encoding job | API Key (X-API-Key) |
GET | /infra/media/assets/{assetId}/variants | List asset variants | API Key (X-API-Key) |
Infra > AI
Atomic AI primitives: model catalog, responses, embeddings, rerank, moderation, audio, images, documents, and async operation tracking.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /infra/ai/models | List AI models | API Key (X-API-Key) |
GET | /v1/models | List AI models | API Key (X-API-Key) |
GET | /infra/ai/models/{model_id} | Get AI model | API Key (X-API-Key) |
GET | /v1/models/{model_id} | Get AI model | API Key (X-API-Key) |
POST | /infra/ai/responses | Create an AI response | API Key (X-API-Key) |
POST | /v1/responses | Create an AI response | API Key (X-API-Key) |
POST | /v1/chat/completions | Create a chat completion | API Key (X-API-Key) |
POST | /infra/ai/realtime/sessions | Create a realtime session bootstrap | API Key (X-API-Key) |
POST | /v1/realtime/sessions | Create a realtime session bootstrap | API Key (X-API-Key) |
POST | /infra/ai/embeddings | Create embeddings | API Key (X-API-Key) |
POST | /v1/embeddings | Create embeddings | API Key (X-API-Key) |
POST | /infra/ai/rerank | Rerank candidate documents | API Key (X-API-Key) |
POST | /infra/ai/moderations | Create moderation classifications | API Key (X-API-Key) |
POST | /v1/moderations | Create moderation classifications | API Key (X-API-Key) |
POST | /infra/ai/audio/transcriptions | Transcribe audio | API Key (X-API-Key) |
POST | /v1/audio/transcriptions | Transcribe audio | API Key (X-API-Key) |
POST | /infra/ai/audio/translations | Translate audio | API Key (X-API-Key) |
POST | /v1/audio/translations | Translate audio | API Key (X-API-Key) |
POST | /infra/ai/audio/speech | Synthesize speech | API Key (X-API-Key) |
POST | /v1/audio/speech | Synthesize speech | API Key (X-API-Key) |
POST | /infra/ai/images/generations | Generate images | API Key (X-API-Key) |
POST | /v1/images/generations | Generate images | API Key (X-API-Key) |
POST | /infra/ai/images/edits | Edit an image | API Key (X-API-Key) |
POST | /v1/images/edits | Edit an image | API Key (X-API-Key) |
POST | /infra/ai/images/variations | Generate image variations | API Key (X-API-Key) |
POST | /v1/images/variations | Generate image variations | API Key (X-API-Key) |
POST | /infra/ai/documents/parse | Parse a document into normalized blocks | API Key (X-API-Key) |
POST | /infra/ai/documents/chunk | Chunk text or parsed blocks | API Key (X-API-Key) |
GET | /infra/ai/operations/{operation_id} | Get async AI operation | API Key (X-API-Key) |
POST | /infra/ai/operations/{operation_id}/cancel | Cancel async AI operation | API Key (X-API-Key) |
Infra > Decisioning > Search
Managed hybrid retrieval primitives backed by D1 metadata, FTS recall, optional Vectorize namespaces, and Workers AI embeddings or rerank.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/decisioning/search/indexes | Create a search index | API Key (X-API-Key) |
GET | /infra/decisioning/search/indexes | List search indexes | API Key (X-API-Key) |
GET | /infra/decisioning/search/indexes/{index_id} | Get search index | API Key (X-API-Key) |
PATCH | /infra/decisioning/search/indexes/{index_id} | Update search index | API Key (X-API-Key) |
DELETE | /infra/decisioning/search/indexes/{index_id} | Delete search index | API Key (X-API-Key) |
POST | /infra/decisioning/search/indexes/{index_id}/documents/upsert | Upsert search documents | API Key (X-API-Key) |
GET | /infra/decisioning/search/indexes/{index_id}/documents | List search documents | API Key (X-API-Key) |
GET | /infra/decisioning/search/indexes/{index_id}/documents/{document_id} | Get search document | API Key (X-API-Key) |
DELETE | /infra/decisioning/search/indexes/{index_id}/documents/{document_id} | Delete search document | API Key (X-API-Key) |
POST | /infra/decisioning/search/indexes/{index_id}/query | Query a search index | API Key (X-API-Key) |
POST | /infra/decisioning/search/indexes/{index_id}/suggest | Suggest search terms | API Key (X-API-Key) |
GET | /infra/decisioning/search/indexes/{index_id}/stats | Get search index stats | API Key (X-API-Key) |
POST | /infra/decisioning/search/indexes/{index_id}/rebuild | Rebuild search index state | API Key (X-API-Key) |
Infra > Decisioning > Matching
Domain-agnostic constrained assignment and optimal matching primitives over caller-supplied nodes, capacities, and weighted edges.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/decisioning/matching/operations | Create a matching operation | API Key (X-API-Key) |
POST | /infra/decisioning/matching/operations/batch | Create a batch matching operation | API Key (X-API-Key) |
GET | /infra/decisioning/matching/operations/{operation_id} | Get a matching operation | API Key (X-API-Key) |
POST | /infra/decisioning/matching/operations/{operation_id}/cancel | Cancel a matching operation | API Key (X-API-Key) |
POST | /infra/decisioning/matching/templates | Create a matching template | API Key (X-API-Key) |
GET | /infra/decisioning/matching/templates | List matching templates | API Key (X-API-Key) |
GET | /infra/decisioning/matching/templates/{template_id} | Get a matching template | API Key (X-API-Key) |
PATCH | /infra/decisioning/matching/templates/{template_id} | Update a matching template | API Key (X-API-Key) |
DELETE | /infra/decisioning/matching/templates/{template_id} | Delete a matching template | API Key (X-API-Key) |
POST | /infra/decisioning/matching/templates/{template_id}/operations | Create a template-backed matching operation | API Key (X-API-Key) |
Infra > Decisioning > Ranking
Ranking primitives for caller-owned collections, signals, recommendation queries, and related-item lookups.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /infra/decisioning/ranking/collections | Create a ranking collection | API Key (X-API-Key) |
GET | /infra/decisioning/ranking/collections | List ranking collections | API Key (X-API-Key) |
GET | /infra/decisioning/ranking/collections/{collection_id} | Get a ranking collection | API Key (X-API-Key) |
PATCH | /infra/decisioning/ranking/collections/{collection_id} | Update a ranking collection | API Key (X-API-Key) |
DELETE | /infra/decisioning/ranking/collections/{collection_id} | Delete a ranking collection | API Key (X-API-Key) |
POST | /infra/decisioning/ranking/collections/{collection_id}/items/upsert | Upsert ranking items | API Key (X-API-Key) |
GET | /infra/decisioning/ranking/collections/{collection_id}/items | List ranking items | API Key (X-API-Key) |
GET | /infra/decisioning/ranking/collections/{collection_id}/items/{item_id} | Get a ranking item | API Key (X-API-Key) |
DELETE | /infra/decisioning/ranking/collections/{collection_id}/items/{item_id} | Delete a ranking item | API Key (X-API-Key) |
POST | /infra/decisioning/ranking/collections/{collection_id}/signals/batch | Ingest ranking signals | API Key (X-API-Key) |
POST | /infra/decisioning/ranking/collections/{collection_id}/rank | Rank collection items | API Key (X-API-Key) |
POST | /infra/decisioning/ranking/collections/{collection_id}/related | Find related collection items | API Key (X-API-Key) |
GET | /infra/decisioning/ranking/collections/{collection_id}/stats | Get ranking collection stats | API Key (X-API-Key) |
Compat > OpenAI
OpenAI-compatible aliases for selected AI primitives exposed under `/v1/*`.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /v1/models | List AI models | API Key (X-API-Key) |
GET | /v1/models/{model_id} | Get AI model | API Key (X-API-Key) |
POST | /v1/responses | Create an AI response | API Key (X-API-Key) |
POST | /v1/chat/completions | Create a chat completion | API Key (X-API-Key) |
POST | /v1/realtime/sessions | Create a realtime session bootstrap | API Key (X-API-Key) |
POST | /v1/embeddings | Create embeddings | API Key (X-API-Key) |
POST | /v1/moderations | Create moderation classifications | API Key (X-API-Key) |
POST | /v1/audio/transcriptions | Transcribe audio | API Key (X-API-Key) |
POST | /v1/audio/translations | Translate audio | API Key (X-API-Key) |
POST | /v1/audio/speech | Synthesize speech | API Key (X-API-Key) |
POST | /v1/images/generations | Generate images | API Key (X-API-Key) |
POST | /v1/images/edits | Edit an image | API Key (X-API-Key) |
POST | /v1/images/variations | Generate image variations | API Key (X-API-Key) |
Logistics > Geo
Generic geospatial entity registration, status management, and proximity search.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /logistics/geo/entities | Create a geo entity | API Key (X-API-Key) |
GET | /logistics/geo/entities | List geo entities | API Key (X-API-Key) |
GET | /logistics/geo/entities/nearby | Find nearby entities | API Key (X-API-Key) |
GET | /logistics/geo/entities/{entity_id} | Get a geo entity | API Key (X-API-Key) |
PATCH | /logistics/geo/entities/{entity_id} | Update a geo entity | API Key (X-API-Key) |
DELETE | /logistics/geo/entities/{entity_id} | Deactivate a geo entity | API Key (X-API-Key) |
Logistics > Tracking
Real-time GPS tracking with live WebSocket streaming.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /logistics/tracking/{entity_id}/ping | Submit a location ping | API Key (X-API-Key) |
POST | /logistics/tracking/{entity_id}/ping/batch | Submit batch location pings | API Key (X-API-Key) |
GET | /logistics/tracking/{entity_id}/track | Subscribe to live tracking | API Key (X-API-Key) |
GET | /logistics/tracking/{entity_id}/history | Get ping history | API Key (X-API-Key) |
Logistics > Geofencing
Define zones and receive enter/exit webhooks when tracked entities cross boundaries.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /logistics/geo/fences | Create a geofence | API Key (X-API-Key) |
GET | /logistics/geo/fences | List geofences | API Key (X-API-Key) |
GET | /logistics/geo/fences/{fence_id} | Get a geofence | API Key (X-API-Key) |
DELETE | /logistics/geo/fences/{fence_id} | Delete a geofence | API Key (X-API-Key) |
Logistics > ETA Fencing
Define destination points with time thresholds. Receive breach/cleared webhooks when a tracked entity's driving ETA drops below or rises above the configured threshold.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /logistics/geo/eta-fences | Create an ETA fence | API Key (X-API-Key) |
GET | /logistics/geo/eta-fences | List ETA fences | API Key (X-API-Key) |
GET | /logistics/geo/eta-fences/{fence_id} | Get an ETA fence | API Key (X-API-Key) |
DELETE | /logistics/geo/eta-fences/{fence_id} | Delete an ETA fence | API Key (X-API-Key) |
Logistics > Routing
Route calculation, stop optimization, distance matrices, dispatch, isochrone, and snap-to-road via Mapbox.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /logistics/routing/route | Calculate a route | API Key (X-API-Key) |
POST | /logistics/routing/optimize | Optimize stop order | API Key (X-API-Key) |
POST | /logistics/routing/distance-matrix | Distance matrix | API Key (X-API-Key) |
POST | /logistics/routing/dispatch | Smart dispatch | API Key (X-API-Key) |
POST | /logistics/routing/isochrone | Isochrone / reachability | API Key (X-API-Key) |
POST | /logistics/routing/snap | Snap to road | API Key (X-API-Key) |
Logistics > Geocoding
Forward/reverse geocoding and address autocomplete via Mapbox.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /logistics/geocoding/forward | Forward geocode | API Key (X-API-Key) |
GET | /logistics/geocoding/reverse | Reverse geocode | API Key (X-API-Key) |
POST | /logistics/geocoding/autocomplete | Address autocomplete | API Key (X-API-Key) |
Modules > Delivery > Settings
Configure delivery module behavior per project.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/delivery/settings | Get delivery settings | API Key (X-API-Key) |
PATCH | /modules/delivery/settings | Update delivery settings | API Key (X-API-Key) |
Modules > Delivery > Drivers
Manage delivery drivers, online/offline status, and location tracking.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/drivers | Create a driver | API Key (X-API-Key) |
GET | /modules/delivery/drivers | List drivers | API Key (X-API-Key) |
GET | /modules/delivery/drivers/{driver_id} | Get a driver | API Key (X-API-Key) |
PATCH | /modules/delivery/drivers/{driver_id} | Update a driver | API Key (X-API-Key) |
DELETE | /modules/delivery/drivers/{driver_id} | Delete a driver | API Key (X-API-Key) |
POST | /modules/delivery/drivers/{driver_id}/online | Go online | API Key (X-API-Key) |
POST | /modules/delivery/drivers/{driver_id}/offline | Go offline | API Key (X-API-Key) |
Modules > Delivery > Customers
Manage delivery customers and their saved addresses.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/customers | Create a customer | API Key (X-API-Key) |
GET | /modules/delivery/customers | List customers | API Key (X-API-Key) |
GET | /modules/delivery/customers/{customer_id} | Get a customer | API Key (X-API-Key) |
PATCH | /modules/delivery/customers/{customer_id} | Update a customer | API Key (X-API-Key) |
DELETE | /modules/delivery/customers/{customer_id} | Delete a customer | API Key (X-API-Key) |
POST | /modules/delivery/customers/{customer_id}/addresses | Add customer address | API Key (X-API-Key) |
GET | /modules/delivery/customers/{customer_id}/addresses | List customer addresses | API Key (X-API-Key) |
DELETE | /modules/delivery/customers/{customer_id}/addresses/{address_id} | Delete customer address | API Key (X-API-Key) |
Modules > Delivery > Vehicles
Manage delivery vehicles and assign them to drivers.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/vehicles | Create a vehicle | API Key (X-API-Key) |
GET | /modules/delivery/vehicles | List vehicles | API Key (X-API-Key) |
GET | /modules/delivery/vehicles/{vehicle_id} | Get a vehicle | API Key (X-API-Key) |
PATCH | /modules/delivery/vehicles/{vehicle_id} | Update a vehicle | API Key (X-API-Key) |
DELETE | /modules/delivery/vehicles/{vehicle_id} | Delete a vehicle | API Key (X-API-Key) |
Modules > Delivery > Orders
Create, track, and manage delivery orders through their lifecycle.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/orders | Create an order | API Key (X-API-Key) |
GET | /modules/delivery/orders | List orders | API Key (X-API-Key) |
GET | /modules/delivery/orders/{order_id} | Get an order | API Key (X-API-Key) |
PATCH | /modules/delivery/orders/{order_id} | Update an order | API Key (X-API-Key) |
DELETE | /modules/delivery/orders/{order_id} | Delete an order | API Key (X-API-Key) |
POST | /modules/delivery/orders/{order_id}/transition | Transition order status | API Key (X-API-Key) |
GET | /modules/delivery/orders/{order_id}/events | List order events | API Key (X-API-Key) |
POST | /modules/delivery/orders/{order_id}/proof | Submit delivery proof | API Key (X-API-Key) |
GET | /modules/delivery/orders/{order_id}/proof | List order proofs | API Key (X-API-Key) |
POST | /modules/delivery/orders/{order_id}/proof/photo | Upload photo proof | API Key (X-API-Key) |
GET | /modules/delivery/orders/{order_id}/proof/{proof_id} | Get a proof record | API Key (X-API-Key) |
DELETE | /modules/delivery/orders/{order_id}/proof/{proof_id} | Delete a proof record | API Key (X-API-Key) |
Modules > Delivery > Stops
Manage pickup, dropoff, and waypoint stops within delivery orders.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/orders/{order_id}/stops | Create a stop | API Key (X-API-Key) |
GET | /modules/delivery/orders/{order_id}/stops | List stops for an order | API Key (X-API-Key) |
GET | /modules/delivery/stops/{stop_id} | Get a stop | API Key (X-API-Key) |
PATCH | /modules/delivery/stops/{stop_id} | Update a stop | API Key (X-API-Key) |
DELETE | /modules/delivery/stops/{stop_id} | Delete a stop | API Key (X-API-Key) |
POST | /modules/delivery/stops/{stop_id}/arrive | Mark stop arrived | API Key (X-API-Key) |
POST | /modules/delivery/stops/{stop_id}/complete | Complete a stop | API Key (X-API-Key) |
POST | /modules/delivery/stops/{stop_id}/skip | Skip a stop | API Key (X-API-Key) |
Modules > Delivery > Dispatch
Auto-assign drivers and suggest optimal driver matches for orders.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/dispatch/suggest | Suggest drivers for an order | API Key (X-API-Key) |
POST | /modules/delivery/dispatch/auto-assign | Auto-assign a driver to an order | API Key (X-API-Key) |
Modules > Delivery > Dispatch Rules
Rule-based auto-dispatch: create, evaluate, and apply dispatch rules to automatically assign drivers to orders.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/dispatch-rules | Create a dispatch rule | API Key (X-API-Key) |
GET | /modules/delivery/dispatch-rules | List dispatch rules | API Key (X-API-Key) |
GET | /modules/delivery/dispatch-rules/{rule_id} | Get a dispatch rule | API Key (X-API-Key) |
PATCH | /modules/delivery/dispatch-rules/{rule_id} | Update a dispatch rule | API Key (X-API-Key) |
DELETE | /modules/delivery/dispatch-rules/{rule_id} | Delete a dispatch rule | API Key (X-API-Key) |
POST | /modules/delivery/dispatch-rules/evaluate | Evaluate dispatch rules (dry-run) | API Key (X-API-Key) |
POST | /modules/delivery/auto-dispatch | Auto-dispatch an order using rules | API Key (X-API-Key) |
Modules > Delivery > Tracking
Generate public tracking links, render tracking pages, and stream live delivery updates to customers and drivers.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/tracking-links | Create a tracking link | API Key (X-API-Key) |
GET | /modules/delivery/tracking-links/{token} | Resolve a tracking token | API Key (X-API-Key) |
DELETE | /modules/delivery/tracking-links/{link_id} | Revoke a tracking link | API Key (X-API-Key) |
GET | /modules/delivery/tracking-pages/customer/{token} | Render the customer tracking page | None required |
GET | /modules/delivery/tracking-pages/customer/{token}/feed | Load customer tracking data | None required |
POST | /modules/delivery/tracking-pages/customer/{token}/rating | Submit a customer delivery rating | None required |
GET | /modules/delivery/tracking-pages/driver/{token} | Render the driver tracking page | None required |
POST | /modules/delivery/tracking-pages/driver/{token}/ping | Send a driver location ping from a tracking page | None required |
POST | /modules/delivery/tracking-pages/driver/{token}/proof/photo | Upload driver photo proof from a tracking page | None required |
POST | /modules/delivery/tracking-pages/driver/{token}/proof/comment | Submit driver comment proof from a tracking page | None required |
GET | /modules/delivery/tracking-pages/subscribe/{token} | Subscribe to public delivery tracking updates | None required |
Modules > Delivery > Zones
Define delivery zones backed by logistics geofences.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/zones | Create a delivery zone | API Key (X-API-Key) |
GET | /modules/delivery/zones | List delivery zones | API Key (X-API-Key) |
GET | /modules/delivery/zones/{zone_id} | Get a delivery zone | API Key (X-API-Key) |
PATCH | /modules/delivery/zones/{zone_id} | Update a delivery zone | API Key (X-API-Key) |
DELETE | /modules/delivery/zones/{zone_id} | Delete a delivery zone | API Key (X-API-Key) |
Modules > Delivery > Hubs
Manage delivery hubs (warehouses, kitchens, pickup points).
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/hubs | Create a delivery hub | API Key (X-API-Key) |
GET | /modules/delivery/hubs | List delivery hubs | API Key (X-API-Key) |
GET | /modules/delivery/hubs/{hub_id} | Get a delivery hub | API Key (X-API-Key) |
PATCH | /modules/delivery/hubs/{hub_id} | Update a delivery hub | API Key (X-API-Key) |
DELETE | /modules/delivery/hubs/{hub_id} | Delete a delivery hub | API Key (X-API-Key) |
Modules > Delivery > Notifications
Configure which delivery events trigger notifications.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/delivery/notifications | List notification configs | API Key (X-API-Key) |
PUT | /modules/delivery/notifications | Upsert notification config | API Key (X-API-Key) |
Modules > Delivery > Webhooks
Manage webhooks for delivery-specific event topics.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/delivery/webhooks | List delivery webhooks | API Key (X-API-Key) |
POST | /modules/delivery/webhooks | Create a delivery webhook | API Key (X-API-Key) |
Modules > Delivery > ETA Fences
Create and manage ETA fences for delivery destinations. Receive breach webhooks when a tracked entity's driving ETA drops below the configured threshold.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/delivery/eta-fences | Create a delivery ETA fence | API Key (X-API-Key) |
GET | /modules/delivery/eta-fences | List delivery ETA fences | API Key (X-API-Key) |
GET | /modules/delivery/eta-fences/{fence_id} | Get a delivery ETA fence | API Key (X-API-Key) |
DELETE | /modules/delivery/eta-fences/{fence_id} | Delete a delivery ETA fence | API Key (X-API-Key) |
Modules > Delivery > Analytics
Delivery performance analytics and driver statistics.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/delivery/analytics/summary | Get delivery analytics summary | API Key (X-API-Key) |
GET | /modules/delivery/analytics/drivers | Get driver analytics | API Key (X-API-Key) |
Modules > Delivery > Export
Export delivery data in JSON or CSV format.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/delivery/export/orders | Export delivery orders | API Key (X-API-Key) |
Modules > Commerce > Settings
Configure commerce module behavior per project: currency, tax, inventory tracking, review moderation, cart TTL.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/commerce/settings | Get commerce settings | API Key (X-API-Key) |
PATCH | /modules/commerce/settings | Update commerce settings | API Key (X-API-Key) |
Modules > Commerce > Catalogs
Manage product catalogs (storefronts) with multi-currency support.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/commerce/catalogs | Create a catalog | API Key (X-API-Key) |
GET | /modules/commerce/catalogs | List catalogs | API Key (X-API-Key) |
GET | /modules/commerce/catalogs/{catalog_id} | Get a catalog | API Key (X-API-Key) |
PATCH | /modules/commerce/catalogs/{catalog_id} | Update a catalog | API Key (X-API-Key) |
DELETE | /modules/commerce/catalogs/{catalog_id} | Delete a catalog | API Key (X-API-Key) |
Modules > Commerce > Categories
Hierarchical product categories within catalogs, with tree traversal.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/commerce/categories | Create a category | API Key (X-API-Key) |
GET | /modules/commerce/categories | List categories | API Key (X-API-Key) |
GET | /modules/commerce/categories/{category_id} | Get a category | API Key (X-API-Key) |
PATCH | /modules/commerce/categories/{category_id} | Update a category | API Key (X-API-Key) |
DELETE | /modules/commerce/categories/{category_id} | Delete a category | API Key (X-API-Key) |
GET | /modules/commerce/categories/{category_id}/tree | Get category tree | API Key (X-API-Key) |
Modules > Commerce > Products
Full product lifecycle: create, list, search, update, and archive products with pricing, variants, and inventory.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/commerce/products | Create a product | API Key (X-API-Key) |
GET | /modules/commerce/products | List products | API Key (X-API-Key) |
GET | /modules/commerce/products/{product_id} | Get a product | API Key (X-API-Key) |
PATCH | /modules/commerce/products/{product_id} | Update a product | API Key (X-API-Key) |
DELETE | /modules/commerce/products/{product_id} | Delete a product | API Key (X-API-Key) |
Modules > Commerce > Variants
Product variants (size, color, material) with independent pricing and inventory tracking.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/commerce/products/{product_id}/variants | Create a variant | API Key (X-API-Key) |
GET | /modules/commerce/products/{product_id}/variants | List variants | API Key (X-API-Key) |
GET | /modules/commerce/products/{product_id}/variants/{variant_id} | Get a variant | API Key (X-API-Key) |
PATCH | /modules/commerce/products/{product_id}/variants/{variant_id} | Update a variant | API Key (X-API-Key) |
DELETE | /modules/commerce/products/{product_id}/variants/{variant_id} | Delete a variant | API Key (X-API-Key) |
Modules > Commerce > Inventory
Track stock levels, adjust quantities, and receive low-stock alerts.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/commerce/inventory | List inventory | API Key (X-API-Key) |
GET | /modules/commerce/inventory/{inventory_id} | Get inventory | API Key (X-API-Key) |
PATCH | /modules/commerce/inventory/{inventory_id} | Update inventory | API Key (X-API-Key) |
POST | /modules/commerce/inventory/{inventory_id}/adjust | Adjust inventory | API Key (X-API-Key) |
Modules > Commerce > Customers
Manage commerce customers with addresses, order history, and marketing preferences.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/commerce/customers | Create a customer | API Key (X-API-Key) |
GET | /modules/commerce/customers | List customers | API Key (X-API-Key) |
GET | /modules/commerce/customers/{customer_id} | Get a customer | API Key (X-API-Key) |
PATCH | /modules/commerce/customers/{customer_id} | Update a customer | API Key (X-API-Key) |
DELETE | /modules/commerce/customers/{customer_id} | Delete a customer | API Key (X-API-Key) |
POST | /modules/commerce/customers/{customer_id}/addresses | Add customer address | API Key (X-API-Key) |
GET | /modules/commerce/customers/{customer_id}/addresses | List customer addresses | API Key (X-API-Key) |
DELETE | /modules/commerce/customers/{customer_id}/addresses/{address_id} | Delete customer address | API Key (X-API-Key) |
Modules > Commerce > Carts
Shopping carts with item management, discount codes, and checkout to create orders.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/commerce/carts | Create a cart | API Key (X-API-Key) |
GET | /modules/commerce/carts/{cart_id} | Get a cart | API Key (X-API-Key) |
POST | /modules/commerce/carts/{cart_id}/items | Add item to cart | API Key (X-API-Key) |
PATCH | /modules/commerce/carts/{cart_id}/items/{item_id} | Update cart item quantity | API Key (X-API-Key) |
DELETE | /modules/commerce/carts/{cart_id}/items/{item_id} | Remove cart item | API Key (X-API-Key) |
POST | /modules/commerce/carts/{cart_id}/discount | Apply discount to cart | API Key (X-API-Key) |
DELETE | /modules/commerce/carts/{cart_id}/discount | Remove discount from cart | API Key (X-API-Key) |
POST | /modules/commerce/carts/{cart_id}/checkout | Checkout a cart | API Key (X-API-Key) |
Modules > Commerce > Orders
Order lifecycle management with state machine transitions: pending → confirmed → processing → shipped → delivered → completed.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/commerce/orders | List orders | API Key (X-API-Key) |
GET | /modules/commerce/orders/{order_id} | Get an order | API Key (X-API-Key) |
PATCH | /modules/commerce/orders/{order_id} | Update an order | API Key (X-API-Key) |
DELETE | /modules/commerce/orders/{order_id} | Delete an order | API Key (X-API-Key) |
POST | /modules/commerce/orders/{order_id}/transition | Transition order status | API Key (X-API-Key) |
GET | /modules/commerce/orders/{order_id}/events | List order events | API Key (X-API-Key) |
Modules > Commerce > Payments
Payment records with state machine: pending → authorized → captured → refunded. Supports multiple gateways.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/commerce/orders/{order_id}/payments | Create a payment | API Key (X-API-Key) |
GET | /modules/commerce/orders/{order_id}/payments | List payments for an order | API Key (X-API-Key) |
GET | /modules/commerce/orders/{order_id}/payments/{payment_id} | Get a payment | API Key (X-API-Key) |
POST | /modules/commerce/orders/{order_id}/payments/{payment_id}/transition | Transition payment status | API Key (X-API-Key) |
Modules > Commerce > Reviews
Product reviews with ratings, verified purchase detection, and moderation workflow (pending → approved/rejected/flagged).
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/commerce/reviews | Create a review | API Key (X-API-Key) |
GET | /modules/commerce/reviews | List reviews | API Key (X-API-Key) |
GET | /modules/commerce/reviews/{review_id} | Get a review | API Key (X-API-Key) |
DELETE | /modules/commerce/reviews/{review_id} | Delete a review | API Key (X-API-Key) |
POST | /modules/commerce/reviews/{review_id}/transition | Moderate a review | API Key (X-API-Key) |
Modules > Commerce > Discounts
Discount codes: percentage, fixed amount, free shipping, buy-X-get-Y. Usage limits, date ranges, and product targeting.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/commerce/discounts | Create a discount | API Key (X-API-Key) |
GET | /modules/commerce/discounts | List discounts | API Key (X-API-Key) |
GET | /modules/commerce/discounts/{discount_id} | Get a discount | API Key (X-API-Key) |
PATCH | /modules/commerce/discounts/{discount_id} | Update a discount | API Key (X-API-Key) |
DELETE | /modules/commerce/discounts/{discount_id} | Delete a discount | API Key (X-API-Key) |
POST | /modules/commerce/discounts/validate | Validate a discount code | API Key (X-API-Key) |
Modules > Commerce > Webhooks
Manage webhooks for commerce-specific event topics (orders, payments, inventory, reviews).
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/commerce/webhooks | List commerce webhooks | API Key (X-API-Key) |
POST | /modules/commerce/webhooks | Create a commerce webhook | API Key (X-API-Key) |
Modules > Commerce > Analytics
Commerce analytics: revenue summary, top products, and time-series revenue data.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/commerce/analytics/summary | Get commerce analytics summary | API Key (X-API-Key) |
GET | /modules/commerce/analytics/top-products | Get top-selling products | API Key (X-API-Key) |
GET | /modules/commerce/analytics/revenue | Get revenue over time | API Key (X-API-Key) |
Modules > Commerce > Export
Export commerce data (orders, products, customers) in JSON or CSV format.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/commerce/export/orders | Export commerce orders | API Key (X-API-Key) |
GET | /modules/commerce/export/products | Export commerce products | API Key (X-API-Key) |
GET | /modules/commerce/export/customers | Export commerce customers | API Key (X-API-Key) |
Modules > Booking > Settings
Per-project booking configuration: timezone, slot duration, advance limits, and cancellation policy.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/booking/settings | Get booking settings | API Key (X-API-Key) |
PATCH | /modules/booking/settings | Update booking settings | API Key (X-API-Key) |
Modules > Booking > Resources
Bookable resources (rooms, tables, staff, equipment) with capacity and metadata.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/booking/resources | Create a resource | API Key (X-API-Key) |
GET | /modules/booking/resources | List resources | API Key (X-API-Key) |
GET | /modules/booking/resources/{resource_id} | Get a resource | API Key (X-API-Key) |
PATCH | /modules/booking/resources/{resource_id} | Update a resource | API Key (X-API-Key) |
DELETE | /modules/booking/resources/{resource_id} | Delete a resource | API Key (X-API-Key) |
Modules > Booking > Availability
Availability rules and slot computation for resources.
| Method | Path | Description | Auth |
|---|---|---|---|
PUT | /modules/booking/resources/{resource_id}/availability | Set availability rules | API Key (X-API-Key) |
GET | /modules/booking/resources/{resource_id}/availability | Get availability rules | API Key (X-API-Key) |
GET | /modules/booking/resources/{resource_id}/slots | Get available slots | API Key (X-API-Key) |
Modules > Booking > Bookings
Reservations with status lifecycle: pending → confirmed → checked_in → completed / cancelled / no_show.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/booking/bookings | Create a booking | API Key (X-API-Key) |
GET | /modules/booking/bookings | List bookings | API Key (X-API-Key) |
GET | /modules/booking/bookings/{booking_id} | Get a booking | API Key (X-API-Key) |
PATCH | /modules/booking/bookings/{booking_id} | Update a booking | API Key (X-API-Key) |
DELETE | /modules/booking/bookings/{booking_id} | Delete a booking | API Key (X-API-Key) |
POST | /modules/booking/bookings/{booking_id}/transition | Transition booking status | API Key (X-API-Key) |
GET | /modules/booking/bookings/{booking_id}/events | Get booking events | API Key (X-API-Key) |
Modules > Booking > Customers
Manage booking customers with contact details and booking history.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/booking/customers | Create a customer | API Key (X-API-Key) |
GET | /modules/booking/customers | List customers | API Key (X-API-Key) |
GET | /modules/booking/customers/{customer_id} | Get a customer | API Key (X-API-Key) |
PATCH | /modules/booking/customers/{customer_id} | Update a customer | API Key (X-API-Key) |
DELETE | /modules/booking/customers/{customer_id} | Delete a customer | API Key (X-API-Key) |
Modules > Booking > Blockers
Calendar blocks (holidays, maintenance, staff leave) that override availability.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/booking/blockers | Create a blocker | API Key (X-API-Key) |
GET | /modules/booking/blockers | List blockers | API Key (X-API-Key) |
DELETE | /modules/booking/blockers/{blocker_id} | Delete a blocker | API Key (X-API-Key) |
Modules > Booking > Webhooks
Manage webhooks for booking-specific event topics (bookings, resources, availability).
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/booking/webhooks | List booking webhooks | API Key (X-API-Key) |
POST | /modules/booking/webhooks | Create a booking webhook | API Key (X-API-Key) |
Modules > Booking > Analytics
Booking analytics: utilization rates, peak hours, and time-series booking data.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/booking/analytics/summary | Get booking analytics summary | API Key (X-API-Key) |
GET | /modules/booking/analytics/by-resource | Get bookings by resource | API Key (X-API-Key) |
GET | /modules/booking/analytics/by-period | Get bookings by period | API Key (X-API-Key) |
Modules > Booking > Export
Export booking data (bookings, resources, customers) in JSON or CSV format.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/booking/export/bookings | Export bookings | API Key (X-API-Key) |
GET | /modules/booking/export/customers | Export booking customers | API Key (X-API-Key) |
GET | /modules/booking/export/resources | Export booking resources | API Key (X-API-Key) |
Modules > Messaging > Settings
Per-project messaging configuration: participant limits, message length, retention, reactions, and conversation numbering.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/messaging/settings | Get messaging settings | API Key (X-API-Key) |
PATCH | /modules/messaging/settings | Update messaging settings | API Key (X-API-Key) |
Modules > Messaging > Conversations
Conversations with status lifecycle: open → archived / closed. Supports direct and group types with auto-numbering.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/messaging/conversations | Create a conversation | API Key (X-API-Key) |
GET | /modules/messaging/conversations | List conversations | API Key (X-API-Key) |
GET | /modules/messaging/conversations/{conversation_id} | Get a conversation | API Key (X-API-Key) |
PATCH | /modules/messaging/conversations/{conversation_id} | Update a conversation | API Key (X-API-Key) |
DELETE | /modules/messaging/conversations/{conversation_id} | Delete a conversation | API Key (X-API-Key) |
POST | /modules/messaging/conversations/{conversation_id}/archive | Archive a conversation | API Key (X-API-Key) |
POST | /modules/messaging/conversations/{conversation_id}/close | Close a conversation | API Key (X-API-Key) |
POST | /modules/messaging/conversations/{conversation_id}/reopen | Reopen a conversation | API Key (X-API-Key) |
Modules > Messaging > Participants
Manage conversation participants with roles (owner, member, readonly) and read receipts.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/messaging/conversations/{conversation_id}/participants | Add a participant | API Key (X-API-Key) |
GET | /modules/messaging/conversations/{conversation_id}/participants | List participants | API Key (X-API-Key) |
PATCH | /modules/messaging/conversations/{conversation_id}/participants/{participant_id} | Update a participant | API Key (X-API-Key) |
DELETE | /modules/messaging/conversations/{conversation_id}/participants/{participant_id} | Remove a participant | API Key (X-API-Key) |
Modules > Messaging > Messages
Send, list, edit, and soft-delete messages within conversations. Validates body length against project settings.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/messaging/conversations/{conversation_id}/messages | Send a message | API Key (X-API-Key) |
GET | /modules/messaging/conversations/{conversation_id}/messages | List messages | API Key (X-API-Key) |
GET | /modules/messaging/conversations/{conversation_id}/messages/{message_id} | Get a message | API Key (X-API-Key) |
PATCH | /modules/messaging/conversations/{conversation_id}/messages/{message_id} | Edit a message | API Key (X-API-Key) |
DELETE | /modules/messaging/conversations/{conversation_id}/messages/{message_id} | Delete a message | API Key (X-API-Key) |
Modules > Messaging > Reactions
Add and remove emoji reactions on messages. One reaction per participant per emoji per message.
| Method | Path | Description | Auth |
|---|---|---|---|
POST | /modules/messaging/messages/{message_id}/reactions | Add a reaction | API Key (X-API-Key) |
DELETE | /modules/messaging/messages/{message_id}/reactions/{reaction_id} | Remove a reaction | API Key (X-API-Key) |
Modules > Messaging > Webhooks
Manage webhooks for messaging-specific event topics (conversations, participants, messages).
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/messaging/webhooks | List messaging webhooks | API Key (X-API-Key) |
POST | /modules/messaging/webhooks | Create a messaging webhook | API Key (X-API-Key) |
Modules > Messaging > Analytics
Messaging analytics: conversation counts, message volumes, and time-series data.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/messaging/analytics/summary | Get messaging analytics summary | API Key (X-API-Key) |
GET | /modules/messaging/analytics/by-conversation | Get messages by conversation | API Key (X-API-Key) |
GET | /modules/messaging/analytics/by-period | Get messages by period | API Key (X-API-Key) |
Modules > Messaging > Export
Export messaging data (conversations, messages) in JSON or CSV format.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /modules/messaging/export/conversations | Export conversations | API Key (X-API-Key) |
GET | /modules/messaging/export/messages | Export messages | API Key (X-API-Key) |
Core > Organizations
Create and manage organizations.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /core/organizations | List organizations | Required |
POST | /core/organizations | Create an organization | Required |
GET | /core/organizations/{org_id} | Get an organization | API Key (X-API-Key) |
PATCH | /core/organizations/{org_id} | Update an organization | API Key (X-API-Key) |
DELETE | /core/organizations/{org_id} | Delete an organization | API Key (X-API-Key) |
GET | /core/organizations/{org_id}/members | List organization members | API Key (X-API-Key) |
POST | /core/organizations/{org_id}/members/invite | Invite a member | API Key (X-API-Key) |
GET | /core/organizations/{org_id}/my-scopes | Get current user's scopes | API Key (X-API-Key) |
PUT | /core/organizations/{org_id}/members/{user_id}/scopes | Update member scopes | API Key (X-API-Key) |
DELETE | /core/organizations/{org_id}/members/{user_id} | Remove a member | API Key (X-API-Key) |
Core > Projects
Projects live inside organizations and isolate KV namespaces, channels, jobs, and token balances.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /core/organizations/{org_id}/projects | List projects | API Key (X-API-Key) |
POST | /core/organizations/{org_id}/projects | Create a project | API Key (X-API-Key) |
GET | /core/organizations/{org_id}/projects/{project_id} | Get a project | API Key (X-API-Key) |
DELETE | /core/organizations/{org_id}/projects/{project_id} | Delete a project | API Key (X-API-Key) |
Core > Tokens
Check project balances and query usage analytics.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /core/organizations/{org_id}/tokens | List tokens | API Key (X-API-Key) |
POST | /core/organizations/{org_id}/tokens | Create a token | API Key (X-API-Key) |
DELETE | /core/organizations/{org_id}/tokens/{token_id} | Revoke a token | API Key (X-API-Key) |
GET | /core/tokens/topup-bundles | List top-up bundles | API Key (X-API-Key) |
GET | /core/tokens/balance | Get token balance | API Key (X-API-Key) |
GET | /core/tokens/usage | Get token usage analytics | API Key (X-API-Key) |
POST | /core/tokens/browser | Create browser token | API Key (X-API-Key) |
Core > Billing
Subscription packages and usage data.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /core/billing/packages | List subscription packages | API Key (X-API-Key) |
POST | /core/billing/{org_id}/free-plan | Switch organization to free plan | API Key (X-API-Key) |
GET | /core/billing/{org_id}/subscription | Get active subscription | API Key (X-API-Key) |
GET | /core/billing/{org_id}/usage | Get usage dashboard | API Key (X-API-Key) |
MCP
Model Context Protocol endpoint. SaaSignal exposes a stateless, POST-only MCP transport on `/mcp`; standalone SSE sessions are not provided, so unsupported GET/DELETE requests return `405 Method Not Allowed`. Primary auth is browser-based OAuth on the frontend host, with project API keys still supported as a manual fallback. OAuth tokens are filtered during `tools/list` and challenged with `insufficient_scope` when required. Documented HTTP routes are exposed automatically as MCP tools using their OpenAPI operationId values, while legacy operational aliases remain available.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /.well-known/oauth-protected-resource/mcp | MCP OAuth protected resource metadata | None required |
POST | /mcp | Model Context Protocol endpoint | API Key (X-API-Key) |
Meta
Health check, API docs, OpenAPI specification, and AI-first documentation (agent skill, llms.txt, human-readable markdown, landing page).
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /.well-known/oauth-protected-resource | API OAuth protected resource metadata | None required |
GET | / | API landing page | None required |
GET | /skills/saasignal | SaaSignal agent skill | None required |
GET | /scalar | Interactive API reference (Scalar) | None required |
GET | /livez | Liveness probe | None required |
GET | /readyz | Readiness probe | None required |
GET | /healthz | Health check | None required |
GET | /llms.txt | LLM documentation index (llmstxt.org spec) | None required |
GET | /llms-full.txt | Full LLM-optimized API documentation | None required |
GET | /to-humans.md | Human-readable API documentation (Markdown) | None required |
GET | /api/openapi.json | OpenAPI specification | None required |
GET | /robots.txt | Crawler directives (robots.txt) | None required |
GET | /sitemap.xml | XML sitemap | None required |