API reference¶
Public HTTP endpoints. All requests require a bearer token.
1192 public endpoints.
Personality¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/signals/process |
Manually trigger signal processing (testing) |
POST |
/api/v1/signals/sampling-rate |
Update signal sampling rate |
GET |
/api/v1/signals/stats |
Get signal processing statistics |
GET |
/api/v1/signals/unprocessed/:user_id |
Get unprocessed signal count for a user |
ab_testing¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/ab-tests |
List A/B tests for an org |
POST |
/api/v1/ab-tests |
Create a new A/B test with variants |
GET |
/api/v1/ab-tests/:id |
Get A/B test details with variants and significance |
GET |
/api/v1/ab-tests/:id/assign |
Assign a consistent variant to a session via hashing |
PATCH |
/api/v1/ab-tests/:id/status |
Transition A/B test status |
POST |
/api/v1/ab-tests/:id/winner |
Declare a winner variant for an A/B test |
ad_accounts¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/ad-accounts |
List connected ad platform accounts for an org |
GET |
/api/v1/ad-accounts/facebook/callback |
Handle Facebook Ads OAuth callback |
POST |
/api/v1/ad-accounts/facebook/connect |
Initiate Facebook Marketing API OAuth flow |
GET |
/api/v1/ad-accounts/google/callback |
Handle Google Ads OAuth callback |
POST |
/api/v1/ad-accounts/google/connect |
Initiate Google Ads OAuth flow |
GET |
/api/v1/ad-accounts/:id |
Get a single ad account by ID |
DELETE |
/api/v1/ad-accounts/:id |
Disconnect an ad account |
GET |
/api/v1/ad-accounts/tiktok/callback |
Handle TikTok Ads OAuth callback |
POST |
/api/v1/ad-accounts/tiktok/connect |
Initiate TikTok Marketing API OAuth flow |
admin¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/databases |
List all managed databases |
POST |
/api/v1/query |
Execute a read-only SQL query |
GET |
/api/v1/tables |
List tables in a database |
affiliates¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/affiliates |
List affiliates for an org |
POST |
/api/v1/affiliates |
Create a new affiliate partner |
GET |
/api/v1/affiliates/:id |
Get a single affiliate by ID |
PUT |
/api/v1/affiliates/:id |
Update affiliate details |
POST |
/api/v1/affiliates/:id/payout |
Record a payout to an affiliate |
GET |
/api/v1/affiliates/:id/performance |
Get performance metrics for an affiliate |
PATCH |
/api/v1/affiliates/:id/status |
Update affiliate status (active/paused/terminated) |
GET |
/api/v1/affiliates/link/:code |
Affiliate tracking link — records click and redirects |
aggregation¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/aggregations/:organization_id |
Retrieve personality aggregate for an organization |
POST |
/api/v1/aggregations/:organization_id |
Manually trigger personality aggregation for a specific organization |
POST |
/api/v1/aggregations/trigger |
Manually trigger personality aggregation for all organizations |
ai¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/consensus/:decision_id |
Retrieve consensus result by decision ID |
POST |
/api/v1/consensus/request |
Start a RIASEC consensus protocol decision with configurable threshold and rounds |
POST |
/api/v1/templates/match |
Match template |
POST |
/api/v1/templates/reindex |
Reindex templates |
GET |
/api/v3/operations/validations/health |
Validation health |
POST |
/api/v3/operations/validations/human |
Human validation |
GET |
/api/v3/operations/validations/pairs |
Validation pairs |
POST |
/api/v3/operations/validations/threshold |
Set threshold |
alerts¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/alerts |
|
POST |
/api/v1/borg/alerts/:id/ack |
Acknowledge alert |
GET |
/api/v1/borg/repos/:id/alerts |
List alerts for a repository |
POST |
/api/v1/borg/repos/:id/alerts/:alertId/resolve |
Resolve a repository alert |
analytics¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/analytics/cac |
Customer acquisition cost by channel |
GET |
/api/v1/analytics/campaigns |
Campaign-level analytics (spend, ROAS, conversions) |
GET |
/api/v1/analytics/categories/:category/leaderboard |
Get leaderboard for category |
GET |
/api/v1/analytics/cost-optimization-opportunities |
Get cost optimization opportunities |
GET |
/api/v1/analytics/cross-vertical |
Anonymized cross-vertical benchmark data (enterprise/super_admin only) |
GET |
/api/v1/analytics/fulfillment |
Fulfillment metrics (shipping speed, delivery rates) |
GET |
/api/v1/analytics/funnel |
Funnel stage counts and drop-off rates |
GET |
/api/v1/analytics/models/:id/performance |
Get model performance analytics |
GET |
/api/v1/analytics/organization |
Get organization-level browser analytics |
GET |
/api/v1/analytics/orgs/:id/savings |
Get organization savings |
GET |
/api/v1/analytics/overview |
Key metrics for an org over a time period |
GET |
/api/v1/health-score |
In-product health score for an org |
GET |
/api/v1/local/usage/:orgId |
Get usage statistics |
GET |
/api/v1/performance/auxiliary/:operationType/metrics |
Get auxiliary operation metrics |
GET |
/api/v1/performance/leaderboard |
Get performance leaderboard |
GET |
/api/v1/performance/models/:modelId/metrics |
Get model metrics |
POST |
/api/v1/performance/settings |
Update performance settings |
GET |
/api/v1/performance/settings |
Get performance settings |
GET |
/api/v1/reseller/analytics |
Aggregate portfolio analytics for resellers |
GET |
/api/v1/sessions/:id/analytics |
Get session analytics (duration, actions, errors) |
api_assimilation¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/integrations |
List assimilated external APIs |
POST |
/api/v1/borg/integrations |
Assimilate an external SaaS/OpenAPI integration |
GET |
/api/v1/borg/integrations/:id |
Get assimilated API details |
GET |
/api/v1/borg/integrations/:id/endpoints |
List cached endpoints for an assimilated API |
POST |
/api/v1/borg/integrations/:id/sync |
Trigger a schema sync for an assimilated API |
app_data¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/applications/:id/records |
List this app's own records (filter with ?kind=) |
POST |
/api/v1/applications/:id/records |
Create a record for this app: |
DELETE |
/api/v1/applications/:id/records/:recordId |
Delete a record |
PATCH |
/api/v1/applications/:id/records/:recordId |
Update a record's data |
app_generation¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/generate/api |
Generate API code |
POST |
/api/v1/generate/intent |
Analyze app generation intent |
POST |
/api/v1/generate/schema |
Generate database schema |
POST |
/api/v1/generate/ui |
Generate UI code |
applications¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/applications |
Create app |
GET |
/api/v1/applications |
List apps |
GET |
/api/v1/applications/:id |
Get app |
POST |
/api/v1/applications/:id/execute |
Execute app |
POST |
/api/v1/applications/:id/install |
Install app |
POST |
/api/v1/applications/:id/publish |
Publish app |
POST |
/api/v1/applications/:id/studio/files |
Upload file |
POST |
/api/v1/applications/:id/versions |
Create version |
approval¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/approvals/:id/review |
Review approval request (approve/reject) |
POST |
/api/v1/approvals/:id/revoke |
Revoke approval |
GET |
/api/v1/approvals/pending |
List pending approval requests |
GET |
/api/v1/templates/:id/approval/history |
Get template approval history |
POST |
/api/v1/templates/:id/approval/submit |
Submit template for approval workflow |
assessment¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/repos/:id/assessment |
Get repository assessment (complexity, risk, compatibility) |
GET |
/api/v1/borg/repos/:id/assessment/review |
Get the review status of a repository assessment |
POST |
/api/v1/borg/repos/:id/assessment/review |
Submit a human review of a repository assessment |
asset_management¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v3/operations/assets |
Create asset |
GET |
/api/v3/operations/assets |
List assets |
POST |
/api/v3/operations/assets/composite |
Create composite |
PUT |
/api/v3/operations/assets/:id |
Update asset |
GET |
/api/v3/operations/assets/:id |
Get asset |
DELETE |
/api/v3/operations/assets/:id |
Delete asset |
GET |
/api/v3/operations/assets/:id/dependencies |
Dependencies |
GET |
/api/v3/operations/assets/:id/download |
Download file |
POST |
/api/v3/operations/assets/:id/enrichment |
AI enrichment |
GET |
/api/v3/operations/assets/:id/hierarchy |
Asset hierarchy |
POST |
/api/v3/operations/assets/:id/upload |
Upload file |
POST |
/api/v3/operations/tasks/spawn-thumbnail-generation |
Generate thumbnail |
assets¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/batches |
List upload batches for an org / conversation |
POST |
/api/v1/batches |
Create an upload batch (call before first file in a multi-file drop) |
GET |
/api/v1/batches/:id |
Get batch with live progress aggregation |
POST |
/api/v1/enrich/:assetId |
Enrich asset with metadata and analysis |
POST |
/api/v1/link/:assetId |
Record upload-link edge for an asset (provenance graph) |
attribution¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/attribution/events |
List conversion attribution events |
GET |
/api/v1/attribution/summary |
Get aggregated attribution metrics by platform |
audio_processing¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/process/audio |
Process audio (transcode, normalize) |
audit¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/repos/:id/audit |
Get the settings audit log for a repository |
auth¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/api-keys |
Generate a new API key for the org |
GET |
/api/v1/api-keys |
List API keys for the org |
DELETE |
/api/v1/api-keys/:id |
Revoke an API key |
POST |
/api/v1/auth/login |
Admin email+password login |
POST |
/api/v1/auth/logout |
Admin session logout |
POST |
/api/v1/oauth/refresh |
Refresh M2M access token |
POST |
/api/v1/oauth/token |
Issue M2M access+refresh tokens via client_credentials |
autoreply¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/autoreply/evaluate |
Evaluate if message should trigger auto-reply |
GET |
/api/v1/autoreply/rules |
List auto-reply rules |
POST |
/api/v1/autoreply/rules |
Create auto-reply rule |
PUT |
/api/v1/autoreply/rules/:id |
Update auto-reply rule |
DELETE |
/api/v1/autoreply/rules/:id |
Delete auto-reply rule |
GET |
/api/v1/autoreply/rules/:id |
Get auto-reply rule details |
GET |
/api/v1/autoreply/rules/:id/executions |
List auto-reply rule executions |
backend_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/local/backends |
List local LLM backends |
POST |
/api/v1/local/backends |
Register new local backend |
DELETE |
/api/v1/local/backends/:id |
Remove local backend |
POST |
/api/v1/local/backends/test |
Test backend connection |
billing¶
| Method | Path | Description |
|---|---|---|
DELETE |
/api/v1/stripe/connect |
Disconnect Stripe Connect account |
GET |
/api/v1/stripe/connect |
Redirect to Stripe OAuth for Connect onboarding |
GET |
/api/v1/stripe/connect/callback |
OAuth callback from Stripe (public) |
GET |
/api/v1/stripe/connect/status |
Get Stripe Connect status for the org |
billing_coupons¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/coupons |
Create a new coupon |
GET |
/api/v1/coupons |
List coupons for the authenticated organization |
PUT |
/api/v1/coupons/:id |
Update a coupon |
DELETE |
/api/v1/coupons/:id |
Deactivate a coupon (soft delete) |
POST |
/api/v1/coupons/redeem |
Atomically consume one coupon use (service-to-service, enforces max_uses in the UPDATE). Body: {code(str,req), org_id(uuid,req), order_id?(uuid)}. Returns {rede… |
POST |
/api/v1/coupons/validate |
Validate a coupon code (public, no auth) |
billing_payments¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/payments/confirm |
Confirm a payment and update status to succeeded |
GET |
/api/v1/payments/:id |
Get a single payment by ID |
POST |
/api/v1/payments/:id/refund |
Refund a payment (full or partial) |
POST |
/api/v1/payments/intent |
Create a Stripe PaymentIntent on a connected account with platform fee |
billing_platform¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/platform/connected-accounts |
List connected Stripe accounts with revenue summary (super_admin only) |
GET |
/api/v1/platform/revenue |
Get aggregated platform fee revenue (super_admin only) |
billing_subscriptions¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/subscriptions |
Create a new subscription |
GET |
/api/v1/subscriptions |
List subscriptions for the authenticated organization |
GET |
/api/v1/subscriptions/:id |
Get a single subscription by ID |
POST |
/api/v1/subscriptions/:id/cancel |
Cancel a subscription |
GET |
/api/v1/subscriptions/:id/invoices |
List invoices for a subscription |
POST |
/api/v1/subscriptions/:id/pause |
Pause an active subscription |
POST |
/api/v1/subscriptions/:id/resume |
Resume a paused subscription |
POST |
/api/v1/subscriptions/:id/upgrade |
Upgrade a subscription plan |
billing_webhooks¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/webhooks/outbound |
List registered outbound webhooks |
POST |
/api/v1/webhooks/outbound |
Register an outbound webhook for billing events |
DELETE |
/api/v1/webhooks/outbound/:id |
Delete an outbound webhook |
POST |
/api/v1/webhooks/stripe |
Handle incoming Stripe webhook events (idempotent) |
brand_management¶
| Method | Path | Description |
|---|---|---|
PUT |
/api/v1/brand/config |
Create or update brand configuration |
GET |
/api/v1/brand/config |
Get brand configuration for current org |
POST |
/api/v1/brand/config/logo |
Upload brand logo (stub — use storage-service) |
GET |
/api/v1/brand/domains |
List configured domains for the org |
POST |
/api/v1/brand/domains |
Register a custom domain for the org |
DELETE |
/api/v1/brand/domains/:id |
Remove custom domain |
GET |
/api/v1/brand/subdomain |
Resolve subdomain or custom domain to brand config (public) |
browser_annotation¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/actions/:id/annotations |
Get annotations for screenshot action |
POST |
/api/v1/annotations |
Create annotation on screenshot |
PUT |
/api/v1/annotations/:id |
Update annotation |
DELETE |
/api/v1/annotations/:id |
Delete annotation |
GET |
/api/v1/sessions/:id/annotations |
Get all annotations for session |
browser_automation¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/sessions/:id/actions |
List all browser actions for a session |
POST |
/api/v1/sessions/:id/actions |
Execute browser action (navigate, click, type, screenshot, etc.) |
browser_replay¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/sessions/:id/replay |
Get session replay data for viewer |
GET |
/api/v1/sessions/:id/replay/action-at/:time |
Get browser action at specific timestamp (for seek) |
browser_session¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/sessions |
Create new Playwright browser session (Docker-in-Docker or Sidecar) |
GET |
/api/v1/sessions/:id |
Get browser session details by ID |
DELETE |
/api/v1/sessions/:id |
Delete browser session and cleanup resources |
POST |
/api/v1/sessions/:id/complete |
Mark browser session as completed/failed/timeout |
campaigns¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/ai/campaign-optimizer/recommendations |
Get AI-generated campaign optimization recommendations |
GET |
/api/v1/campaigns |
List synced campaigns with optional platform filter |
GET |
/api/v1/campaigns/:id |
Get a single campaign by ID |
GET |
/api/v1/campaigns/:id/performance |
Get daily performance metrics for a campaign |
POST |
/api/v1/campaigns/optimize |
Trigger AI-powered campaign optimization |
POST |
/api/v1/campaigns/sync |
Trigger manual campaign sync from ad platforms |
canvas_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/canvases |
List user's canvases |
POST |
/api/v1/canvases |
Create new canvas |
DELETE |
/api/v1/canvases/:id |
Delete canvas |
PUT |
/api/v1/canvases/:id |
Update canvas |
GET |
/api/v1/canvases/:id |
Get canvas by ID |
canvas_nodes¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/canvases/:id/nodes |
Create canvas node |
DELETE |
/api/v1/canvases/:id/nodes/:nodeId |
Delete canvas node |
PUT |
/api/v1/canvases/:id/nodes/:nodeId |
Update canvas node |
canvas_versioning¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/canvases/:id/revert |
Revert canvas to version |
GET |
/api/v1/canvases/:id/versions |
List canvas versions |
POST |
/api/v1/canvases/:id/versions |
Create canvas version |
cart_recovery¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/cart-recovery/analytics/daily |
Get daily cart recovery analytics breakdown |
GET |
/api/v1/cart-recovery/campaigns |
List recovery campaigns with stats |
PATCH |
/api/v1/cart-recovery/campaigns/:id |
Update recovery campaign configuration and steps |
GET |
/api/v1/cart-recovery/campaigns/:id |
Get recovery campaign details and performance stats |
POST |
/api/v1/cart-recovery/campaigns/:id/activate |
Activate a recovery campaign (starts enrolling abandoned carts) |
POST |
/api/v1/cart-recovery/campaigns/:id/pause |
Pause an active recovery campaign |
GET |
/api/v1/cart-recovery/carts/:id |
Get abandoned cart details with recovery attempts timeline |
PATCH |
/api/v1/cart-recovery/carts/:id/status |
Manually update abandoned cart status |
GET |
/api/v1/cart-recovery/sources/:id |
Get cart source details |
PATCH |
/api/v1/cart-recovery/sources/:id |
Update cart source configuration |
POST |
/api/v1/cart-recovery/webhooks/:source_id/cart-recovered |
Ingest cart recovery (purchase completed) event from external platform |
cashout¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/plutus/cashouts |
Cash-out history for an org |
POST |
/api/v1/plutus/cashouts |
Creator-initiated CRED->USD withdrawal request |
POST |
/api/v1/plutus/cashouts/:id/approve |
Admin/service: debit CRED + create Stripe Transfer |
GET |
/api/v1/plutus/payout-accounts |
Creator payout-readiness status |
POST |
/api/v1/plutus/payout-accounts/onboard |
Create/continue Stripe Connect Express onboarding |
channel_management¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/channels |
Create communication channel |
GET |
/api/v1/channels |
List channels |
GET |
/api/v1/channels/:id |
Get channel details |
PUT |
/api/v1/channels/:id |
Update channel |
DELETE |
/api/v1/channels/:id |
Delete channel |
channel_messaging¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/channels/:id/messages |
Send message to channel |
GET |
/api/v1/channels/:id/messages |
Get channel messages |
collaboration¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/canvases/:id/collab |
Real-time collaboration WebSocket |
collections¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/collections |
List collections |
POST |
/api/v1/collections |
Create collection |
DELETE |
/api/v1/collections/:id |
Delete collection |
GET |
/api/v1/collections/:id |
Get collection |
PUT |
/api/v1/collections/:id |
Update collection |
POST |
/api/v1/collections/:id/assets/:assetId |
Add asset |
GET |
/api/v1/collections/:id/evaluate |
Evaluate rules |
POST |
/api/v1/collections/:id/share |
Share collection |
commerce_appointments¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/appointments |
List appointments with pagination and status filter |
POST |
/api/v1/appointments |
Create an appointment with availability check |
GET |
/api/v1/appointments/availability |
Get available time slots for a product on a date |
PUT |
/api/v1/appointments/:id |
Reschedule an appointment |
GET |
/api/v1/appointments/:id |
Get an appointment by ID |
DELETE |
/api/v1/appointments/:id |
Cancel an appointment |
PATCH |
/api/v1/appointments/:id/status |
Update appointment status |
commerce_cart¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/cart |
Create a cart session (public/anonymous). Body: {org_id(uuid,required), customer_id?(uuid), attribution?(json)}. Returns {data:{id, session_token (use as :cartI… |
GET |
/api/v1/cart/:cartId |
Get a cart by session token |
POST |
/api/v1/cart/:cartId/items |
Add an item to a cart. Path :cartId is the session_token. Body: {product_id(uuid,required), quantity(int>0,required)}. Returns updated cart {data:{id, session_t… |
PUT |
/api/v1/cart/:cartId/items/:itemId |
Update a cart item quantity |
DELETE |
/api/v1/cart/:cartId/items/:itemId |
Remove an item from the cart |
commerce_categories¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/product-categories |
List product categories |
POST |
/api/v1/product-categories |
Create a product category |
PUT |
/api/v1/product-categories/:id |
Update a product category |
DELETE |
/api/v1/product-categories/:id |
Delete or deactivate a product category |
commerce_customers¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/customers |
List customers with pagination and search |
POST |
/api/v1/customers |
Create or upsert a customer |
PATCH |
/api/v1/customers/:id |
Update a customer |
GET |
/api/v1/customers/:id |
Get a customer by ID |
GET |
/api/v1/customers/:id/appointments |
List appointments for a customer |
GET |
/api/v1/customers/:id/orders |
List orders for a customer |
GET |
/api/v1/customers/:id/subscriptions |
List recurring orders (subscriptions) for a customer |
commerce_orders¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/orders |
List orders with pagination, status and payment filters |
POST |
/api/v1/orders |
Create an order (auto order number, server-priced). Body: {customer_id(uuid,required), items(required [{product_id(uuid),quantity(int>0)}]), coupon_code?(str,va… |
POST |
/api/v1/orders/bulk-mark-paid |
Bulk mark orders as paid |
GET |
/api/v1/orders/:id |
Get an order by ID with line items |
DELETE |
/api/v1/orders/:id |
Cancel an order |
PUT |
/api/v1/orders/:id |
Update order metadata fields |
POST |
/api/v1/orders/:id/refund |
Refund an order |
GET |
/api/v1/orders/:id/shipment |
Get shipment info for an order |
PATCH |
/api/v1/orders/:id/status |
Update order status with lifecycle tracking |
GET |
/api/v1/orders/number/:orderNo |
Get an order by order number |
commerce_products¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/collections |
List collections. Returns {data:[{id,name,slug,is_active,sort_order}]} |
POST |
/api/v1/collections |
Create a merchandising collection. Body: {name(str,req), slug(str,req), description?, is_active?(bool), sort_order?(int)}. Add products via POST /collections/:i… |
PUT |
/api/v1/collections/:id |
Update a collection (partial: name, slug, description, is_active, sort_order). |
DELETE |
/api/v1/collections/:id |
Delete a collection. |
POST |
/api/v1/collections/:id/products |
Add a product to a collection. Body: {product_id(uuid,required)}. |
DELETE |
/api/v1/collections/:id/products/:productId |
Remove a product from a collection. |
GET |
/api/v1/entitlements |
List entitlements (delivered digital units). Optional ?customer_id=. Returns {data:[{id,order_id,product_id,delivery_type,status,license_key,download_token,down… |
POST |
/api/v1/products |
Create a product. Body: {name(str,required), product_type(physical/digital/service/appointment/subscription_access), price(decimal string,required), currency(st… |
GET |
/api/v1/products |
List products (paginated). Query: page, per_page, status, product_type, category_id. Returns {data:[{id,name,description,sku,product_type,price,compare_at_price… |
PATCH |
/api/v1/products/bulk-status |
Bulk update product status |
GET |
/api/v1/products/:id |
Get a product by ID |
PUT |
/api/v1/products/:id |
Update a product |
POST |
/api/v1/products/:id/digital-asset |
Configure digital delivery for a product (product_type must be 'digital'). Body: {delivery_type('download'/'license_key', default download), download_url?(for d… |
GET |
/api/v1/products/:id/digital-asset |
Get a product's digital delivery config. Returns {data:{delivery_type,download_url,max_downloads}} |
GET |
/api/v1/products/:id/inventory |
List inventory rows for a product (product-level + per-variant). Returns {data:[{variant_id,quantity_on_hand,track_inventory,allow_backorder}]} |
PUT |
/api/v1/products/:id/inventory |
Set/upsert stock for a product or variant. Path :id is the product id. Body: {variant_id?(uuid; omit for product-level), quantity_on_hand(int), track_inventory?… |
POST |
/api/v1/products/:id/license-keys |
Bulk-load a product's license-key pool. Body: {keys([str],req)}. Keys are popped and assigned to entitlements as license_key orders are paid. Returns {data:{add… |
GET |
/api/v1/products/:id/media |
List a product's media gallery in sort order. Returns {data:[{id,url,media_type,alt_text,sort_order}]} |
POST |
/api/v1/products/:id/media |
Add a media item to a product's gallery. Path :id is the product id. Body: {url(str,required), media_type(image/video,default image), alt_text?, sort_order?(int… |
DELETE |
/api/v1/products/:id/media/:mediaId |
Remove a media item from a product's gallery. |
GET |
/api/v1/products/:id/prices |
List a product's per-currency prices. Returns {data:[{id,variant_id,currency,price}]} |
POST |
/api/v1/products/:id/prices |
Set an explicit per-currency price for a product (or a variant). Body: {currency(ISO-3,req e.g. EUR), price(decimal string,req), variant_id?(uuid)}. Upsert per… |
DELETE |
/api/v1/products/:id/prices/:priceId |
Delete a per-currency price entry. |
POST |
/api/v1/products/:id/reviews |
Post a product review. Path :id is the product id. Body: {rating(int 1-5,required), title?, body?, customer_id?(uuid; verified_purchase set if they have a paid… |
GET |
/api/v1/products/:id/reviews |
List a product's published reviews with rating aggregate. Returns {data:[{rating,title,body,verified_purchase,created_at}], meta:{avg_rating, count}} |
POST |
/api/v1/products/:id/variants |
Create a product variant. Path :id is the product id. Body: {sku?, name?(e.g. 'Large / Black'), options?(json e.g. {size:'L',color:'Black'}), price?(decimal str… |
GET |
/api/v1/products/:id/variants |
List a product's variants. Returns {data:[{id,sku,name,options,price,compare_at_price,image_url,status}]} |
PUT |
/api/v1/products/:id/variants/:variantId |
Update a product variant (partial). Body: any of |
DELETE |
/api/v1/products/:id/variants/:variantId |
Delete a product variant. |
POST |
/api/v1/shipping-rates |
Create a shipping rate. Body: {name(str,req), rate(decimal,req), zone_id?(uuid), min_order_subtotal?, free_over?(free when subtotal>=this), method?}. Pass its i… |
GET |
/api/v1/shipping-rates |
List shipping rates. Optional ?zone_id=. Returns {data:[{id,zone_id,name,rate,min_order_subtotal,free_over,method}]} |
DELETE |
/api/v1/shipping-rates/:id |
Delete a shipping rate. |
GET |
/api/v1/shipping-zones |
List shipping zones. Returns {data:[{id,name,countries,regions}]} |
POST |
/api/v1/shipping-zones |
Create a shipping zone. Body: {name(str,req), countries?([ISO-2]), regions?([str])}. Group rates by zone. Returns {data:{id}} |
GET |
/api/v1/tax-rates |
List tax rates. Returns {data:[{id,country,region,postal_prefix,rate,name,priority}]} |
POST |
/api/v1/tax-rates |
Create a tax rate. Body: {rate(0-1 decimal,req e.g. 0.0825), country?(ISO-2), region?, postal_prefix?, name?, priority?(int)}. Applied to the post-discount subt… |
DELETE |
/api/v1/tax-rates/:id |
Delete a tax rate. |
commerce_public¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/entitlements/:orgId/:token/download |
PUBLIC: redeem a download token (the token IS the auth). 302-redirects to the file URL and increments the counter; 403 once max_downloads is reached, expired, o… |
commerce_recurring¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/recurring-orders |
List recurring orders with pagination and status filter |
POST |
/api/v1/recurring-orders |
Create a recurring order schedule |
DELETE |
/api/v1/recurring-orders/:id |
Cancel a recurring order |
POST |
/api/v1/recurring-orders/:id/pause |
Pause an active recurring order |
POST |
/api/v1/recurring-orders/:id/resume |
Resume a paused recurring order |
companion¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/learning/backstory/:personalityId |
Get a companion's evolving backstory (org with base-self fallback) |
GET |
/api/v1/learning/feed/:personalityId |
Get a companion's recent learning feed (what it has been learning) |
POST |
/api/v1/learning/knowledge/query |
Query a companion's knowledge base (org-union with base fallback) |
POST |
/api/v1/learning/learn |
Synchronously research a subject and commit it to org knowledge/memory, returning the learning |
POST |
/api/v1/learning/memory/commit |
Commit a personal memory for a companion |
POST |
/api/v1/learning/study |
Dispatch a one-off companion study/research pass |
companion_run¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/companion-runs |
Create + execute a Sentinel companion UI run against a target environment |
compliance¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/baa |
List BAA agreements for the org |
POST |
/api/v1/baa |
Create a new BAA agreement |
PUT |
/api/v1/baa/:id |
Update BAA agreement status/details |
GET |
/api/v1/baa/status |
HIPAA Infrastructure Active status for the org |
GET |
/api/v1/compliance/reports/gdpr |
Generate GDPR compliance report |
GET |
/api/v1/compliance/reports/hipaa |
Generate HIPAA compliance report |
GET |
/api/v1/compliance/reports/soc2 |
Generate SOC2 compliance report |
component_registry¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/components |
List available UI components |
GET |
/api/v1/components/:id |
Get component definition |
content_studio¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/content-studio/* |
Content Studio public read endpoints (image gen, video gen, audio gen) |
POST |
/api/v1/content-studio/* |
Content Studio mutation endpoints (create jobs, update status) |
GET |
/api/v1/content-studio/brands |
List the organization's brands. Any asset type may carry a brand_id. |
POST |
/api/v1/content-studio/brands |
Create a brand identity (real or fictional). Name is unique per organization, case-insensitive. Fictional brands are born rights-granted; real brands gate on cl… |
GET |
/api/v1/content-studio/mythos |
List the organization's worlds. |
POST |
/api/v1/content-studio/mythos |
Create a named world bundling published assets. 409 on a duplicate name within the organization. Quota-exempt. |
DELETE |
/api/v1/content-studio/mythos/{mythosId} |
Delete a world's membership structure. Member assets are not deleted; backing-group teardown is best-effort. |
GET |
/api/v1/content-studio/mythos/{mythosId} |
Read a world and its members. |
POST |
/api/v1/content-studio/mythos/{mythosId}/members |
Add a published universal asset to a world. Quota-exempt: records a membership row. |
DELETE |
/api/v1/content-studio/mythos/{mythosId}/members/{uaId} |
Remove an asset from a world. The asset itself is untouched. |
POST |
/api/v1/content-studio/org-assets |
Create an organization-scoped universal asset draft (character, location, set, prop, fx, style, voice, music, camera, product). Quota-exempt: writes a draft row… |
GET |
/api/v1/content-studio/org-assets |
List the organization's universal assets, collapsed to one row per lineage. Filters: status, asset_type, q. Pass all_versions=true for the flat list. |
POST |
/api/v1/content-studio/org-assets/describe |
Turn an asset name into a description worth generating from. TOKEN-GATED: spends intelligence tokens (one short LLM turn). |
PATCH |
/api/v1/content-studio/org-assets/{uaId} |
Rename a draft or rewrite its description. Quota-exempt: edits text and generates nothing. |
GET |
/api/v1/content-studio/org-assets/{uaId}/clearance |
Read rights clearances for an asset, plus the computed blocked/block_reason. |
POST |
/api/v1/content-studio/org-assets/{uaId}/clearance |
Record a rights decision for an asset. Quota-exempt. |
GET |
/api/v1/content-studio/org-assets/{uaId}/options |
List generated concept options for a draft. |
POST |
/api/v1/content-studio/org-assets/{uaId}/options/generate |
Generate candidate concepts for a draft. TOKEN-GATED: the quota estimate scales with the iterations requested. |
POST |
/api/v1/content-studio/org-assets/{uaId}/options/{taskId}/approve |
Select a generated option. Quota-exempt: picks an option already paid for at generation time. |
GET |
/api/v1/content-studio/org-assets/{uaId}/pipeline |
Read the asset's pipeline stages (stage, status, artifact, approver, notes). |
POST |
/api/v1/content-studio/org-assets/{uaId}/pipeline/{stage} |
Set a pipeline stage's status. Quota-exempt: flips a gate flag. |
POST |
/api/v1/content-studio/org-assets/{uaId}/publish |
Publish a draft into the organization library. Clearance-gated: 403 when rights are not cleared. Only a draft can be published. |
DELETE |
/api/v1/content-studio/productions/{id} |
Delete a production and its children. Returns 409 while an assembly is compiling; a stuck assembly is failed automatically after 45 minutes. |
conversation_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/conversations |
List user conversations with pagination |
POST |
/api/v1/conversations |
Create a new conversation |
PUT |
/api/v1/conversations/:id |
Update conversation metadata |
GET |
/api/v1/conversations/:id |
Get conversation by ID |
POST |
/api/v1/conversations/:id/fork |
Create a fork of an existing conversation |
POST |
/api/v1/conversations/:id/mentions/apply |
Apply safe @mention participant routing, or create a redacted fork for access-limited humans |
POST |
/api/v1/conversations/:id/mentions/resolve |
Resolve @mention routing and access decisions without mutating participants |
POST |
/api/v1/conversations/:id/participants |
Add a participant to a conversation |
DELETE |
/api/v1/conversations/:id/participants/:userId |
Remove a participant from a conversation |
PUT |
/api/v1/conversations/:id/title |
Update conversation title (user rename) |
GET |
/api/v1/conversations/private/:context_type/:context_reference_id |
Get or create a private conversation for a context |
GET |
/api/v1/conversations/types |
List available conversation types |
conversations¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/conversations/:conversationId/suggest-kb |
Suggest knowledge base articles for conversation |
cost_projection¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/templates/compare-costs |
Compare costs across multiple templates |
GET |
/api/v1/templates/:id/cost-projection |
Project cost for template execution |
crm¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/crm/analytics |
CRM analytics |
GET |
/api/v1/crm/companies |
List companies |
POST |
/api/v1/crm/companies |
Create company |
GET |
/api/v1/crm/companies/:id |
Get company |
GET |
/api/v1/crm/contacts |
List contacts |
POST |
/api/v1/crm/contacts |
Create contact |
POST |
/api/v1/crm/contacts/bulk |
Bulk operations |
GET |
/api/v1/crm/contacts/:id |
Get contact |
DELETE |
/api/v1/crm/contacts/:id |
Delete contact |
PUT |
/api/v1/crm/contacts/:id |
Update contact |
POST |
/api/v1/crm/contacts/:id/activities |
Log activity |
POST |
/api/v1/crm/contacts/:id/emails |
Add email |
POST |
/api/v1/crm/contacts/:id/phones |
Add phone |
GET |
/api/v1/crm/contacts/search |
Search contacts |
POST |
/api/v1/crm/duplicates/detect |
Detect duplicates |
GET |
/api/v1/crm/suggestions |
List pending contact suggestions. The envelope carries queue-wide total and reasons alongside the returned page — never treat suggestions.length as the backlo… |
POST |
/api/v1/crm/suggestions/bulk-approve |
Promote explicitly chosen suggestions into contacts. Ids only — no approve-by-reason, because approving CREATES rows. Cap 200. Partial success is normal and r… |
POST |
/api/v1/crm/suggestions/bulk-reject |
Reject many suggestions by explicit ids or by whole quarantine reason bucket. Cap 5000. Reversible: rows stay auditable with status='rejected'. |
POST |
/api/v1/crm/suggestions/{id}/approve |
Promote one suggestion into a contact |
POST |
/api/v1/crm/suggestions/{id}/reject |
Reject one suggestion (status change, not a delete) |
customer_success¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/customer/health-scores |
Customer health |
GET |
/api/v1/customer/tickets |
Support tickets |
dashboard¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/dashboard/stats |
Quick key stats for the admin dashboard |
dashboards¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/dashboards |
Create custom dashboard |
DELETE |
/api/v1/dashboards/:id |
Delete dashboard |
GET |
/api/v1/dashboards/:id |
Get dashboard |
GET |
/api/v1/orgs/:id/dashboards |
List organization dashboards |
debug¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/debug/context/:messageId |
Get message context for debugging |
desktop¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v3/operations/desktop/health |
Desktop health |
GET |
/api/v3/operations/desktop/machines |
List machines |
POST |
/api/v3/operations/desktop/machines |
Register machine |
GET |
/api/v3/operations/desktop/machines/:id/tasks/pending |
Pending tasks |
GET |
/api/v3/operations/desktop/supported-apps |
Supported apps |
POST |
/api/v3/operations/desktop/tasks |
Create task |
development¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/borg/repos/:id/develop |
Hand a comprehended repo to Daedalus's ingest plane (assimilate→build reciprocal) |
POST |
/api/v1/builds |
Start a consensus-gated Daedalus build assessment |
GET |
/api/v1/builds/:id |
Fetch a persisted Daedalus build assessment and consensus state |
POST |
/api/v1/builds/:id/accept |
Accept a Daedalus build assessment and prepare blueprint decomposition |
POST |
/api/v1/builds/:id/answers |
Attach user answers and resume Daedalus consensus |
POST |
/api/v1/builds/:id/cancel |
Cancel a Daedalus build assessment while preserving provenance |
POST |
/api/v1/builds/:id/checkouts |
Open a task-backed user or IDE checkout for an active file version |
POST |
/api/v1/builds/:id/context-pack |
Generate an immutable LOD context pack asset from Daedalus build state, source refs, and workspace provenance |
POST |
/api/v1/builds/:id/dispatch-ready |
Assign slot-limited ready materialized tasks with dependency and lock metadata |
POST |
/api/v1/builds/:id/file-versions |
Persist an immutable content-addressed file version and advance the symlink workspace projection |
POST |
/api/v1/builds/:id/file-versions/:version_id/validation-runs |
Attach immutable test, lint, build, or review evidence to a Daedalus file version |
POST |
/api/v1/builds/:id/locks |
Acquire a scoped file workspace lease for companion-safe writes or reads |
POST |
/api/v1/builds/:id/locks/:lock_id/heartbeat |
Renew an active Daedalus file workspace lease |
POST |
/api/v1/builds/:id/locks/:lock_id/release |
Release an active Daedalus file workspace lease |
GET |
/api/v1/builds/:id/manifests/latest |
Fetch the latest immutable workspace manifest snapshot for rebuild or audit |
GET |
/api/v1/builds/:id/manifests/:manifest_id |
Fetch a specific immutable workspace manifest snapshot for rebuild or audit |
POST |
/api/v1/builds/:id/materialize-tasks |
Create MAGIEVA parent and child tasks from a Daedalus task plan |
POST |
/api/v1/builds/:id/prepare-tasks |
Convert an accepted blueprint into scheduler-ready task waves |
POST |
/api/v1/builds/:id/projection/detect-drift |
Compare projected symlinks against an immutable workspace manifest |
POST |
/api/v1/builds/:id/projection/materialize |
Build a symlink workspace tree from an immutable manifest snapshot |
POST |
/api/v1/builds/:id/projection/repair-drift |
Rebuild stale projected symlinks from an immutable workspace manifest |
POST |
/api/v1/builds/:id/start |
Accept, prepare, materialize, and dispatch ready Daedalus tasks in one server-owned operation |
POST |
/api/v1/builds/:id/summary-asset |
Generate an immutable JSON build summary asset with versions, validation evidence, manifests, and projection state |
POST |
/api/v1/builds/:id/tasks/:task_key/claim |
Mark one assigned Daedalus task as running and return its companion packet |
POST |
/api/v1/builds/:id/tasks/:task_key/complete |
Commit an immutable file version for a companion task before marking it complete |
POST |
/api/v1/builds/:id/tasks/:task_key/packet |
Return a compact companion execution packet for one materialized task |
POST |
/api/v1/builds/:id/tasks/:task_key/status |
Record companion task progress so completed work unlocks dependent dispatch waves |
POST |
/api/v1/builds/:id/unlink-path |
Remove a path from the projected workspace while preserving immutable file history |
POST |
/api/v1/builds/ingest |
discovery¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/discovery/endpoints |
Add a new discovery endpoint |
GET |
/api/v1/discovery/endpoints |
List all discovery endpoints |
GET |
/api/v1/discovery/models/:model_id/history |
Get discovery history for a specific model |
GET |
/api/v1/discovery/providers/:provider_id/events |
Get discovery events for a specific provider |
GET |
/api/v1/discovery/status |
Get current discovery process status |
GET |
/api/v1/discovery/timeline |
Get discovery timeline events |
POST |
/api/v1/discovery/trigger |
Manually trigger AI model discovery process |
early_access¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/early-access/grants |
List grants |
POST |
/api/v1/early-access/grants |
Create grant |
POST |
/api/v1/early-access/grants/batch |
Batch grants |
POST |
/api/v1/early-access/grants/:id/activate |
Activate grant |
GET |
/api/v1/early-access/programs |
List programs |
POST |
/api/v1/early-access/programs |
Create program |
GET |
/api/v1/early-access/programs/:id |
Get program |
GET |
/api/v1/early-access/programs/:id/metrics |
Program metrics |
ecommerce¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/cart-recovery/analytics/summary |
Analytics |
POST |
/api/v1/cart-recovery/campaigns |
Create campaign |
GET |
/api/v1/cart-recovery/carts |
List carts |
POST |
/api/v1/cart-recovery/sources |
Create source |
GET |
/api/v1/cart-recovery/sources |
List sources |
POST |
/api/v1/cart-recovery/unsubscribe |
Unsubscribe |
POST |
/api/v1/cart-recovery/webhooks/:source_id/cart-abandoned |
Cart abandoned |
email¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/email/sync |
Trigger email sync for Gmail/Outlook |
GET |
/api/v1/email/sync/status |
Get email sync status |
POST |
/api/v1/send |
Send email via provider |
POST |
/api/v3/operations/email/ai/draft |
AI draft/smart-reply (companion task) |
POST |
/api/v3/operations/email/ai/summarize |
AI summarize (companion task) |
POST |
/api/v3/operations/email/attachments |
Upload compose attachment (DAM, upload_source=email) |
PATCH |
/api/v3/operations/email/:email_id/read |
Mark read |
POST |
/api/v3/operations/email/:email_id/triage |
AI triage (priority/label) |
GET |
/api/v3/operations/email/labels |
Get labels |
GET |
/api/v3/operations/email/list |
List emails |
GET |
/api/v3/operations/email/:message_id |
Get email |
POST |
/api/v3/operations/email/send |
Send email |
POST |
/api/v3/operations/email/sync |
Sync emails |
POST |
/api/v3/operations/email/sync/start |
Start sync |
GET |
/api/v3/operations/email/sync/status |
Sync status |
GET |
/api/v3/operations/email/threads |
List email threads |
GET |
/api/v3/operations/email/threads/:thread_id |
Get email thread |
embed¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/embed/:org_id/:dashboard_name |
Get embeddable dashboard URL |
event_management¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/events |
Publish event to Pub/Sub topic |
POST |
/api/v1/events/group/:groupId |
Emit event to all group members (Groups Phase 4) |
GET |
/api/v1/events/types |
List all supported event types |
file_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/files/:id |
Get file details and content |
GET |
/api/v1/borg/repos/:id/files |
List ingested files from repository |
finance¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/finance/expenses |
List expenses |
GET |
/api/v1/finance/invoices |
List invoices |
GET |
/api/v1/finance/revenue-dashboard |
Revenue dashboard |
forms¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/forms |
List all forms for organization |
POST |
/api/v1/forms |
Create a new intake form |
PUT |
/api/v1/forms/:id |
Update an existing form |
GET |
/api/v1/forms/:id |
Get a specific form by ID |
GET |
/api/v1/forms/:id/analytics |
Get form conversion analytics |
GET |
/api/v1/forms/:id/schema |
Get UIFRS-compatible form schema for rendering (public) |
GET |
/api/v1/forms/published |
List published forms for an organization (public, via X-Org-Slug) |
POST |
/api/v1/forms/submit |
Submit a form (public, rate-limited 100/hr per IP+UA) |
POST |
/api/v1/forms/verify-otp |
Verify OTP code and issue customer session token (public) |
gamification¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/leaderboards/:type |
Get leaderboard rankings (type: daily-task-points or all-time-points) |
POST |
/api/v1/rewards/daily-login |
Award daily login bonus with streak tracking (base 5 coins + streak bonus) |
GET |
/api/v1/rewards/summary/:user_id |
Get user's current rewards summary (points, coins, level, badges, leaderboard rank) |
POST |
/api/v1/rewards/task-completion |
Award points and coins for task completion (difficulty-based rewards with speed bonus) |
general¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/uifrs/blueprints |
|
GET |
/api/v1/uifrs/blueprints |
|
GET |
/api/v1/uifrs/blueprints/:id |
|
POST |
/api/v1/uifrs/blueprints/:id/assemble |
|
POST |
/api/v1/uifrs/blueprints/:id/export |
|
PUT |
/api/v1/uifrs/blueprints/:id/modules |
|
PUT |
/api/v1/uifrs/blueprints/:id/theme |
|
POST |
/api/v1/uifrs/components/register |
|
GET |
/api/v1/uifrs/definitions |
|
GET |
/api/v1/uifrs/definitions/versions |
|
GET |
/api/v1/uifrs/endpoints/discover |
|
GET |
/api/v1/uifrs/frameworks |
|
GET |
/api/v1/uifrs/integrations/discover |
|
POST |
/api/v1/uifrs/modules/auto-wire |
|
GET |
/api/v1/uifrs/modules/:id |
|
GET |
/api/v1/uifrs/modules/:id/preview |
|
POST |
/api/v1/uifrs/modules/register |
|
GET |
/api/v1/uifrs/modules/search |
|
GET |
/api/v1/uifrs/platforms |
|
POST |
/api/v1/uifrs/themes |
|
PUT |
/api/v1/uifrs/themes/:id |
|
GET |
/api/v1/uifrs/themes/:id |
|
GET |
/api/v1/uifrs/themes/:id/preview |
|
GET |
/api/v1/users/me/research-digest-prefs |
|
PUT |
/api/v1/users/me/research-digest-prefs |
|
PUT |
/api/v1/users/me/timezone |
|
POST |
/api/v3/auth/login |
|
GET |
/api/v3/auth/me |
|
POST |
/api/v3/auth/oauth/exchange |
|
POST |
/api/v3/auth/onboarding/choose-organization |
|
POST |
/api/v3/auth/onboarding/provision-verified |
|
GET |
/api/v3/auth/onboarding/suggest-org |
|
POST |
/api/v3/auth/signup |
|
PATCH |
/api/v3/bolt/* |
|
GET |
/api/v3/bolt/* |
|
POST |
/api/v3/bolt/* |
|
PUT |
/api/v3/bolt/* |
|
DELETE |
/api/v3/bolt/* |
|
POST |
/api/v3/organizations/ |
|
GET |
/api/v3/organizations/available |
|
GET |
/api/v3/organizations/check-domain |
|
POST |
/api/v3/organizations/create |
|
GET |
/api/v3/organizations/current |
|
DELETE |
/api/v3/organizations/:id |
|
PUT |
/api/v3/organizations/:id |
|
GET |
/api/v3/organizations/:id |
|
GET |
/api/v3/organizations/:id/invitations |
|
POST |
/api/v3/organizations/:id/invitations |
|
DELETE |
/api/v3/organizations/:id/invitations/:invitationId |
|
POST |
/api/v3/organizations/:id/join-request |
|
POST |
/api/v3/organizations/:id/join-requests/:invitationId/approve |
|
POST |
/api/v3/organizations/:id/join-requests/:invitationId/reject |
|
POST |
/api/v3/organizations/:id/members |
|
GET |
/api/v3/organizations/:id/members |
|
DELETE |
/api/v3/organizations/:id/members/:userId |
|
PUT |
/api/v3/organizations/:id/members/:userId |
|
GET |
/api/v3/organizations/:id/members/:userId |
|
GET |
/api/v3/organizations/:id/members/:userId/groups |
|
POST |
/api/v3/organizations/switch/:id |
|
GET |
/api/v3/subscriptions/tiers |
|
POST |
/api/v3/subscriptions/users/:id/allocate |
|
GET |
/api/v3/subscriptions/users/:id/allocation |
|
POST |
/api/v3/subscriptions/users/:id/deallocate |
|
GET |
/api/v3/subscriptions/users/:id/subscription |
|
PUT |
/api/v3/subscriptions/users/:id/subscription |
|
GET |
/api/v3/subscriptions/users/:id/usage-history |
|
POST |
/api/v3/users/ |
|
GET |
/api/v3/users/ |
|
PUT |
/api/v3/users/:id |
|
GET |
/api/v3/users/:id |
generation¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/generate/audio |
Generate audio from text (text-to-speech) |
POST |
/api/v1/generate/audio |
|
POST |
/api/v1/generate/document |
Generate documents (PDF, DOCX, Markdown) from text or structured data |
POST |
/api/v1/generate/document |
|
POST |
/api/v1/generate/image |
Generate images from text prompts or reference images |
POST |
/api/v1/generate/image |
|
GET |
/api/v1/generate/jobs |
List all generation jobs for current user |
GET |
/api/v1/generate/jobs/:id |
Poll generation job status |
GET |
/api/v1/generate/models |
List available generation models with schemas |
POST |
/api/v1/generate/script |
Generate scripts (code, screenplays, podcast scripts) from prompts |
POST |
/api/v1/generate/script |
|
POST |
/api/v1/generate/video |
|
POST |
/api/v1/generate/video |
Generate videos from text prompts or images |
gpu¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/gpu-runners |
List platform GPU runners and their status |
POST |
/api/v1/gpu-runners |
Provision a platform GPU VM running ComfyUI for a capability and register it with LRM |
DELETE |
/api/v1/gpu-runners/:id |
Deprovision a platform GPU runner (delete the VM, deregister from LRM) |
group_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/groups |
List groups |
POST |
/api/v1/groups |
Create user group |
GET |
/api/v1/groups/:groupId/activity |
Get activity log for a specific group |
GET |
/api/v1/groups/:groupId/yields |
Get yields for a specific group |
GET |
/api/v1/groups/:id |
Get group details |
DELETE |
/api/v1/groups/:id |
Delete group |
PUT |
/api/v1/groups/:id |
Update group |
group_members¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/groups/:id/members |
Add member to group |
DELETE |
/api/v1/groups/:id/members/:user_id |
Remove member from group |
image_processing¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/process/image |
Process image (resize, compress, format) |
insights¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/insights |
Submit new insight |
GET |
/api/v1/insights/:id |
Get insight by ID |
POST |
/api/v1/insights/:id/vote |
Vote on insight (upvote/downvote) |
GET |
/api/v1/insights/:org_id |
Get AI insights |
POST |
/api/v1/insights/:org_id/generate |
Generate new insights |
POST |
/api/v1/insights/quality-check |
Check insight quality before submission |
GET |
/api/v1/insights/search |
Search model insights |
GET |
/api/v1/models/:model_id/insights |
Get insights for specific model |
integration¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/mcp/connections |
Connect an organization to an external MCP server |
POST |
/api/v1/mcp/invoke |
Invoke an external MCP tool on behalf of an organization (metered) |
GET |
/api/v1/mcp/tools |
List an organization's available external MCP tools (org-scoped discovery) |
integration_discovery¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/integrations |
List available integrations |
integration_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/integrations/:id |
Get integration details |
POST |
/api/v1/integrations/:id/disconnect |
Disconnect integration |
POST |
/api/v1/integrations/:provider/connect |
Connect to external service |
integration_testing¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/integrations/:id/test |
Test integration connection |
intelligence¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/briefings |
Daily briefings for an org |
POST |
/api/v1/briefings/generate |
Manually trigger briefing generation |
GET |
/api/v1/briefings/:id |
Single briefing with full content |
POST |
/api/v1/intelligence/unified |
Unified intelligence request (12-phase pipeline) |
GET |
/api/v1/reports |
Generated reports for an org |
POST |
/api/v1/reports/generate |
Create a new report |
GET |
/api/v1/reports/:id |
Single report with full content |
intent_analysis¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/actions |
List available action types |
internal¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/submissions/by-customer/:customer_id |
Get latest submission for a customer (internal, used by Jarvis for attribution) |
issue_attachments¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/issues/:id/attachments |
List an issue's attachments with signed URLs |
POST |
/api/v1/issues/:id/attachments |
Link uploaded assets to an issue (role: user_screenshot/attachment/before/after/diff) |
issue_comments¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/issues/:id/comments |
Add a comment to an issue |
GET |
/api/v1/issues/:id/comments |
List comments on an issue |
PUT |
/api/v1/issues/:id/comments/:cid |
Edit a comment on an issue |
DELETE |
/api/v1/issues/:id/comments/:cid |
Soft-delete a comment |
issue_labels¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/labels |
List organization labels |
issue_lifecycle¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/issues/:id/assign |
Assign issue to a user |
POST |
/api/v1/issues/:id/assign/me |
Assign issue to the calling user (Assign to me action) |
POST |
/api/v1/issues/:id/escalate |
Escalate an issue to a human (sets fix_status=escalated + audit comment) |
PATCH |
/api/v1/issues/:id/status |
Transition issue status (open -> in_progress -> resolved -> closed) |
issue_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/issues |
List issues with filters (status, type, priority, assignee, reporter, project) |
POST |
/api/v1/issues |
Create a new issue/bug report |
PUT |
/api/v1/issues/:id |
Update issue fields |
GET |
/api/v1/issues/:id |
Get issue detail by ID |
DELETE |
/api/v1/issues/:id |
Soft-delete an issue |
GET |
/api/v1/issues/my |
Issues assigned to the current user |
GET |
/api/v1/issues/reported |
Issues reported by the current user |
issue_search¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/issues/search |
Full-text search across issues |
issue_tracking¶
| Method | Path | Description |
|---|---|---|
PATCH |
/api/v1/borg/issues/:id |
Update issue status |
GET |
/api/v1/borg/repos/:id/issues |
List issues tracked for a repository |
PUT |
/api/v1/borg/repos/:id/issues/:issueId |
Update a tracked issue's status |
POST |
/api/v1/borg/repos/:id/issues/:issueId/link |
Link a tracked issue to an internal task |
job_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/jobs/:id |
Get job status |
POST |
/api/v1/jobs/:id/cancel |
Cancel processing job |
knowledge¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/comprehension/:content_hash |
Get the content-addressed comprehension pack (L02/L01 + embedding ref) by sha256 — the Daedalus-bridge reuse seam |
GET |
/api/v1/borg/repos/:id/files/* |
Get a file's LOD summaries by path |
GET |
/api/v1/borg/repos/:id/search |
|
GET |
/api/v1/borg/repos/:id/tree |
Get the ingested file tree for a repository |
GET |
/api/v3/operations/knowledge-bases |
List KBs |
POST |
/api/v3/operations/knowledge-bases |
Create KB |
leaderboard¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/model/:name |
Get detailed information for a specific model |
GET |
/api/v1/summary |
Get leaderboard summary statistics |
GET |
/api/v1/top-agent |
Get top models by agent capabilities score |
GET |
/api/v1/top-code |
Get top models by code generation score |
GET |
/api/v1/top-cost-efficiency |
Get top models by cost efficiency |
GET |
/api/v1/top-overall |
Get top models by overall score |
GET |
/api/v1/top-quality |
Get top models by quality score |
GET |
/api/v1/top-reasoning |
Get top models by reasoning score |
GET |
/api/v1/top-speed |
Get top models by speed |
leadership¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/leadership/kpis |
List KPIs |
GET |
/api/v1/leadership/okrs |
List OKRs |
GET |
/api/v1/leadership/strategic-initiatives |
Strategic initiatives |
learning¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/learning/dossier/:personalityId |
Get a companion's dossier (recent history + trust rollup) |
GET |
/api/v1/learning/history/:personalityId |
Get a companion's recent task history (dossier) |
POST |
/api/v1/learning/log-usage |
Log model usage event |
GET |
/api/v1/learning/performance/:orgId/:archetype |
Get performance metrics for organization and archetype |
POST |
/api/v1/learning/recalculate |
Trigger trust score recalculation |
GET |
/api/v1/learning/recommendations/:archetype/:category |
Get AI model recommendations for archetype and category |
GET |
/api/v1/learning/trust/models/:modelId/breakdown |
Get trust score breakdown for model |
GET |
/api/v1/learning/trust/:personalityId |
Get a companion's trust aggregate for a capability |
GET |
/api/v1/learning/trust-scores/:archetype |
Get trust scores for archetype |
POST |
/api/v1/learning/verdict |
Record a human verdict (gold accepted signal) for a task |
ledger¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/plutus/adjustments |
Admin balance correction |
GET |
/api/v1/plutus/balances |
Creator earnings (CRED) + USD balances for an org |
POST |
/api/v1/plutus/grants |
Admin/service mint of creator earnings |
GET |
/api/v1/plutus/ledger |
Transaction history for an org |
legal¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/legal/compliance |
Compliance |
GET |
/api/v1/legal/contracts |
List contracts |
license_analysis¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/repos/:id/license |
Get repository license analysis |
marketing¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/marketing/campaigns |
Campaigns |
GET |
/api/v1/marketing/content-calendar |
Content calendar |
marketplace¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/marketplace/categories |
Get marketplace template categories |
GET |
/api/v1/marketplace/featured |
Get featured marketplace templates |
GET |
/api/v1/marketplace/search |
Search marketplace templates |
POST |
/api/v1/marketplace/templates/:id/rate |
Rate marketplace template |
GET |
/api/v1/marketplace/templates/:id/ratings |
Get template ratings and reviews |
GET |
/api/v1/marketplace/templates/:id/usage |
Get template usage analytics |
POST |
/api/v1/marketplace/templates/:id/view |
Track template view event |
media_debriefs¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/media/debriefs/:id/audio |
Stream a debrief's narrated mp3 |
GET |
/api/v1/borg/media/items/:id/debrief |
Get an episode's TLDR debrief and its narration status |
POST |
/api/v1/borg/media/items/:id/debrief |
Write and narrate a ~15 minute TLDR of one episode; billed in Magieva Tokens |
media_library¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/media/items/:id/speakers |
List an episode's diarized speaker clusters and how long each spoke |
PUT |
/api/v1/borg/media/items/:id/speakers/:cluster |
Put a name to a diarized cluster so citations attribute it |
POST |
/api/v1/borg/media/items/:id/speakers/identify |
Name an episode's speaker clusters automatically from its own opening — the door for episodes ingested before automatic naming shipped |
GET |
/api/v1/borg/media/items/:id/transcript |
Get an episode's diarized transcript with speaker turns and timings |
GET |
/api/v1/borg/media/subscriptions/:id/items |
List a subscription's episodes and their ingest status |
media_reports¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/borg/media/ask |
Retrieve attributed passages from subscribed episodes for a question, spread across episodes rather than top-k from one |
POST |
/api/v1/borg/media/reports |
Answer one question across every subscribed episode, with each claim cited to the passage it came from; 409 and free when nothing discusses it |
GET |
/api/v1/borg/media/reports |
List cross-episode reports, newest first |
GET |
/api/v1/borg/media/reports/:id |
Get a written report with its citations |
media_subscriptions¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/borg/media/subscriptions |
Subscribe to a podcast or channel; creates its project and starts the first sync |
GET |
/api/v1/borg/media/subscriptions |
List the org's podcast/YouTube subscriptions |
GET |
/api/v1/borg/media/subscriptions/:id |
Get one subscription with its sync state |
PATCH |
/api/v1/borg/media/subscriptions/:id |
Change a subscription's sync frequency, backfill window or paused state |
DELETE |
/api/v1/borg/media/subscriptions/:id |
Stop following a feed; ingested episodes and transcripts are kept |
media_sync¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/borg/media/scheduler/run |
Sweep every subscription that is due by its sync frequency (the cron's own entry point) |
POST |
/api/v1/borg/media/subscriptions/:id/sync |
Fetch new episodes and queue transcription for them |
memory_management¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/memories |
Store conversation memory |
GET |
/api/v1/memories/:id |
Get memory by ID |
DELETE |
/api/v1/memories/:id |
Delete memory |
GET |
/api/v1/memory/collections |
List all memory collections |
POST |
/api/v1/memory/collections/initialize |
Create the default Qdrant collections |
GET |
/api/v1/memory/collections/:name |
Get collection details |
DELETE |
/api/v1/memory/collections/:name |
Delete a collection (GDPR) |
POST |
/api/v1/memory/items |
Store a memory item (generates embedding) |
DELETE |
/api/v1/memory/items/:id |
Delete a memory item |
GET |
/api/v1/memory/items/:id |
Get memory item by ID |
PUT |
/api/v1/memory/items/:id |
Update a memory item (re-embeds content) |
POST |
/api/v1/memory/org-research/:orgId/purge |
Delete an org's onboarding-research vectors from both memory collections (corrections delete-by-source primitive) |
memory_retrieval¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/memories/context/:conversation_id |
Get relevant context for conversation |
GET |
/api/v1/memory/conversations/:id/context |
Get relevant context for a conversation |
GET |
/api/v1/memory/list |
Org-wide, permission-scoped memory listing (Memory Browser); scrolls by payload filter, orders by timestamp — no query |
GET |
/api/v1/memory/projects/:id/memory |
Get memory items related to a project |
GET |
/api/v1/memory/tasks/:id/similar |
Find tasks similar to the given task |
memory_search¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/memories/search |
Semantic search over memories |
POST |
/api/v1/memory/multi-context-search |
Semantic search across multiple context types |
POST |
/api/v1/memory/search |
Semantic search over memories |
messaging¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/messages |
List messages with pagination and filtering |
POST |
/api/v1/messages |
Create a new message in a conversation |
DELETE |
/api/v1/messages/:id |
Delete a message |
PUT |
/api/v1/messages/:id |
Update message content or metadata |
GET |
/api/v1/messages/:id |
Get message by ID |
GET |
/api/v1/messages/:id/audio/stream |
Stream TTS audio for message with emotion-aware prosody (Phase C) |
GET |
/api/v3/operations/messaging/channels |
List channels |
GET |
/api/v3/operations/messaging/messages |
List messages |
POST |
/api/v3/operations/messaging/send |
Send message |
POST |
/api/v3/operations/messaging/sync |
Sync messages |
POST |
/api/v3/operations/messaging/webhooks/telegram |
Telegram webhook |
metrics¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/metrics/query |
Query metrics |
GET |
/api/v1/metrics/range |
Query metric range |
model_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/local/models |
List available models |
POST |
/api/v1/local/models/:modelId/preload |
Preload model into memory |
DELETE |
/api/v1/local/models/:modelId/unload |
Unload model from memory |
model_registry¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/models |
List all models |
GET |
/api/v1/models/docs |
Get model documentation |
GET |
/api/v1/models/examples |
Get model examples |
GET |
/api/v1/models/info |
Get model info by ID |
GET |
/api/v1/models/schema |
Get model schemas |
model_routing¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/effective-models |
Configured model preference per capability (scope-resolved presets, no billing gate) |
GET |
/api/v1/models/active |
Get active models for capability (preset-only routing) |
GET |
/api/v2/models/active |
Get active models with companion learning integration |
model_sync¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/events/falai-sync |
Pub/Sub handler for fal.ai sync |
POST |
/api/v1/events/multi-provider-sync |
Pub/Sub handler for multi-provider sync |
POST |
/api/v1/sync/falai/schemas |
Trigger schema sync |
GET |
/api/v1/sync/falai/stats |
Get schema coverage stats |
POST |
/api/v1/sync/falai/trigger |
Manual trigger for fal.ai sync |
GET |
/api/v1/sync/multi-provider/status |
Get all provider statuses |
POST |
/api/v1/sync/multi-provider/trigger |
Manual trigger for multi-provider sync |
models¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/models/bundle |
Create airgap bundle |
GET |
/api/v1/models/bundles |
List airgap bundles |
GET |
/api/v1/models/catalog |
List all models in catalog |
GET |
/api/v1/models/catalog/:ref |
Get model details by reference |
GET |
/api/v1/models/catalog/:ref/manifest |
Get model manifest |
POST |
/api/v1/models/import |
Import airgap bundle |
POST |
/api/v1/models/pull |
Pull model from registry |
POST |
/api/v1/models/push |
Push model to registry |
GET |
/api/v1/models/search |
Search models |
monitoring¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/local/backends/:id/gpu |
Get GPU metrics for backend |
notifications¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/notifications |
List in-app notifications for the authenticated user |
DELETE |
/api/v1/notifications/:id |
Dismiss a user notification |
POST |
/api/v1/notifications/:id/read |
Mark a user notification as read |
GET |
/api/v1/notification-templates |
List notification templates |
POST |
/api/v1/notification-templates |
Create or override a notification template |
DELETE |
/api/v1/notification-templates/:id |
Delete a notification template (reset to default) |
PUT |
/api/v1/notification-templates/:id |
Update a notification template |
oauth¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/oauth/authorize/:provider |
Initiate OAuth flow for provider (Google, GitHub, etc.) |
GET |
/api/v1/oauth/callback/:provider |
OAuth callback handler for provider |
GET |
/api/v1/oauth/connections |
List user's OAuth connections |
DELETE |
/api/v1/oauth/connections/:id |
Delete OAuth connection |
GET |
/api/v1/oauth/connections/:id |
Get OAuth connection by ID |
GET |
/api/v3/operations/oauth/connections |
List connections |
POST |
/api/v3/operations/oauth/connections |
Create connection |
DELETE |
/api/v3/operations/oauth/connections/:id |
Delete connection |
onboarding¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/extract-timings |
Extract word-level timings for a tutorial audio file via Whisper and upsert into tutorial_audio_timings |
GET |
/api/v1/onboarding/checklist |
Get onboarding checklist for the org |
POST |
/api/v1/onboarding/skip/:step |
Mark an onboarding step as skipped |
GET |
/api/v1/timings/:flow_step_id |
Fetch cached word-level timings for a flow step's audio asset |
org_data¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/org-data/archive |
Export an org's rows + storage object list to a GCS tar.gz archive |
GET |
/api/v1/org-data/jobs/:id |
Status/progress of an archive or wipe job |
GET |
/api/v1/org-data/metrics/platform |
Cross-DB platform KPIs (orgs, users, DAU/WAU/MAU, avg active days) for the super-admin Database Viewing dashboard |
GET |
/api/v1/org-data/metrics/top-items |
Per-DB (core/ops/integrations) top items over a 1–7 day trailing window for the Database Viewing dashboard |
GET |
/api/v1/org-data/orgs |
Search organizations by name or id for the wiper picker |
POST |
/api/v1/org-data/plan |
Inventory everything that would be archived/deleted for an org — writes nothing |
GET |
/api/v1/org-data/rows |
Read a page of an org's rows for a single scoped table (read-only) |
GET |
/api/v1/org-data/tables |
List org-scoped tables in a database for the read-only org data browser |
POST |
/api/v1/org-data/wipe |
Destructively delete an org's rows + storage + vectors (async job). Requires a prior archive id |
org_templates¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/org/templates |
List organization-scoped templates |
POST |
/api/v1/templates/:id/share |
Share template with organization |
DELETE |
/api/v1/templates/:id/share/:org_id |
Remove template share with organization |
GET |
/api/v1/templates/:id/shares |
List organizations with template access |
PUT |
/api/v1/templates/:id/visibility |
Set template visibility (public, private, org) |
organization_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/organizations |
List all organizations (admin only) |
PUT |
/api/v1/organizations/:id |
Update organization settings |
GET |
/api/v1/organizations/:id |
Get organization by ID |
GET |
/api/v1/organizations/:id/data-summary |
Get organization data summary and statistics |
GET |
/api/v1/organizations/me |
Get current user's organization |
people¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/people/employees |
List employees |
GET |
/api/v1/people/org-chart |
Org chart |
GET |
/api/v1/people/performance-reviews |
Performance reviews |
permissions¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/permissions/check |
Check whether a subject has the requested access |
GET |
/api/v1/permissions/effective |
Return the effective ACL decision with source trace |
POST |
/api/v1/permissions/grant |
Grant user, group, or companion access to a resource |
DELETE |
/api/v1/permissions/revoke |
Revoke user, group, or companion access to a resource |
GET |
/api/v3/operations/permissions/check |
Check whether a subject has the requested access |
GET |
/api/v3/operations/permissions/effective |
Return the effective ACL decision with source trace |
POST |
/api/v3/operations/permissions/grant |
Grant user, group, or companion access to a resource |
DELETE |
/api/v3/operations/permissions/revoke |
Revoke user, group, or companion access to a resource |
personalities¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/addressable |
List addressable personalities |
POST |
/api/v1/build-team |
Build team of personalities |
POST |
/api/v1/create-from-profile |
Create personality from RIASEC profile |
GET |
/api/v1/personalities |
List all agent personalities |
POST |
/api/v1/personalities |
Create new personality |
GET |
/api/v1/personalities/archetype/:archetype |
List personalities by archetype |
PUT |
/api/v1/personalities/:id |
Update personality |
DELETE |
/api/v1/personalities/:id |
Delete personality |
GET |
/api/v1/personalities/:id |
Get personality by ID |
PUT |
/api/v1/personalities/:id/approve |
Approve personality |
GET |
/api/v1/personalities/:id/audit |
Get personality audit trail |
POST |
/api/v1/personalities/:id/fork |
Fork existing personality |
GET |
/api/v1/personalities/:id/performance |
Get personality performance metrics |
GET |
/api/v1/personalities/user/:userId |
Get personality by user ID |
POST |
/api/v1/propose |
Propose new personality |
POST |
/api/v1/resolve-mention |
Resolve personality mention |
POST |
/api/v1/select |
Select personality for task |
personality¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/questions/:number |
Get RIASEC assessment question by number (1-14) |
POST |
/api/v1/sessions |
Create new onboarding session (auto-resumes if active session exists) |
POST |
/api/v1/sessions |
Create new onboarding session (auto-resumes if active session exists) |
GET |
/api/v1/sessions/:id |
Get onboarding session state and progress |
GET |
/api/v1/sessions/:id |
Get onboarding session state and progress |
POST |
/api/v1/sessions/:id/answer |
Submit answer to current question, advance session |
POST |
/api/v1/sessions/:id/answer |
Submit answer to current question, advance session |
POST |
/api/v1/sessions/:id/complete |
Force-complete session (admin/testing only) |
POST |
/api/v1/sessions/:id/complete |
Force-complete session (admin/testing only) |
PUT |
/api/v1/sessions/:id/phase |
Update session phase (warmup, assessment_intro, assessment, complete) |
POST |
/api/v1/sessions/:id/skip |
Skip onboarding assessment, create default neutral profile |
POST |
/api/v1/sessions/:id/skip |
Skip onboarding assessment, create default neutral profile |
GET |
/api/v1/sessions/:id/stats |
Get detailed session statistics and phase progress |
GET |
/api/v1/sessions/:id/stats |
Get detailed session statistics and phase progress |
POST |
/api/v1/sessions/:id/warmup |
Record warmup data collection (name, role, org, size) |
policy¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/rule-proposals |
Submit a rule proposal (companion trust-gated) |
POST |
/api/v1/rule-proposals/:id/ratify |
Human-ratify a proposal → active |
POST |
/api/v1/rule-proposals/:id/reject |
Human-reject a proposal |
POST |
/api/v1/rules |
Create a policy/governance rule (ACL+tier gated) |
POST |
/api/v1/rules/evaluate |
Evaluate a rule_type against a scope context |
GET |
/api/v1/rules/explain |
Explain the rules in effect + decision (for Maggie) |
GET |
/api/v1/rules/:id |
Get a rule by id |
DELETE |
/api/v1/rules/:id |
Revoke a rule |
POST |
/api/v1/rules/:id/overrides |
Mint a tiered, audited override |
policy_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/local/policies/:orgId |
Get organization routing policy |
PUT |
/api/v1/local/policies/:orgId |
Update routing policy |
pool¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/pool/:alias/operations |
Poll the most recent pool operation for an alias |
POST |
/api/v1/pool/:alias/operations |
Start a wake/rebase/park on a paeon-pool workspace (async; 202 + poll). Refuses any alias not tagged owner=paeon-pool |
GET |
/api/v1/pool/base |
Current shared sandbox base release (so Paeon needs no cluster-scoped namespace read) |
preferences¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/conversations/:id/model-preferences |
Set model preference for a conversation category (1-3 models with fallback) |
GET |
/api/v1/conversations/:id/model-preferences |
Get model preferences for a conversation |
DELETE |
/api/v1/conversations/:id/model-preferences/:category |
Remove model preference for a conversation category |
presentations¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/presentations |
List presentations |
POST |
/api/v1/presentations |
Create presentation |
DELETE |
/api/v1/presentations/:id |
Delete presentation |
GET |
/api/v1/presentations/:id |
Get presentation |
GET |
/api/v1/presentations/:id/download |
Download presentation file |
GET |
/api/v1/presentations/:id/status |
Get presentation status |
product¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/product/feature-requests |
Feature requests |
GET |
/api/v1/product/roadmap |
Product roadmap |
project_management¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/projects |
Create project |
GET |
/api/v1/projects |
List projects |
PUT |
/api/v1/projects/:id |
Update project |
DELETE |
/api/v1/projects/:id |
Delete project |
GET |
/api/v1/projects/:id |
Get project |
GET |
/api/v1/projects/:id/members |
Project members |
POST |
/api/v1/projects/:project_id/subprojects |
Create sub-project (child project) |
GET |
/api/v1/subprojects |
List subprojects |
GET |
/api/v1/users/:user_id/personal-project |
Personal project |
provenance¶
| Method | Path | Description |
|---|---|---|
DELETE |
/api/v1/conversations/:id |
Delete conversation |
PUT |
/api/v1/conversations/:id |
Update conversation |
GET |
/api/v1/conversations/:id |
Get conversation |
POST |
/api/v1/conversations/:id/pin |
Pin conversation |
POST |
/api/v1/conversations/:id/share |
Share conversation |
GET |
/api/v1/intents/:id |
Get intent |
GET |
/api/v1/messages/:id |
Get message |
providers¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/borg/providers/higgsfield/connect |
Connect an org's Higgsfield API keys |
DELETE |
/api/v1/borg/providers/higgsfield/connect |
Disconnect an org's Higgsfield keys |
GET |
/api/v1/borg/providers/higgsfield/status |
Check Higgsfield connection status |
POST |
/api/v1/borg/providers/higgsfield/verify |
Test Higgsfield API keys |
DELETE |
/api/v1/borg/providers/tripo/connect |
Disconnect an org's Tripo key |
POST |
/api/v1/borg/providers/tripo/connect |
Connect an org's Tripo API key |
GET |
/api/v1/borg/providers/tripo/status |
Check Tripo connection status |
POST |
/api/v1/borg/providers/tripo/verify |
Test Tripo API key |
provisioning¶
| Method | Path | Description |
|---|---|---|
DELETE |
/api/v1/orgs/:id |
Deprovision organization |
POST |
/api/v1/orgs/:id/provision |
Provision organization dashboards |
pulse¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/action-items |
List action items |
GET |
/api/v1/action-items/count |
Count items |
POST |
/api/v1/action-items/:id/resolve |
Resolve action |
GET |
/api/v1/tasks/active |
Active tasks |
GET |
/api/v1/tasks/:id/narration |
Task narration |
qualification¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/qualification-rules |
Create a qualification rule |
GET |
/api/v1/qualification-rules |
List qualification rules for organization |
DELETE |
/api/v1/qualification-rules/:id |
Delete a qualification rule |
PUT |
/api/v1/qualification-rules/:id |
Update a qualification rule |
POST |
/api/v1/qualify |
Run qualification rules against a submission |
registry¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/assets/ |
|
GET |
/api/v1/assets/ |
|
GET |
/api/v1/assets/by-name/:name |
|
GET |
/api/v1/assets/discovery/by-type |
|
GET |
/api/v1/assets/discovery/top-downloaded |
|
PUT |
/api/v1/assets/:id |
|
GET |
/api/v1/assets/:id |
|
POST |
/api/v1/assets/:id/download |
|
GET |
/api/v1/assets/:name/versions |
|
GET |
/api/v1/assets/statistics |
|
GET |
/api/v1/atlas/databases |
|
GET |
/api/v1/atlas/databases/:name/tables |
|
GET |
/api/v1/atlas/databases/:name/tables/:table |
|
GET |
/api/v1/atlas/riasec/:archetype |
|
GET |
/api/v1/atlas/search |
|
GET |
/api/v1/atlas/services/:name |
|
POST |
/api/v1/atlas/sync |
|
GET |
/api/v1/atlas/sync/status |
|
GET |
/api/v1/atlas/tables/:table/endpoints |
|
GET |
/api/v1/changelog/ |
|
POST |
/api/v1/changelog/ |
|
GET |
/api/v1/changelog/digest/daily |
|
GET |
/api/v1/changelog/:id |
|
POST |
/api/v1/changelog/:id/mark-sent |
|
GET |
/api/v1/changelog/subscriptions/ |
|
POST |
/api/v1/changelog/subscriptions/ |
|
PUT |
/api/v1/changelog/subscriptions/:id |
|
DELETE |
/api/v1/changelog/subscriptions/:id |
|
GET |
/api/v1/endpoints/ |
|
POST |
/api/v1/endpoints/ |
|
POST |
/api/v1/endpoints/bulk |
|
GET |
/api/v1/endpoints/discovery/by-capability |
|
GET |
/api/v1/endpoints/discovery/by-meaning |
|
GET |
/api/v1/endpoints/discovery/by-service |
|
GET |
/api/v1/endpoints/discovery/search |
|
POST |
/api/v1/endpoints/heartbeat |
|
GET |
/api/v1/endpoints/:id |
|
DELETE |
/api/v1/endpoints/:id |
|
PUT |
/api/v1/endpoints/:id |
|
PATCH |
/api/v1/endpoints/:id/deprecate |
|
GET |
/api/v1/endpoints/resolve |
|
DELETE |
/api/v1/endpoints/service/:name |
|
GET |
/api/v1/integrations/ |
|
POST |
/api/v1/integrations/ |
|
GET |
/api/v1/integrations/by-name/:name |
|
GET |
/api/v1/integrations/discovery/borg-ready |
|
GET |
/api/v1/integrations/discovery/by-type |
|
GET |
/api/v1/integrations/discovery/oauth |
|
GET |
/api/v1/integrations/:id |
|
PUT |
/api/v1/integrations/:id |
|
GET |
/api/v1/integrations/statistics |
|
GET |
/api/v1/orchestrations/ |
|
POST |
/api/v1/orchestrations/ |
|
GET |
/api/v1/orchestrations/by-name/:name |
|
GET |
/api/v1/orchestrations/discovery/by-category |
|
GET |
/api/v1/orchestrations/discovery/top-patterns |
|
GET |
/api/v1/orchestrations/discovery/validated |
|
PUT |
/api/v1/orchestrations/:id |
|
GET |
/api/v1/orchestrations/:id |
|
POST |
/api/v1/orchestrations/:id/executions |
|
POST |
/api/v1/orchestrations/:id/validate |
|
GET |
/api/v1/orchestrations/statistics |
|
POST |
/api/v1/utilities/ |
|
GET |
/api/v1/utilities/ |
|
GET |
/api/v1/utilities/by-name/:name |
|
GET |
/api/v1/utilities/discovery/by-category |
|
GET |
/api/v1/utilities/discovery/most-used |
|
GET |
/api/v1/utilities/discovery/top-rated |
|
GET |
/api/v1/utilities/:id |
|
PUT |
/api/v1/utilities/:id |
|
POST |
/api/v1/utilities/:id/usage |
|
GET |
/api/v1/utilities/statistics |
|
GET |
/api/v1/yields/ |
|
POST |
/api/v1/yields/ |
|
GET |
/api/v1/yields/by-name/:name |
|
GET |
/api/v1/yields/discovery/by-producer |
|
GET |
/api/v1/yields/discovery/by-type |
|
GET |
/api/v1/yields/discovery/top-quality |
|
PUT |
/api/v1/yields/:id |
|
GET |
/api/v1/yields/:id |
|
POST |
/api/v1/yields/:id/download |
|
POST |
/api/v1/yields/:id/validate |
|
GET |
/api/v1/yields/statistics |
rendering¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/render/pdf |
Internal endpoint to render HTML to PDF via Playwright |
repo_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/github/repos |
List the authenticated user's GitHub repos via their OAuth grant (repo-picker) |
POST |
/api/v1/borg/repos |
Start watching a GitHub repository for assimilation |
GET |
/api/v1/borg/repos |
List all watched repositories |
DELETE |
/api/v1/borg/repos/:id |
Stop watching a repository |
GET |
/api/v1/borg/repos/:id |
Get watched repository details |
PUT |
/api/v1/borg/repos/:id |
Update watched repository settings |
reputation_invites¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/reputation/invites |
Ask one contact for a review over a connected channel; runs consent, channel and cooldown gates |
GET |
/api/v1/reputation/invites |
List review invites with status filter and contact/rating join |
POST |
/api/v1/reputation/invites/:id/cancel |
Cancel a scheduled invite before it is sent |
reputation_reporting¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/reputation/summary |
Totals, average rating, rating distribution, source attribution, invite-to-review conversion and daily trend |
reputation_reviews¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/reputation/reviews |
The org's review inbox across every source, with rating and source filters |
reputation_settings¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/reputation/settings |
Read the org's review-solicitation policy (defaults returned when never configured) |
PUT |
/api/v1/reputation/settings |
Write the org's review-solicitation policy: channel, threshold, delays, templates, public review URLs |
reseller¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/reseller/analytics |
Aggregate portfolio stats for the reseller |
POST |
/api/v1/reseller/provision |
Provision full tenant stack (org + brand + admin + keys) |
GET |
/api/v1/reseller/tenants |
List organizations provisioned by this reseller |
resolution¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v2/models/resolve |
Resolve optimal model using 5-tier hierarchy + constraint filtering |
riasec_validation¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/browser/validate/archetype-performance |
Get RIASEC archetype performance metrics |
GET |
/api/v1/browser/validate/:id/status |
Get RIASEC validation status |
GET |
/api/v1/browser/validate/recent |
List recent RIASEC validations |
POST |
/api/v1/browser/validate/sprint |
Validate sprint deliverables with RIASEC |
GET |
/api/v1/browser/validate/statistics |
Get consensus statistics by organization |
POST |
/api/v1/browser/validate/workflow |
Validate browser workflow with RIASEC consensus protocol |
sales¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/sales/deals |
List deals |
GET |
/api/v1/sales/forecasting |
Sales forecasting |
GET |
/api/v1/sales/pipeline |
Sales pipeline |
search¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/search/assets |
Conversational asset search (hybrid RAG) |
GET |
/api/v1/universal-search/coverage |
Search coverage |
POST |
/api/v1/universal-search/full |
Full search |
POST |
/api/v1/universal-search/quick |
Quick search |
GET |
/api/v1/universal-search/recent |
Recent searches |
GET |
/api/v1/universal-search/saved |
Saved searches |
GET |
/api/v1/universal-search/suggest |
Suggestions |
secrets_internal¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/secrets/forget |
Crypto-shred an ENTIRE vault (destroys its backend key); service-to-service only; opt-in via SECRETS_FORGET_ENABLED |
POST |
/api/v1/secrets/resolve |
Resolve a secret_ref to its value; service-to-service only |
secrets_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/secrets |
List a vault's live secret metadata (no values) |
POST |
/api/v1/secrets |
Store a secret in a scoped vault; returns metadata + ref, never the value |
DELETE |
/api/v1/secrets/:id |
Permanently crypto-shred a secret; catalog row remains as a tombstone |
POST |
/api/v1/secrets/:id/move |
Move a secret to another vault (e.g. personal → project/org); re-encrypts under the target key |
GET |
/api/v1/secrets/:id/reveal |
Return a single secret value (audited) |
GET |
/api/v1/secrets/:id/reveal-shared |
Reveal a secret shared with the caller (audited; ACL-gated) |
POST |
/api/v1/secrets/:id/rotate |
Replace a secret's value; old value is crypto-shredded |
POST |
/api/v1/secrets/:id/shares |
Grant a specific user read-only access to one personal-vault secret (owner only) |
GET |
/api/v1/secrets/:id/shares |
List who a personal-vault secret is shared with (owner only) |
DELETE |
/api/v1/secrets/:id/shares/:userId |
Revoke a user's access to a shared secret (owner only) |
POST |
/api/v1/secrets/import |
Import selected source secrets into the caller's personal vault; org admin only |
POST |
/api/v1/secrets/import/file |
Import selected entries from an uploaded 1Password/LastPass CSV export into the caller's personal vault |
POST |
/api/v1/secrets/import/file/preview |
Parse an uploaded 1Password/LastPass CSV export and list entries (names only, never values) |
POST |
/api/v1/secrets/import/preview |
Enumerate a source's secrets (names/metadata only, never values) for selection; org admin only |
GET |
/api/v1/secrets/shared-with-me |
List secrets other users have shared with the caller (metadata only) |
GET |
/api/v1/vaults |
List vaults the caller can access (personal + org + projects/groups/apps) |
session_orchestration¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/session-groups |
Create session group for multi-browser orchestration |
GET |
/api/v1/session-groups/:id |
Get session group details |
POST |
/api/v1/session-groups/:id/actions |
Add action to session group |
POST |
/api/v1/session-groups/:id/execute |
Execute session group (parallel/sequential) |
POST |
/api/v1/session-groups/:id/sessions |
Add browser sessions to group |
settlement¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/plutus/settlements/accrue |
Idempotent double-entry credit of a creator's compute-margin share (CRED) |
storage¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/assets/:id |
Get asset metadata |
DELETE |
/api/v1/assets/:id |
Delete asset from GCS |
GET |
/api/v1/assets/:id/external-url |
Get GCS signed URL |
GET |
/api/v1/storage-policies/resolve |
Resolve effective storage policy for org/project/user/machine cascade |
POST |
/api/v1/upload |
Upload file to GCS |
summaries¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/files/:id/summaries |
Get LOD summaries for file |
sync_operations¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/borg/repos/:id/sync |
Manually trigger repository sync |
GET |
/api/v1/borg/repos/:id/sync/status |
Get the latest sync status for a repository |
GET |
/api/v1/borg/sync-logs |
List sync operation logs |
GET |
/api/v1/borg/sync/logs |
List sync operation logs |
GET |
/api/v1/borg/sync-logs/:id |
Get sync log detail |
task_execution¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/confirmations |
List confirmations |
GET |
/api/v1/confirmations/:id |
Get confirmation |
POST |
/api/v1/confirmations/:id/respond |
Respond |
task_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/task-model-usage |
Per-task AI model used (badge) |
POST |
/api/v1/tasks |
Create task |
GET |
/api/v1/tasks |
List tasks |
PATCH |
/api/v1/tasks/:id |
Update task |
GET |
/api/v1/tasks/:id |
Get task |
GET |
/api/v1/tasks/:id/tree |
Task tree |
POST |
/api/v3/tasks |
Create task v3 |
GET |
/api/v3/tasks |
List tasks v3 |
PATCH |
/api/v3/tasks/:id |
Update task v3 |
GET |
/api/v3/tasks/:id |
Get task v3 |
GET |
/api/v3/tasks/:id/tree |
Task tree v3 |
task_override¶
| Method | Path | Description |
|---|---|---|
PATCH |
/api/v1/tasks/:id/model |
Override AI model for a specific task |
task_spawning¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/spawn |
Manually spawn a task from intent parameters |
technology¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/technology/deployments |
Deployments |
GET |
/api/v1/technology/service-monitor |
Service monitor |
template_analytics¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/analytics/costs |
Get cost analytics |
GET |
/api/v1/templates/:id/analytics |
Get template usage analytics |
template_discovery¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/templates |
List available templates (public marketplace browsing) |
GET |
/api/v1/templates/:id |
Get template details by ID (public) |
template_instantiation¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/instances/:id |
Get template instance details |
POST |
/api/v1/instances/:id/execute |
Execute template instance |
POST |
/api/v1/templates/:id/instances |
Create template instance |
template_management¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/templates |
Create new template |
PUT |
/api/v1/templates/:id |
Update template |
GET |
/api/v1/templates/:id/versions |
List template versions |
POST |
/api/v1/templates/:id/versions |
Create new template version |
templates¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/templates |
List email templates |
temporal_schedules¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/schedules |
Create Temporal schedule |
DELETE |
/api/v1/schedules/:id |
Delete Temporal schedule |
temporal_workflows¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/workflows/:id/cancel |
Cancel Temporal workflow |
GET |
/api/v1/workflows/:id/status |
Get Temporal workflow status |
POST |
/api/v1/workflows/start |
Start Temporal workflow |
tenant_management¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/orgs |
Create a new organization |
GET |
/api/v1/orgs |
List organizations (scoped by role) |
GET |
/api/v1/orgs/:id |
Get organization by ID |
PUT |
/api/v1/orgs/:id |
Update organization fields |
DELETE |
/api/v1/orgs/:id |
Soft-delete (deactivate) an organization |
POST |
/api/v1/orgs/:id/apply-template |
Apply a vertical template to an organization |
GET |
/api/v1/orgs/:id/modules |
Get active modules for an organization |
PUT |
/api/v1/orgs/:id/modules |
Update active modules for an organization |
GET |
/api/v1/orgs/:id/vertical |
Get org vertical info (internal service use) |
GET |
/api/v1/templates |
List public vertical templates |
POST |
/api/v1/templates |
Create a new vertical template |
GET |
/api/v1/templates/:id |
Get vertical template by ID |
PUT |
/api/v1/templates/:id |
Update a vertical template |
theming¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/themes |
List available themes |
GET |
/api/v1/themes/:id |
Get theme definition |
GET |
/api/v1/uifrs/themes |
List available UI themes |
thread_management¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/threads |
Create a new message thread |
GET |
/api/v1/threads |
List all threads |
PUT |
/api/v1/threads/:id |
Update thread metadata |
GET |
/api/v1/threads/:id |
Get thread by ID |
GET |
/api/v1/threads/:id/messages |
Get all messages in a thread |
ui_composition¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/uifrs/modules |
List available UI modules |
POST |
/api/v1/uifrs/resolve |
Resolve a module route to a render manifest |
ui_self_host¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/uifrs/definitions/reset-to-base |
Re-pin the definition to the current Magieva Base and drop org overlays |
GET |
/api/v1/uifrs/definitions/resolve |
Resolve the org-scoped, versioned UI definition (Base ⊕ org ⊕ section) |
POST |
/api/v1/uifrs/definitions/rollback |
Activate a prior UI-definition version |
POST |
/api/v1/uifrs/definitions/versions |
Append an immutable UI-definition version (fork/edit) and activate it |
user_management¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/users/:id |
Get user by ID |
PUT |
/api/v1/users/:id |
Update user profile |
GET |
/api/v1/users/me |
Get current authenticated user profile |
GET |
/api/v1/users/me/admin-permissions |
Get current user's admin permissions |
GET |
/api/v1/users/me/settings |
My settings |
GET |
/api/v1/users/:user_id/orgs/:org_id/settings |
Org settings |
PATCH |
/api/v1/users/:user_id/orgs/:org_id/settings |
Update org settings |
GET |
/api/v1/users/:user_id/preferences |
Get preferences |
PUT |
/api/v1/users/:user_id/preferences |
Update preferences |
video_processing¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/process/video |
Process video (transcode, compress) |
POST |
/api/v1/sessions/:id/video/compress |
Compress video recording (low, medium, high quality) |
POST |
/api/v1/sessions/:id/video/convert |
Convert video format (mp4, webm, avi, mov) |
POST |
/api/v1/sessions/:id/video/trim |
Trim video recording by time range |
vnc_streaming¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/sessions/:id/viewer |
noVNC viewer HTML page |
GET |
/api/v1/sessions/:id/vnc |
WebSocket endpoint for VNC streaming (noVNC viewer) |
voice_analytics¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/analytics |
Get voice usage analytics |
voice_cloning¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/clone |
Initiate voice cloning for persona |
POST |
/api/v1/clone/:personaId/retry |
Retry failed voice cloning |
GET |
/api/v1/clone/:personaId/status |
Get voice cloning status |
voice_commands¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/trigger-commands |
List trigger commands |
POST |
/api/v1/trigger-commands |
Create trigger command |
DELETE |
/api/v1/trigger-commands/:id |
Delete trigger command |
PUT |
/api/v1/trigger-commands/:id |
Update trigger command |
voice_config¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/wake-word/config |
Get wake word detection configuration |
PUT |
/api/v1/wake-word/config |
Update wake word detection configuration |
voice_conversation¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/converse |
Bidirectional voice conversation |
POST |
/api/v1/converse-stream |
Streaming voice conversation with LLM acknowledgment |
voice_detection¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/voice/wake |
Process wake word detection |
voice_metadata¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/languages |
List supported languages |
GET |
/api/v1/providers |
List available STT providers |
voice_sessions¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/sessions |
List active voice sessions |
POST |
/api/v1/sessions |
Create new voice session |
DELETE |
/api/v1/sessions/:sessionId |
End voice session |
POST |
/api/v1/sessions/:sessionId/switch-provider |
Switch STT provider for session |
voice_settings¶
| Method | Path | Description |
|---|---|---|
PUT |
/api/v1/voice/settings |
Update voice detection settings |
GET |
/api/v1/voice/settings |
Get voice detection settings |
voice_streaming¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/voice/stream |
WebSocket for voice streaming |
voice_synthesis¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/tts |
Convert text to speech audio |
voice_transcription¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/transcribe |
One-shot metered speech-to-text |
watchers¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/borg/repos/:id/watchers |
List repository watchers |
POST |
/api/v1/borg/repos/:id/watchers |
Add a user as a repository watcher |
DELETE |
/api/v1/borg/repos/:id/watchers/:userId |
Remove a repository watcher |
webhooks¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/borg/webhook |
GitHub webhook endpoint for repo events |
POST |
/api/v1/borg/webhooks/github |
GitHub webhook endpoint for repository events |
POST |
/api/v1/webhooks/workflow-completed |
Webhook for workflow completion (called by workflow-orchestrator) |
workflow¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/workflows/active |
Active workflows |
POST |
/api/v1/workflows/checkpoints/:id/approve |
Approve checkpoint |
POST |
/api/v1/workflows/execute |
Execute workflow |
GET |
/api/v1/workflows/:id/status |
Workflow status |
POST |
/api/v1/workflows/tasks/:id/checkpoint |
Create checkpoint |
POST |
/api/v1/workflows/tasks/:id/outputs |
Store outputs |
workflow_composition¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/workflows/compose |
Dynamic workflow composition |
workflow_control¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/workflows/:id/pause |
Pause workflow execution |
POST |
/api/v1/workflows/:id/resume |
Resume workflow execution |
POST |
/api/v1/workflows/:id/steps/:step_id/retry |
Retry failed workflow step |
workflow_execution¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/sessions/:id/workflow/execute |
Execute workflow on browser session |
POST |
/api/v1/workflows/:id/execute |
Execute workflow |
workflow_generation¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/workflows/generate |
Generate browser workflow from natural language intent |
GET |
/api/v1/workflows/templates |
List available workflow templates |
GET |
/api/v1/workflows/templates/:id |
Get specific workflow template |
workflow_management¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/workflows |
Create new workflow |
GET |
/api/v1/workflows/:id |
Get workflow details |
GET |
/api/v1/workflows/:id/status |
Get workflow execution status |
GET |
/api/v1/workflows/:id/steps |
Get workflow steps |
workflow_optimization¶
| Method | Path | Description |
|---|---|---|
POST |
/api/v1/workflows/:id/optimize |
Optimize workflow execution plan |
workspace¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/workspaces |
List live + recent workspaces with running duration and modeled cost |
POST |
/api/v1/workspaces |
Spin up an ephemeral sandbox workspace for a feature (async); returns 202 + workspace id |
GET |
/api/v1/workspaces/costs |
Cost-per-feature rollup for the org (attribution report) |
DELETE |
/api/v1/workspaces/:id |
Destroy a workspace (full teardown) |
GET |
/api/v1/workspaces/:id |
Get one workspace: lifecycle, events, and cost-so-far |
POST |
/api/v1/workspaces/:id/park |
Scale a workspace to zero replicas (reversible, cheap) |
POST |
/api/v1/workspaces/:id/patch |
Apply an overlay change (patch a service image), subject to Overlay Admission |
POST |
/api/v1/workspaces/:id/unpark |
Scale a parked workspace back up |
POST |
/api/v1/workspaces/:id/validation-runs |
Record a visual validation run (browser-verify/companion-run/recording) against the workspace that spawned it |
workspaces¶
| Method | Path | Description |
|---|---|---|
GET |
/api/v1/workspaces |
List workspace layouts |
POST |
/api/v1/workspaces |
Create workspace layout |
GET |
/api/v1/workspaces/active |
Get active workspace layout |
DELETE |
/api/v1/workspaces/:id |
Delete workspace |
PATCH |
/api/v1/workspaces/:id |
Update workspace layout |
GET |
/api/v1/workspaces/:id |
Get workspace by ID |
GET |
/api/v1/workspaces/shared |
List workspaces shared with me |