Applications
Data Storage
Collections
- GETList all collections for an app GET /api/apps/:app_id/collections
- POSTCreate a new collection POST /api/apps/:app_id/collections
- GETGet a specific collection GET /api/apps/:app_id/collections/:collection_id
- DELDelete a collection DELETE /api/apps/:app_id/collections/:collection_id
- PATCHPatch apiapps collections
- PATCHUpdate collection sharding configuration PATCH /api/apps/:app_id/collections/:collection_name/sharding
- GETAuto-generated collection query endpoint GET /api/apps/:app_id/collections/:collection/data
Retention
Encryption
Indexes
- GETGet all indexes for an app GET /api/apps/:app_id/indexes
- POSTCreate an index for an app POST /api/apps/:app_id/indexes
- GETGet quote for creating an encrypted index (x402 flow) GET /api/apps/:app_id/indexes/encrypted-quote
- DELDelete an index DELETE /api/apps/:app_id/indexes/:index_id
- POSTCreate a collection relation and automatically index join fields POST /api/apps/:app_id/relations
API Keys
- POSTList all API keys for an app POST /api/apps/:app_id/keys/list
- POSTRevoke a specific API key POST /api/apps/:app_id/keys/:key_hash/revoke
- POSTRegenerate an app API key (invalidates the old one) Or generate initial key if app doesn't have one yet POST /api/apps/:app_id/regenerate-key
- POSTRegister a new user API key POST /api/auth/register
Payout
Wallet
Authorization
Predefined Queries
- GETExecute a predefined query with parameters GET /api/queries/:app_id/:query_name/data
- GETGet Skills.md for discovery (reads from disk) GET /api/skills/:app_id/skills.md
- GETList all predefined queries for an app GET /apps/:app_id/queries
- POSTCreate a new predefined query POST /apps/:app_id/queries
- GETGet a specific predefined query definition GET /apps/:app_id/queries/:query_name
- DELDelete a predefined query DELETE /apps/:app_id/queries/:query_name
View Query
API Collections
- GETList all collections for an app (including API collections) GET /apps/:app_id/api_collections
- POSTCreate a new API collection POST /apps/:app_id/api_collections
- GETGet API collection details GET /apps/:app_id/api_collections/:collection_name
- DELDelete API collection DELETE /apps/:app_id/api_collections/:collection_name
Materialized Views
- GETList all materialized views for an app GET /apps/:app_id/views
- POSTCreate a new materialized view POST /apps/:app_id/views
- POSTHandler for SQL CREATE MATERIALIZED VIEW statements
- GETGet a specific materialized view GET /apps/:app_id/views/:view_name
- DELDelete a materialized view DELETE /apps/:app_id/views/:view_name
- POSTManually refresh a materialized view POST /apps/:app_id/views/:view_name/refresh
Get retention configuration for a collection
GET /api/apps/:app_id/collections/:collection/retention
Copy
curl --request GET \
--url https://api.example.com/api/apps/{app_id}/collections/{collection}/retentionRetention
Get retention configuration for a collection GET /api/apps/:app_id/collections/:collection/retention
GET
/
api
/
apps
/
{app_id}
/
collections
/
{collection}
/
retention
Get retention configuration for a collection
GET /api/apps/:app_id/collections/:collection/retention
Copy
curl --request GET \
--url https://api.example.com/api/apps/{app_id}/collections/{collection}/retentionAuto-generated collection query endpoint
GET /api/apps/:app_id/collections/:collection/dataSet retention configuration for a collection
POST /api/apps/:app_id/collections/:collection/retention
⌘I