Returns the interactive HTML API documentation.

Returns service status, version, deployment region, and timestamp.

{
  "success": true,
  "data": {
    "status": "...",
    "service": "...",
    "version": "...",
    "timestamp": "...",
    "region": "...",
    "uptime": "..."
  },
  "request_id": "..."
}

Returns the HTML landing page for the API.

Returns this OpenAPI 3.1 JSON specification.

{}

Lightweight probe for load balancer health checks.

{
  "success": true,
  "data": {
    "status": "ready",
    "service": "...",
    "timestamp": "..."
  },
  "request_id": "..."
}

Returns public-facing tenant configuration (branding, auth config). No auth required but tenant must be identifiable.

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Find tenants associated with an email address.

{
  "email": "..."
}

{
  "success": true,
  "data": [
    {
      "tenant_id": "...",
      "brand_name": "..."
    }
  ],
  "request_id": "..."
}

Receives Stripe webhook events. Verified using Stripe-Signature header. Handles checkout.session.completed, customer.subscription.updated, customer.subscription.deleted.

Get tenant usage

{
  "success": true,
  "data": {
    "tenant_id": "...",
    "plan_tier": {},
    "used_storage_bytes": 0,
    "plan_limits": {}
  },
  "request_id": "..."
}

List API keys

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create API key

{
  "label": "...",
  "scopes": [
    {}
  ],
  "ip_allowlist": [
    "..."
  ],
  "expires_at": null,
  "rate_limit": null
}

{
  "success": true,
  "data": {
    "key": {},
    "token": "..."
  },
  "request_id": "..."
}

Update API key

