# Data Model (/docs/data-model) What is data? [#what-is-data] Data in andibase starts with a **data definition**, such as `Customer`, `Order`, `Ticket`, or `PurchaseOrder`. Data definitions and their rows are the core unit that agents and apps read, update, and act on. Data shape [#data-shape] Each data definition includes a common base structure: * **id**: unique identifier for the record. * **name**: human-readable label. * **description**: optional context for people and agents. * **attributes**: the API field that stores your typed field definitions. In the docs, "fields" refers to the domain-specific properties you define for a data definition. In API payloads, those field definitions and field values live under the `attributes` key. **Data definition** (the schema): ```ts { key: "Order", name: "Order", description: "Represents a customer purchase order", attributes: { customerId: { type: "string", required: true }, amount: { type: "number", required: true }, status: { type: "string", required: true }, createdAt: { type: "datetime", required: true } } } ``` **Data row** (one row of data that follows that schema): ```ts { id: "ord_123", name: "Order #123", attributes: { customerId: "cus_789", amount: 1499, status: "pending", createdAt: "2026-03-05T12:00:00Z" } } ``` Data operations [#data-operations] Common record operations supported by andibase data: * **Get by id**: retrieve one data row by identifier. * **Append many**: insert multiple new data rows in bulk. * **Upsert**: create data rows if they do not exist, or update if they do. * **Update many**: update multiple data rows in one operation. * **Delete many**: remove multiple data rows in one operation. * **Query**: list data rows using filters, sorting, pagination, and other constraints. Lifecycle hooks [#lifecycle-hooks] Record operations now expose lifecycle phases in the service layer so custom logic can run consistently around reads and writes. Currently wired phases: * **before create** * **after create** * **before update** * **after update** * **before delete** * **after delete** * **before read** * **after read** The default implementation is currently a no-op. There is no persisted hook configuration or runtime execution layer yet. The intended next step is to back these hooks with a sandboxed runtime such as QuickJS. Hook contract [#hook-contract] Hooks are batch-oriented. Bulk create, update, delete, and list operations invoke one hook call per lifecycle phase with the full batch instead of one call per row. The hook payload includes the relevant state for that phase: * Create hooks receive the pending new rows. * Update hooks receive both the previous row state and the next row state. * Delete hooks receive the previous row state that is about to be deleted. * Read hooks receive the request shape, and post-read hooks receive the resolved records. Before hooks can rewrite the pending request payload. After hooks can inspect outcomes and, for create, update, and read, rewrite the records returned to callers. To block an action, hook implementations should reject with a typed application error: ```ts { code: "record_validation_failed", message: "Status transitions from archived to active are not allowed.", details: { field: "status", transition: "archived->active" } } ``` Those typed errors are surfaced back through the API as structured error payloads, currently using HTTP `400`, so apps can branch on `code` instead of parsing generic messages. Record events [#record-events] Every lifecycle phase also emits a typed record event through the central `RecordEventsService`. That event stream is intended to support: * external webhooks * automation triggers * internal subscribers that consume record activity centrally Auditing stays separate. The lifecycle event stream is for record-domain orchestration, not command audit storage. ## Documentation Navigation Use these paths to traverse the relevant docs and generated API reference files for the app. - Data Model [current] -> `/docs/data-model` (source: `content/docs/data-model.mdx`) - andibase Overview -> `/docs` (source: `content/docs/index.mdx`) - Get started (for AI Agents) -> `/docs/agent-get-started` (source: `content/docs/agent-get-started.mdx`) - Agent Tools -> `/docs/agent-tools` (source: `content/docs/agent-tools.mdx`) - Agents -> `/docs/agents` (source: `content/docs/agents.mdx`) - Agent Auth -> `/docs/api-reference/agent-auth` - Get agent login request -> `/docs/api-reference/agent-auth/get-api-v1-agent-auth-requests-usercode` - Exchange agent login -> `/docs/api-reference/agent-auth/post-api-v1-agent-auth-exchange` - Start agent login -> `/docs/api-reference/agent-auth/post-api-v1-agent-auth-requests` - Approve agent login -> `/docs/api-reference/agent-auth/post-api-v1-agent-auth-requests-usercode-approve` - Deny agent login -> `/docs/api-reference/agent-auth/post-api-v1-agent-auth-requests-usercode-deny` - Agents -> `/docs/api-reference/agents` - Delete workspace agent -> `/docs/api-reference/agents/delete-api-v1-agents-id` - List workspace agents -> `/docs/api-reference/agents/get-api-v1-agents` - Get workspace agent -> `/docs/api-reference/agents/get-api-v1-agents-id` - List agent chats -> `/docs/api-reference/agents/get-api-v1-agents-id-chats` - Get agent chat -> `/docs/api-reference/agents/get-api-v1-agents-id-chats-chatid` - Update workspace agent -> `/docs/api-reference/agents/patch-api-v1-agents-id` - Create workspace agent -> `/docs/api-reference/agents/post-api-v1-agents` - Send agent message -> `/docs/api-reference/agents/post-api-v1-agents-id-chats-chatid-messages` - Apps -> `/docs/api-reference/apps` - Delete app -> `/docs/api-reference/apps/delete-api-v1-apps-id` - List workspace apps -> `/docs/api-reference/apps/get-api-v1-apps` - Get app by id -> `/docs/api-reference/apps/get-api-v1-apps-id` - Update app -> `/docs/api-reference/apps/patch-api-v1-apps-id` - Create app -> `/docs/api-reference/apps/post-api-v1-apps` - Automations -> `/docs/api-reference/automations` - Delete workspace automation -> `/docs/api-reference/automations/delete-api-v1-automations-id` - List workspace automations -> `/docs/api-reference/automations/get-api-v1-automations` - Get workspace automation -> `/docs/api-reference/automations/get-api-v1-automations-id` - List automation runs -> `/docs/api-reference/automations/get-api-v1-automations-id-runs` - Get automation run -> `/docs/api-reference/automations/get-api-v1-automations-id-runs-runid` - Update workspace automation -> `/docs/api-reference/automations/patch-api-v1-automations-id` - Create workspace automation -> `/docs/api-reference/automations/post-api-v1-automations` - Run automation -> `/docs/api-reference/automations/post-api-v1-automations-id-run` - Trigger automation webhook -> `/docs/api-reference/automations/post-api-v1-automations-webhooks-publicid-secret` - Channels -> `/docs/api-reference/channels` - Delete channel -> `/docs/api-reference/channels/delete-api-v1-channels-channelid` - List channels -> `/docs/api-reference/channels/get-api-v1-channels` - Get channel -> `/docs/api-reference/channels/get-api-v1-channels-channelid` - Update channel -> `/docs/api-reference/channels/patch-api-v1-channels-channelid` - Create channel -> `/docs/api-reference/channels/post-api-v1-channels` - Data -> `/docs/api-reference/data` - Data Definitions -> `/docs/api-reference/data-definitions` - Delete data definition -> `/docs/api-reference/data-definitions/delete-api-v1-data-definitions-id` - List data definitions -> `/docs/api-reference/data-definitions/get-api-v1-data-definitions` - Get data definition -> `/docs/api-reference/data-definitions/get-api-v1-data-definitions-id` - Update data definition -> `/docs/api-reference/data-definitions/patch-api-v1-data-definitions-id` - Create data definition -> `/docs/api-reference/data-definitions/post-api-v1-data-definitions` - Data SQL Query -> `/docs/api-reference/data-sql-query` - Run SQL query against workspace data -> `/docs/api-reference/data-sql-query/post-api-v1-data-sql-query` - Get data by id -> `/docs/api-reference/data/get-api-v1-data-definitions-definitionid-data-id` - Select all data row ids -> `/docs/api-reference/data/get-api-v1-data-definitions-definitionid-data-select-all` - List data -> `/docs/api-reference/data/get-api-v1-data-definitions-definitionid-query` - Patch many data rows -> `/docs/api-reference/data/patch-api-v1-data-definitions-definitionid-data-patch-many` - Delete many data rows -> `/docs/api-reference/data/post-api-v1-data-definitions-definitionid-data-delete-many` - Upsert many data rows -> `/docs/api-reference/data/post-api-v1-data-definitions-definitionid-data-upsert-many` - DuckDB Query -> `/docs/api-reference/duckdb-query` - Run a DuckDB query against registered sources -> `/docs/api-reference/duckdb-query/post-api-v1-duckdb-query` - Explorer -> `/docs/api-reference/explorer` - Delete explorer folder -> `/docs/api-reference/explorer/delete-api-v1-workspace-nodes-nodeid` - List explorer nodes -> `/docs/api-reference/explorer/get-api-v1-workspace-nodes` - List explorer folders -> `/docs/api-reference/explorer/get-api-v1-workspace-nodes-folders` - Rename explorer folder -> `/docs/api-reference/explorer/patch-api-v1-workspace-nodes-nodeid-rename` - Create folder -> `/docs/api-reference/explorer/post-api-v1-workspace-nodes-folders` - Move explorer node -> `/docs/api-reference/explorer/post-api-v1-workspace-nodes-nodeid-move` - Files -> `/docs/api-reference/files` - List workspace files -> `/docs/api-reference/files/get-api-v1-files` - Read file content -> `/docs/api-reference/files/get-api-v1-files-fileid-content` - Create file -> `/docs/api-reference/files/post-api-v1-files` - Complete file upload -> `/docs/api-reference/files/post-api-v1-files-fileid-complete` - Presign multipart parts -> `/docs/api-reference/files/post-api-v1-files-fileid-parts` - Update file content -> `/docs/api-reference/files/put-api-v1-files-fileid-content` - Messages -> `/docs/api-reference/messages` - List channel messages -> `/docs/api-reference/messages/get-api-v1-channels-channelid-messages` - List thread messages -> `/docs/api-reference/messages/get-api-v1-channels-channelid-threads-threadid-messages` - Create channel message -> `/docs/api-reference/messages/post-api-v1-channels-channelid-messages` - Create thread message -> `/docs/api-reference/messages/post-api-v1-channels-channelid-threads-threadid-messages` - Notifications -> `/docs/api-reference/notifications` - List notification devices -> `/docs/api-reference/notifications/get-api-v1-notifications-devices` - Check Expo notification receipts -> `/docs/api-reference/notifications/post-api-v1-notifications-receipts` - Send workspace notifications -> `/docs/api-reference/notifications/post-api-v1-notifications-send` - Runs -> `/docs/api-reference/runs` - List workspace runs -> `/docs/api-reference/runs/get-api-v1-runs` - Get workspace run -> `/docs/api-reference/runs/get-api-v1-runs-runid` - Threads -> `/docs/api-reference/threads` - List channel threads -> `/docs/api-reference/threads/get-api-v1-channels-channelid-threads` - Get thread -> `/docs/api-reference/threads/get-api-v1-channels-channelid-threads-threadid` - Create thread -> `/docs/api-reference/threads/post-api-v1-channels-channelid-threads` - Workflows -> `/docs/api-reference/workflows` - Delete workflow definition -> `/docs/api-reference/workflows/delete-api-v1-workflows-id` - List workflow definitions -> `/docs/api-reference/workflows/get-api-v1-workflows` - Get workflow definition -> `/docs/api-reference/workflows/get-api-v1-workflows-id` - Update workflow definition -> `/docs/api-reference/workflows/patch-api-v1-workflows-id` - Create workflow definition -> `/docs/api-reference/workflows/post-api-v1-workflows` - Workspaces -> `/docs/api-reference/workspaces` - Delete workspace API key -> `/docs/api-reference/workspaces/delete-api-v1-workspaces-workspacehandle-api-keys-keyid` - Delete workspace credential -> `/docs/api-reference/workspaces/delete-api-v1-workspaces-workspacehandle-credentials-credentialid` - Delete workspace invitation -> `/docs/api-reference/workspaces/delete-api-v1-workspaces-workspacehandle-invitations-invitationid` - Delete workspace user -> `/docs/api-reference/workspaces/delete-api-v1-workspaces-workspacehandle-users-userid` - List my workspaces -> `/docs/api-reference/workspaces/get-api-v1-workspaces` - List workspace API keys -> `/docs/api-reference/workspaces/get-api-v1-workspaces-workspacehandle-api-keys` - List workspace credentials -> `/docs/api-reference/workspaces/get-api-v1-workspaces-workspacehandle-credentials` - List workspace credential tools -> `/docs/api-reference/workspaces/get-api-v1-workspaces-workspacehandle-credentials-credentialid-tools` - List workspace invitations -> `/docs/api-reference/workspaces/get-api-v1-workspaces-workspacehandle-invitations` - List workspace users -> `/docs/api-reference/workspaces/get-api-v1-workspaces-workspacehandle-users` - Create workspace -> `/docs/api-reference/workspaces/post-api-v1-workspaces` - Create workspace API key -> `/docs/api-reference/workspaces/post-api-v1-workspaces-workspacehandle-api-keys` - Create workspace credential -> `/docs/api-reference/workspaces/post-api-v1-workspaces-workspacehandle-credentials` - Invite user to workspace -> `/docs/api-reference/workspaces/post-api-v1-workspaces-workspacehandle-invitations` - Create workspace user -> `/docs/api-reference/workspaces/post-api-v1-workspaces-workspacehandle-users` - Apps -> `/docs/apps` (source: `content/docs/apps.mdx`) - Authentication -> `/docs/authentication` (source: `content/docs/authentication.mdx`) - Building Blocks -> `/docs/building-blocks` (source: `content/docs/building-blocks.mdx`) - Embedded Host Actions -> `/docs/embedded-host-actions` (source: `content/docs/embedded-host-actions.mdx`) - Introduction -> `/docs/introduction` (source: `content/docs/introduction.mdx`) - Recipes -> `/docs/receipes` (source: `content/docs/receipes/index.mdx`) - Construction Site Visit Agent -> `/docs/receipes/construction-site-visit-agent` (source: `content/docs/receipes/construction-site-visit-agent.mdx`) - Daily Lead Qualification Agent -> `/docs/receipes/daily-lead-qualification-agent` (source: `content/docs/receipes/daily-lead-qualification-agent.mdx`) - Day Planner Agent -> `/docs/receipes/day-planner-agent` (source: `content/docs/receipes/day-planner-agent.mdx`) - Expense Tracker -> `/docs/receipes/expense-tracker` (source: `content/docs/receipes/expense-tracker.mdx`) - Legal Case Tracker -> `/docs/receipes/legal-case-tracker` (source: `content/docs/receipes/legal-case-tracker.mdx`) - Spare Parts Request Agent -> `/docs/receipes/spare-parts-request-agent` (source: `content/docs/receipes/spare-parts-request-agent.mdx`) - Weekly Report Email Agent -> `/docs/receipes/weekly-report-email-agent` (source: `content/docs/receipes/weekly-report-email-agent.mdx`) - UI Components -> `/docs/ui-components` (source: `content/docs/ui-components.mdx`)