{
  "label": "...",
  "scopes": [
    {}
  ],
  "ip_allowlist": [
    "..."
  ],
  "rate_limit": null
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Revoke API key

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Rotate API key

{
  "label": "...",
  "scopes": [
    {}
  ]
}

{
  "success": true,
  "data": {
    "old_key": {},
    "new_key": {},
    "token": "..."
  },
  "request_id": "..."
}

List users

{
  "success": true,
  "data": {
    "users": [
      null
    ],
    "total": 0
  },
  "request_id": "..."
}

Create user

{
  "email": "...",
  "password": "...",
  "phone": "...",
  "role": "...",
  "email_verified": true,
  "user_metadata": {}
}

{
  "success": true,
  "data": null,
  "request_id": "..."
}

Get user

{
  "success": true,
  "data": null,
  "request_id": "..."
}

Update user

{
  "email": "...",
  "phone": "...",
  "role": "...",
  "banned": true,
  "ban_reason": "...",
  "email_verified": true,
  "user_metadata": {}
}

{
  "success": true,
  "data": null,
  "request_id": "..."
}

Delete user

{
  "success": true,
  "data": {
    "user_id": "...",
    "deleted": true
  },
  "request_id": "..."
}

• 409 — Dependency exists — dependent records must be removed first

List user MFA factors

{
  "success": true,
  "data": [
    null
  ],
  "request_id": "..."
}

Get auth config

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update auth config

{}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List webhooks

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create webhook

{
  "url": "...",
  "events": [
    "..."
  ],
  "object_types": [
    "..."
  ],
  "status": {}
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update webhook

{
  "url": "...",
  "events": [
    "..."
  ],
  "status": {}
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete webhook

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "..."
}

• 409 — Dependency exists — dependent records must be removed first

Replay webhook

{
  "event": "...",
  "payload": {}
}

{
  "success": true,
  "data": {
    "status_code": 0
  },
  "request_id": "..."
}

Rotate webhook secret

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Test webhook

{
  "success": true,
  "data": {
    "status_code": 0
  },
  "request_id": "..."
}

List webhook deliveries

{
  "success": true,
  "data": {
    "deliveries": [
      {}
    ],
    "total": 0
  },
  "request_id": "..."
}

Retry webhook delivery

{
  "success": true,
  "data": {
    "retried": true
  },
  "request_id": "..."
}

List access policies

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create access policy

{
  "name": "...",
  "action": "select",
  "role": null,
  "condition_json": {},
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update access policy

{
  "name": "...",
  "action": "...",
  "role": null,
  "condition_json": {},
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete access policy

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "..."
}

Get tenant analytics

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Analytics engine query

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List audit logs

{
  "success": true,
  "data": {
    "logs": [
      {}
    ],
    "total": 0
  },
  "request_id": "..."
}

Execute SQL query

{
  "sql": "...",
  "params": [
    null
  ]
}

{
  "success": true,
  "data": {
    "columns": [
      "..."
    ],
    "rows": [
      {}
    ],
    "row_count": 0,
    "duration_ms": 0
  },
  "request_id": "..."
}

Discard DLQ message

{
  "success": true,
  "data": {
    "discarded": true
  },
  "request_id": "..."
}

List DLQ messages

{
  "success": true,
  "data": {
    "messages": [
      {}
    ],
    "total": 0
  },
  "request_id": "..."
}

Retry DLQ message

{
  "success": true,
  "data": {
    "retried": true
  },
  "request_id": "..."
}

Get realtime stats

{
  "success": true,
  "data": {
    "total_connections": 0,
    "channels": {},
    "channel_count": 0
  },
  "request_id": "..."
}

Upgrades to a WebSocket connection for real-time event subscriptions. Uses Durable Objects with WebSocket Hibernation. Channels: objects:<type_id>, files, files:<folder>.

• 101 — WebSocket upgrade
• 426 — Not a WebSocket upgrade request

List forms

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create form

{
  "name": "...",
  "object_type_id": "...",
  "fields": [
    {}
  ],
  "settings": {}
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update form

{
  "name": "...",
  "fields": [
    {}
  ],
  "settings": {},
  "status": "active"
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete form

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "..."
}

Duplicate form

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Export form submissions

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get form analytics

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List form submissions

{
  "success": true,
  "data": {
    "submissions": [
      {}
    ],
    "total": 0
  },
  "request_id": "..."
}

List automations

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create automation

{
  "name": "...",
  "trigger_event": "...",
  "conditions": [
    {}
  ],
  "actions": [
    {}
  ],
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get automation

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update automation

{
  "name": "...",
  "trigger_event": "...",
  "conditions": [
    {}
  ],
  "actions": [
    {}
  ],
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete automation

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "..."
}

List automation runs

{
  "success": true,
  "data": {
    "runs": [
      {}
    ],
    "total": 0
  },
  "request_id": "..."
}

Trigger automation

{
  "data": {}
}

{
  "success": true,
  "data": {
    "run_id": "..."
  },
  "request_id": "..."
}

Assign permissions to role

{
  "permissions": [
    "..."
  ]
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Assign role to user

{
  "user_id": "...",
  "role_id": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List roles

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create role

{
  "name": "...",
  "description": "...",
  "parent_role_id": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get role

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update role

{
  "name": "...",
  "description": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete role

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "..."
}

List user roles

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Remove role from user

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get governance settings

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update governance settings

{
  "audit_retention_days": 0,
  "session_duration_secs": 0,
  "password_min_length": 0,
  "ip_allowlist": [
    "..."
  ]
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Simulate RLS policy

{
  "policy": {},
  "auth_context": {},
  "sample_data": [
    {}
  ]
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Access a publicly shared dashboard. No authentication required.

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Add widget to dashboard

{
  "type": "...",
  "title": "...",
  "config_json": {},
  "position_json": {}
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List dashboards

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create dashboard

{
  "name": "...",
  "description": "...",
  "layout_json": {},
  "is_public": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get dashboard

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update dashboard

{
  "name": "...",
  "description": "...",
  "layout_json": {},
  "is_public": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete dashboard

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "..."
}

Update widget

{
  "type": "...",
  "title": "...",
  "config_json": {},
  "position_json": {}
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete widget

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "..."
}

List scheduled jobs

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create scheduled job

{
  "name": "...",
  "description": "...",
  "cron_expression": "...",
  "run_at": "...",
  "action_type": "...",
  "action_config": {},
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get scheduled job

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update scheduled job

{
  "name": "...",
  "description": "...",
  "cron_expression": "...",
  "action_type": "...",
  "action_config": {},
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete scheduled job

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "..."
}

Execute scheduled job

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List saved reports

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create saved report

{
  "name": "...",
  "description": "...",
  "type": "...",
  "config_json": {},
  "schedule": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get saved report

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update saved report

{
  "name": "...",
  "description": "...",
  "config_json": {},
  "schedule": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete saved report

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "..."
}

Export saved report

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Run saved report

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List integrations

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create integration

{
  "provider": "...",
  "name": "...",
  "config_json": {},
  "sync_direction": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get integration

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update integration

{
  "name": "...",
  "config_json": {},
  "status": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete integration

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "..."
}

List sync logs

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Sync integration

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List custom functions

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create custom function

{
  "name": "...",
  "description": "...",
  "trigger_type": "...",
  "code": "...",
  "runtime": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get function

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update function

{
  "name": "...",
  "code": "...",
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete function

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "..."
}

Execute function

{
  "input": {}
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get plugin

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update plugin

{
  "name": "...",
  "config_json": {},
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Uninstall plugin

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "..."
}

List plugins

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Install plugin

{
  "name": "...",
  "version": "...",
  "manifest_json": {},
  "config_json": {},
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List function logs

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Get branding settings

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update branding

{
  "custom_domain": "...",
  "logo_url": "...",
  "favicon_url": "...",
  "primary_color": "...",
  "brand_name": "...",
  "footer_text": "...",
  "custom_css": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List AI providers

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create AI provider

{
  "name": "...",
  "provider_type": "...",
  "api_key": "...",
  "config_json": {}
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get AI provider

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update AI provider

{
  "name": "...",
  "api_key": "...",
  "config_json": {}
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete AI provider

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "..."
}

Get AI usage stats

{
  "success": true,
  "data": {},
  "request_id": "..."
}

List all object types for the authenticated tenant.

{
  "success": true,
  "data": [
    {
      "id": "ot_abc123",
      "tenant_id": "tn_xyz789",
      "name": "contacts",
      "display_name": "Contacts",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "request_id": "req_abc123"
}

Create a new object type (schema). Requires "schema" scope.

{
  "name": "contacts"
}

{
  "success": true,
  "data": {
    "id": "ot_abc123",
    "tenant_id": "tn_xyz789",
    "name": "contacts",
    "display_name": "Contacts",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-15T12:00:00Z"
  },
  "request_id": "req_abc123"
}

Get a single object type by ID.

{
  "success": true,
  "data": {
    "id": "ot_abc123",
    "tenant_id": "tn_xyz789",
    "name": "contacts",
    "display_name": "Contacts",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-15T12:00:00Z"
  },
  "request_id": "req_abc123"
}

Rename an object type. Requires "schema" scope.

{
  "name": "customers"
}

{
  "success": true,
  "data": {
    "id": "ot_abc123",
    "tenant_id": "tn_xyz789",
    "name": "contacts",
    "display_name": "Contacts",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-15T12:00:00Z"
  },
  "request_id": "req_abc123"
}

Permanently deletes the object type, all its properties, objects, and associated data. This is destructive and cannot be undone.

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "req_abc123"
}

List all properties defined on an object type.

{
  "success": true,
  "data": [
    {
      "id": "prop_abc123",
      "object_type_id": "ot_abc123",
      "name": "email",
      "data_type": "email",
      "is_indexed": false,
      "is_sortable": false,
      "is_unique": false,
      "is_required": false,
      "enum_values": null,
      "description": "Contact email address",
      "created_at": "2026-01-01T00:00:00Z"
    }
  ],
  "request_id": "req_abc123"
}

Add a typed field to an object type. Requires "schema" scope.

{
  "name": "email",
  "data_type": "string",
  "is_indexed": false,
  "is_sortable": false,
  "is_unique": false,
  "is_required": false,
  "default_value": null,
  "enum_values": [
    "..."
  ],
  "description": "..."
}

{
  "success": true,
  "data": {
    "id": "prop_abc123",
    "object_type_id": "ot_abc123",
    "name": "email",
    "data_type": "email",
    "is_indexed": false,
    "is_sortable": false,
    "is_unique": false,
    "is_required": false,
    "default_value": null,
    "enum_values": null,
    "description": "Contact email address",
    "created_at": "2026-01-01T00:00:00Z"
  },
  "request_id": "req_abc123"
}

Update property settings. Name and data_type cannot be changed.

{
  "is_indexed": true,
  "is_sortable": true,
  "is_unique": true,
  "is_required": true,
  "default_value": null,
  "description": "..."
}

{
  "success": true,
  "data": {
    "id": "prop_abc123",
    "object_type_id": "ot_abc123",
    "name": "email",
    "data_type": "email",
    "is_indexed": false,
    "is_sortable": false,
    "is_unique": false,
    "is_required": false,
    "default_value": null,
    "enum_values": null,
    "description": "Contact email address",
    "created_at": "2026-01-01T00:00:00Z"
  },
  "request_id": "req_abc123"
}

Delete a property from an object type. Existing values become untyped.

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "req_abc123"
}

Create up to 100 objects in a single request. Requires "write" scope.

{
  "objects": [
    {
      "properties": {
        "name": "Acme Corp",
        "email": "info@acme.com"
      }
    }
  ]
}

{
  "success": true,
  "data": {
    "created": 0,
    "ids": [
      "..."
    ]
  },
  "request_id": "req_abc123"
}

Create a new object of the given type. Requires "write" scope.

{
  "properties": {
    "name": "Acme Corp",
    "email": "info@acme.com"
  }
}

{
  "success": true,
  "data": {
    "id": "obj_abc123",
    "object_type_id": "ot_abc123",
    "tenant_id": "tn_xyz789",
    "properties": {
      "name": "Acme Corp",
      "email": "info@acme.com"
    },
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-15T12:00:00Z",
    "created_by": "usr_abc123",
    "version": 1,
    "is_deleted": false
  },
  "request_id": "req_abc123"
}

Retrieve a single object by type and ID.

{
  "success": true,
  "data": {
    "id": "obj_abc123",
    "object_type_id": "ot_abc123",
    "tenant_id": "tn_xyz789",
    "properties": {
      "name": "Acme Corp",
      "email": "info@acme.com"
    },
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-15T12:00:00Z",
    "created_by": "usr_abc123",
    "version": 1,
    "is_deleted": false
  },
  "request_id": "req_abc123"
}

Update properties on an existing object. Requires "write" scope.

{
  "properties": {
    "name": "Updated Name"
  }
}

{
  "success": true,
  "data": {
    "id": "obj_abc123",
    "object_type_id": "ot_abc123",
    "tenant_id": "tn_xyz789",
    "properties": {
      "name": "Acme Corp",
      "email": "info@acme.com"
    },
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-15T12:00:00Z",
    "created_by": "usr_abc123",
    "version": 1,
    "is_deleted": false
  },
  "request_id": "req_abc123"
}

Soft-delete an object (moves to trash). Use force=true for permanent deletion.

{
  "success": true,
  "data": {
    "id": "...",
    "deleted": true
  },
  "request_id": "req_abc123"
}

List objects of a given type with pagination, filtering, and sorting.

{
  "success": true,
  "data": {
    "results": [
      {
        "id": "...",
        "object_type_id": "...",
        "tenant_id": "...",
        "properties": "...",
        "created_at": "...",
        "updated_at": "...",
        "created_by": "...",
        "version": "...",
        "is_deleted": "..."
      }
    ],
    "next_cursor": "eyJpZCI6...",
    "total": 42
  },
  "request_id": "req_abc123"
}

Retrieve multiple objects by ID in a single request. Max 100 IDs.

{
  "object_ids": [
    "..."
  ]
}

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Update multiple objects in a single request. Max 100 items.

{
  "updates": [
    {
      "object_id": "...",
      "properties": {}
    }
  ]
}

{
  "success": true,
  "data": [
    {
      "object_id": "...",
      "version": 0
    }
  ],
  "request_id": "..."
}

List soft-deleted objects that can be restored.

{
  "success": true,
  "data": {
    "results": [
      {}
    ],
    "next_cursor": null,
    "total": 0
  },
  "request_id": "..."
}

Restore a soft-deleted object from trash.

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Filter and search objects with complex queries. Requires "read" scope.

{
  "filters": [
    {}
  ],
  "sort": "...",
  "order": "asc",
  "limit": 0,
  "cursor": "...",
  "query": "..."
}

{
  "success": true,
  "data": {
    "results": [
      {
        "id": "...",
        "object_type_id": "...",
        "tenant_id": "...",
        "properties": "...",
        "created_at": "...",
        "updated_at": "...",
        "created_by": "...",
        "version": "...",
        "is_deleted": "..."
      }
    ],
    "next_cursor": "eyJpZCI6...",
    "total": 42
  },
  "request_id": "req_abc123"
}

Run aggregate queries (count, sum, avg, min, max) on object properties with optional filtering and grouping.

{
  "aggregations": [
    {
      "function": "count",
      "property_id": "...",
      "alias": "..."
    }
  ],
  "filters": [
    {}
  ],
  "group_by": [
    "..."
  ]
}

{
  "success": true,
  "data": {
    "results": [
      {}
    ]
  },
  "request_id": "..."
}

List saved views (filter presets) for an object type.

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create a saved view with filters, sort, and column configuration.

{
  "name": "...",
  "filters": [
    {}
  ],
  "sort": {},
  "columns": [
    "..."
  ]
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update an existing saved view.

{
  "name": "...",
  "filters": [
    {}
  ],
  "sort": {},
  "columns": [
    "..."
  ]
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete a saved view.

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "..."
}

Create or replace an association between two objects. Optionally include a meta object (max 10KB).

{
  "meta": {}
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Remove an association between two objects.

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "..."
}

List associations for an object, optionally filtering by type and direction.

{
  "success": true,
  "data": {
    "results": [
      {}
    ],
    "next_cursor": null,
    "total": 0
  },
  "request_id": "..."
}

Delete multiple files in a single request. Max 100.

{
  "file_ids": [
    "..."
  ]
}

{
  "success": true,
  "data": {
    "deleted": [
      "..."
    ],
    "count": 0
  },
  "request_id": "..."
}

Retrieve metadata for multiple files by ID. Max 100.

{
  "file_ids": [
    "..."
  ]
}

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Update access or folder for multiple files. Max 100.

{
  "file_ids": [
    "..."
  ],
  "access": {},
  "folder": "..."
}

{
  "success": true,
  "data": {
    "updated": 0
  },
  "request_id": "..."
}

Marks a presigned upload as complete. Status changes from "pending" to "ready".

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Creates a time-limited, HMAC-signed URL for accessing private files without authentication.

{
  "expires_in": 0
}

{
  "success": true,
  "data": {
    "url": "...",
    "expires_at": "...",
    "ttl": 0
  },
  "request_id": "..."
}

Get metadata for a single file.

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update filename, access level, folder, meta, or linked object. Triggers file.updated webhook.

{
  "filename": "...",
  "access": {},
  "folder": "...",
  "meta": {},
  "object_type_id": null,
  "object_id": null
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Soft-delete a file. R2 object is cleaned up asynchronously. Triggers file.deleted webhook.

{
  "success": true,
  "data": {
    "file_id": "...",
    "deleted": true
  },
  "request_id": "..."
}

Returns raw binary content. Also accessible via signed URLs without Bearer auth when token/expires/t query params are present.

On-the-fly image transformation. Only for image files. Results are cached.

Get file storage usage and quota information.

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Returns a presigned URL for direct client-side upload to R2, bypassing the Worker size limit.

{
  "filename": "...",
  "mime_type": "...",
  "size_bytes": 0,
  "access": {},
  "folder": "...",
  "meta": {}
}

{
  "success": true,
  "data": {
    "file_id": "...",
    "r2_key": "...",
    "upload_endpoint": "...",
    "expires_at": "..."
  },
  "request_id": "..."
}

List soft-deleted files that can be restored.

{
  "success": true,
  "data": {
    "results": [
      {}
    ],
    "next_cursor": null,
    "total": 0
  },
  "request_id": "..."
}

Get the version history for a file.

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

List all file folders with counts and sizes.

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Restore a soft-deleted file from trash.

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Filter files by MIME type, access level, folder, filename, date range, and linked objects.

{
  "mime_type": "...",
  "mime_category": "...",
  "access": {},
  "status": {},
  "folder": "...",
  "filename": "...",
  "object_type_id": "...",
  "object_id": "...",
  "created_after": "...",
  "created_before": "...",
  "sort": "size_bytes",
  "sort_dir": {},
  "limit": 0,
  "cursor": null
}

{
  "success": true,
  "data": {
    "results": [
      {}
    ],
    "next_cursor": null,
    "total": 0
  },
  "request_id": "..."
}

Remove pending files older than 24 hours that were never completed.

{
  "success": true,
  "data": {
    "cleaned": 0
  },
  "request_id": "..."
}

Direct multipart upload. Max 25MB per file. For larger files, use the presigned URL flow.

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Upload raw file content for a presigned upload slot.

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Real-time SSE stream of object and file events.

List available event types

{
  "success": true,
  "data": [
    "..."
  ],
  "request_id": "..."
}

Track a custom event for analytics and automation triggers.

{
  "event_type": "...",
  "data": {}
}

{
  "success": true,
  "data": {
    "tracked": true
  },
  "request_id": "..."
}

List custom events

{
  "success": true,
  "data": {
    "events": [
      {}
    ],
    "total": 0
  },
  "request_id": "..."
}

Report a client-side error for tracking and alerting.

{
  "message": "...",
  "stack": "...",
  "source": "...",
  "level": "error",
  "path": "...",
  "metadata": {}
}

{
  "success": true,
  "data": {
    "error_id": "..."
  },
  "request_id": "..."
}

Returns all previous versions of an object, newest first.

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Download the exported data file.

"..."

Bulk import up to 10,000 rows from CSV, JSON file, or inline JSON body.

{
  "object_type_id": "...",
  "format": "json",
  "data": [
    {}
  ]
}

{
  "success": true,
  "data": {
    "imported": 0,
    "errors": [
      {}
    ],
    "total": 0
  },
  "request_id": "..."
}

Initiate an async export of all objects of a type. Max 100,000 records.

{
  "object_type_id": "...",
  "format": "json"
}

{
  "success": true,
  "data": {
    "export_id": "...",
    "format": "...",
    "record_count": 0,
    "download_path": "..."
  },
  "request_id": "..."
}

List comments on an object, newest first.

{
  "success": true,
  "data": {
    "results": [
      {}
    ],
    "next_cursor": null,
    "total": 0
  },
  "request_id": "..."
}

Add a comment to an object (activity feed). Requires authenticated user.

{
  "body": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Edit a comment. Only the author can edit their own comments.

{
  "body": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete a comment. Only the author can delete their own comments.

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "..."
}

Approve an object in the current workflow stage.

{
  "comment": "..."
}

{
  "success": true,
  "data": {
    "approved": true,
    "stage": "..."
  },
  "request_id": "..."
}

Get the current approval workflow status for an object.

{
  "success": true,
  "data": {
    "status": "...",
    "stage": "...",
    "history": [
      {}
    ]
  },
  "request_id": "..."
}

Reject an object in the current workflow stage.

{
  "reason": "..."
}

{
  "success": true,
  "data": {
    "rejected": true,
    "stage": "..."
  },
  "request_id": "..."
}

Submit an object for approval workflow review.

{
  "success": true,
  "data": {
    "submitted": true,
    "stage": "..."
  },
  "request_id": "..."
}

List workflows

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create workflow

{
  "name": "...",
  "stages": [
    {}
  ],
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update workflow

{
  "name": "...",
  "stages": [
    {}
  ],
  "enabled": true
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete workflow

{
  "success": true,
  "data": {
    "deleted": true
  },
  "request_id": "..."
}

• 409 — Dependency exists — dependent records must be removed first

Generate a multi-step funnel conversion report.

{
  "object_type_id": "...",
  "steps": [
    {
      "name": "...",
      "filters": [
        "..."
      ]
    }
  ]
}

{
  "success": true,
  "data": {
    "steps": [
      {}
    ]
  },
  "request_id": "..."
}

Generate a ranked leaderboard by a property value.

{
  "object_type_id": "...",
  "group_by": "...",
  "aggregation": "count",
  "value_property": "...",
  "limit": 0,
  "filters": [
    {}
  ]
}

{
  "success": true,
  "data": {
    "entries": [
      {}
    ]
  },
  "request_id": "..."
}

Generate a pipeline/funnel stage breakdown report.

{
  "object_type_id": "...",
  "stage_property": "...",
  "filters": [
    {}
  ]
}

{
  "success": true,
  "data": {
    "stages": [
      {}
    ]
  },
  "request_id": "..."
}

Generate a time series report with configurable intervals.

{
  "object_type_id": "...",
  "date_property": "...",
  "interval": "hour",
  "aggregation": "count",
  "value_property": "...",
  "filters": [
    {}
  ],
  "start_date": "...",
  "end_date": "..."
}

{
  "success": true,
  "data": {
    "series": [
      {}
    ]
  },
  "request_id": "..."
}

Send a transactional email using the tenant's configured email provider.

{
  "to": "...",
  "subject": "...",
  "html": "...",
  "text": "...",
  "from": "...",
  "reply_to": "..."
}

{
  "success": true,
  "data": {
    "sent": true,
    "message_id": "..."
  },
  "request_id": "..."
}

Automatically generate tags for an object based on its properties.

{
  "object_type_id": "...",
  "object_id": "..."
}

{
  "success": true,
  "data": {
    "tags": [
      "..."
    ]
  },
  "request_id": "..."
}

Generate a chat response with optional conversation history. Max 20 history messages, 50KB combined.

{
  "message": "...",
  "history": [
    {
      "role": "user",
      "content": "..."
    }
  ],
  "model": "..."
}

{
  "success": true,
  "data": {
    "response": "...",
    "model": "..."
  },
  "request_id": "..."
}

Chat with conversation history

{
  "message": "...",
  "model": "..."
}

{
  "success": true,
  "data": {
    "response": "...",
    "model": "..."
  },
  "request_id": "..."
}

Generate a text description of an image file stored in R2. Supports JPEG, PNG, WebP, GIF (max 10MB).

{
  "file_id": "...",
  "model": "..."
}

{
  "success": true,
  "data": {
    "description": "...",
    "filename": "...",
    "model": "..."
  },
  "request_id": "..."
}

Generate text from a prompt.

{
  "prompt": "...",
  "model": "...",
  "max_tokens": 0
}

{
  "success": true,
  "data": {
    "text": "...",
    "model": "..."
  },
  "request_id": "..."
}

Generate embeddings for objects and insert them into the Vectorize index. Max 100 per request.

{
  "object_type_id": "...",
  "object_ids": [
    "..."
  ]
}

{
  "success": true,
  "data": {
    "indexed": 0,
    "model": "...",
    "object_type_id": "..."
  },
  "request_id": "..."
}

Classify text content for policy violations.

{
  "text": "..."
}

{
  "success": true,
  "data": {
    "results": [
      {}
    ],
    "model": "..."
  },
  "request_id": "..."
}

Generate a summary of an object's text content.

{
  "object_type_id": "...",
  "object_id": "...",
  "max_length": 0
}

{
  "success": true,
  "data": {
    "summary": "..."
  },
  "request_id": "..."
}

Search the Vectorize index for objects semantically similar to the query.

{
  "query": "...",
  "limit": 0,
  "object_type_id": "..."
}

{
  "success": true,
  "data": {
    "results": [
      {}
    ],
    "model": "...",
    "dimensions": 0
  },
  "request_id": "..."
}

List AI conversations

{
  "success": true,
  "data": [
    {}
  ],
  "request_id": "..."
}

Create AI conversation

{
  "title": "...",
  "model": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Get AI conversation

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Update AI conversation

{
  "title": "..."
}

{
  "success": true,
  "data": {},
  "request_id": "..."
}

Delete AI conversation

{
  "success": true,
  "data": {
    "conversation_id": "...",
    "deleted": true
  },
  "request_id": "..."
}

Generate vector embeddings for one or more text inputs. Max 100 texts.

{
  "text": null,
  "model": "..."
}

{
  "success": true,
  "data": {
    "embeddings": [
      [
        0
      ]
    ],
    "model": "...",
    "dimensions": 0
  },
  "request_id": "..."
}

List available Cloudflare Workers AI models grouped by capability.

{
  "success": true,
  "data": {
    "text_generation": [
      "..."
    ],
    "text_embedding": [
      "..."
    ],
    "image_to_text": [
      "..."
    ],
    "text_classification": [
      "..."
    ]
  },
  "request_id": "..."
}

Create an anonymous user with a session. Can be linked to a real account later.

{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIs...",
    "refresh_token": "rt_abc123...",
    "token_type": "bearer",
    "expires_in": 3600,
    "user": {
      "id": "usr_abc123",
      "email": "user@example.com",
      "role": "authenticated"
    }
  },
  "request_id": "req_abc123"
}

Export all data associated with the authenticated user (GDPR-style). Rate-limited to once per hour.

{
  "success": true,
  "data": {
    "_meta": {
      "user_id": "...",
      "tenant_id": "...",
      "export_type": "user_data_export",
      "exported_at": "..."
    }
  },
  "request_id": "req_abc123"
}

Send a password reset email. Always returns 200 for security (anti-enumeration).

{
  "email": "user@example.com",
  "redirect_to": "...",
  "turnstile_token": "..."
}

{
  "success": true,
  "data": {
    "message": "..."
  },
  "request_id": "req_abc123"
}

Returns the currently authenticated user profile.

{
  "success": true,
  "data": {
    "id": "usr_abc123",
    "email": "user@example.com",
    "phone": "+15551234567",
    "role": "authenticated",
    "email_verified": true,
    "phone_verified": false,
    "user_metadata": {
      "name": "Jane Doe"
    },
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-15T12:00:00Z",
    "last_sign_in_at": "2026-03-20T10:00:00Z"
  },
  "request_id": "req_abc123"
}

Update email, phone, password, or metadata for the authenticated user.

{
  "email": "user@example.com",
  "phone": "...",
  "password": "...",
  "user_metadata": {}
}

{
  "success": true,
  "data": {
    "id": "usr_abc123",
    "email": "user@example.com",
    "phone": "+15551234567",
    "role": "authenticated",
    "email_verified": true,
    "phone_verified": false,
    "user_metadata": {
      "name": "Jane Doe"
    },
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-15T12:00:00Z",
    "last_sign_in_at": "2026-03-20T10:00:00Z"
  },
  "request_id": "req_abc123"
}

Authenticate with email and password. Returns session tokens or MFA challenge.

{
  "email": "user@example.com",
  "password": "...",
  "turnstile_token": "..."
}

{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIs...",
    "refresh_token": "rt_abc123...",
    "token_type": "bearer",
    "expires_in": 3600,
    "user": {
      "id": "usr_abc123",
      "email": "user@example.com",
      "role": "authenticated"
    }
  },
  "request_id": "req_abc123"
}

Revoke the current refresh token.

{
  "refresh_token": "..."
}

{
  "success": true,
  "data": {
    "message": "..."
  },
  "request_id": "req_abc123"
}

Handle OAuth provider callback. Creates or links user account.

{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIs...",
    "refresh_token": "rt_abc123...",
    "token_type": "bearer",
    "expires_in": 3600,
    "user": {
      "id": "usr_abc123",
      "email": "user@example.com",
      "role": "authenticated"
    }
  },
  "request_id": "req_abc123"
}

• 302 — Redirect to app

Redirect to OAuth provider (Google, GitHub, etc.) for authentication.

• 302 — Redirect to OAuth provider

Exchange a refresh token for new access and refresh tokens.

{
  "refresh_token": "..."
}

{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIs...",
    "refresh_token": "rt_abc123...",
    "token_type": "bearer",
    "expires_in": 3600,
    "user": {
      "id": "usr_abc123",
      "email": "user@example.com",
      "role": "authenticated"
    }
  },
  "request_id": "req_abc123"
}

Reset password using token from email. Revokes all refresh tokens.

{
  "token": "...",
  "password": "..."
}

{
  "success": true,
  "data": {
    "password_reset": true
  },
  "request_id": "req_abc123"
}

Send a passwordless magic-link login email.

{
  "email": "user@example.com",
  "redirect_to": "..."
}

{
  "success": true,
  "data": {
    "message": "..."
  },
  "request_id": "req_abc123"
}

Send a one-time password via SMS to an E.164 phone number.

{
  "phone": "..."
}

{
  "success": true,
  "data": {
    "message": "..."
  },
  "request_id": "req_abc123"
}

Create a new user account with email and password. Sends verification email.

{
  "email": "user@example.com",
  "password": "...",
  "phone": "...",
  "user_metadata": {},
  "turnstile_token": "..."
}

{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIs...",
    "refresh_token": "rt_abc123...",
    "token_type": "bearer",
    "expires_in": 3600,
    "user": {
      "id": "usr_abc123",
      "email": "user@example.com",
      "role": "authenticated"
    }
  },
  "request_id": "req_abc123"
}