# Docs

- [Introduction](/docs): Build on the Snoze platform — REST API, MCP server, and webhooks.
- [Authentication](/docs/authentication): Authenticate API and MCP requests with workspace API keys.
- REST API
  - [Overview](/docs/api): Conventions of the Snoze REST API.
  - [Items](/docs/api/items): The unified item model — every surface in Snoze is an item.
  - [Database records](/docs/api/records): Read, query, create, and update records in a Snoze database.
  - [Files](/docs/api/files): Upload files to a workspace and reference them anywhere.
  - [Errors](/docs/api/errors): The error envelope, stable codes, and how to retry safely.
  - [Rate limits](/docs/api/rate-limits): Per-key limits, 429 responses, and how to back off well.
- [MCP server](/docs/mcp): Connect AI agents and MCP clients to a Snoze workspace.
- [Webhooks](/docs/webhooks): Get pushed workspace events instead of polling for changes.
- API reference
  - Items
    - [List](/docs/reference/items/items.list)
    - [Create](/docs/reference/items/items.create)
    - [Get](/docs/reference/items/items.get)
    - [Update](/docs/reference/items/items.update)
    - [Delete](/docs/reference/items/items.delete)
  - Records
    - [List](/docs/reference/records/records.list)
    - [Create](/docs/reference/records/records.create)
    - [Get](/docs/reference/records/records.get)
    - [Update](/docs/reference/records/records.update)
    - [Delete](/docs/reference/records/records.delete)
  - Files
    - [Get](/docs/reference/files/files.get)
  - Api keys
    - [List](/docs/reference/api-keys/api-keys.list)
    - [Create](/docs/reference/api-keys/api-keys.create)
    - [Revoke](/docs/reference/api-keys/api-keys.revoke)
    - [List Request Logs](/docs/reference/api-keys/api-keys.listRequestLogs)
  - Backlinks
    - [Get Item Backlinks](/docs/reference/backlinks/backlinks.getItemBacklinks)
  - Notifications
    - [List](/docs/reference/notifications/notifications.list)
    - [Mark Read](/docs/reference/notifications/notifications.markRead)
  - Item share links
    - [List](/docs/reference/item-share-links/item-share-links.list)
    - [Create](/docs/reference/item-share-links/item-share-links.create)
    - [Revoke](/docs/reference/item-share-links/item-share-links.revoke)
    - [Resolve For Actor](/docs/reference/item-share-links/item-share-links.resolveForActor)
  - Public shares
    - [Resolve](/docs/reference/public-shares/public-shares.resolve)
    - [Comment](/docs/reference/public-shares/public-shares.comment)
  - Share links
    - [List](/docs/reference/share-links/share-links.list)
    - [Create](/docs/reference/share-links/share-links.create)
    - [Revoke](/docs/reference/share-links/share-links.revoke)
  - Surface history
    - [List](/docs/reference/surface-history/surface-history.list)
    - [At Version](/docs/reference/surface-history/surface-history.atVersion)
    - [Restore](/docs/reference/surface-history/surface-history.restore)
  - Onboarding
    - [List Offers](/docs/reference/onboarding/onboarding.listOffers)
    - [Accept Legacy Claim](/docs/reference/onboarding/onboarding.acceptLegacyClaim)
    - [Skip Legacy Claim](/docs/reference/onboarding/onboarding.skipLegacyClaim)
  - Workspaces
    - [List](/docs/reference/workspaces/workspaces.list)
    - [Create](/docs/reference/workspaces/workspaces.create)
    - [Apply Starter](/docs/reference/workspaces/workspaces.applyStarter)
    - [Get](/docs/reference/workspaces/workspaces.get)
    - [Update](/docs/reference/workspaces/workspaces.update)
    - [Remove](/docs/reference/workspaces/workspaces.remove)
    - [List Events](/docs/reference/workspaces/workspaces.listEvents)
    - [List Members](/docs/reference/workspaces/workspaces.listMembers)
    - [Update Member](/docs/reference/workspaces/workspaces.updateMember)
    - [Remove Member](/docs/reference/workspaces/workspaces.removeMember)
    - [List Invites](/docs/reference/workspaces/workspaces.listInvites)
    - [Create Invite](/docs/reference/workspaces/workspaces.createInvite)
    - [List My Invites](/docs/reference/workspaces/workspaces.listMyInvites)
    - [Update Invite](/docs/reference/workspaces/workspaces.updateInvite)
    - [Revoke Invite](/docs/reference/workspaces/workspaces.revokeInvite)
    - [Preview Invite](/docs/reference/workspaces/workspaces.previewInvite)
    - [Accept Invite](/docs/reference/workspaces/workspaces.acceptInvite)
    - [Accept My Invite](/docs/reference/workspaces/workspaces.acceptMyInvite)
  - Roles
    - [List](/docs/reference/roles/roles.list)
    - [Create](/docs/reference/roles/roles.create)
    - [Update](/docs/reference/roles/roles.update)
    - [Remove](/docs/reference/roles/roles.remove)
    - [Assign](/docs/reference/roles/roles.assign)
  - User preferences
    - [Get](/docs/reference/user-preferences/user-preferences.get)
    - [Toggle Item Pinned](/docs/reference/user-preferences/user-preferences.toggleItemPinned)
    - [Set Item Order](/docs/reference/user-preferences/user-preferences.setItemOrder)
    - [Set Home Layout](/docs/reference/user-preferences/user-preferences.setHomeLayout)
  - Item access
    - [Get](/docs/reference/item-access/item-access.get)
    - [Invite](/docs/reference/item-access/item-access.invite)
    - [Update Grant](/docs/reference/item-access/item-access.updateGrant)
    - [Remove Grant](/docs/reference/item-access/item-access.removeGrant)
    - [Claim Guest Grants](/docs/reference/item-access/item-access.claimGuestGrants)
  - Databases
    - [List](/docs/reference/databases/databases.list)
    - [Create](/docs/reference/databases/databases.create)
    - [Get](/docs/reference/databases/databases.get)
    - [Update](/docs/reference/databases/databases.update)
    - [Delete](/docs/reference/databases/databases.delete)
    - [Deletion Impact](/docs/reference/databases/databases.deletionImpact)
    - [List Fields](/docs/reference/databases/databases.listFields)
    - [Create Field](/docs/reference/databases/databases.createField)
    - [Update Field](/docs/reference/databases/databases.updateField)
    - [Delete Field](/docs/reference/databases/databases.deleteField)
    - [List Records](/docs/reference/databases/databases.listRecords)
    - [Create Record](/docs/reference/databases/databases.createRecord)
    - [Record Window](/docs/reference/databases/databases.recordWindow)
    - [Aggregate Records](/docs/reference/databases/databases.aggregateRecords)
    - [Get Record](/docs/reference/databases/databases.getRecord)
    - [Update Record](/docs/reference/databases/databases.updateRecord)
    - [Delete Record](/docs/reference/databases/databases.deleteRecord)
    - [Ensure Record Content Surface](/docs/reference/databases/databases.ensureRecordContentSurface)
    - [List Record Comments](/docs/reference/databases/databases.listRecordComments)
    - [Create Record Comment](/docs/reference/databases/databases.createRecordComment)
    - [Delete Record Comment](/docs/reference/databases/databases.deleteRecordComment)
    - [List Record Events](/docs/reference/databases/databases.listRecordEvents)
    - [List Views](/docs/reference/databases/databases.listViews)
    - [Create View](/docs/reference/databases/databases.createView)
    - [Update View](/docs/reference/databases/databases.updateView)
    - [Delete View](/docs/reference/databases/databases.deleteView)
    - [View Deletion Impact](/docs/reference/databases/databases.viewDeletionImpact)
  - Database templates
    - [List Templates](/docs/reference/database-templates/database-templates.listTemplates)
    - [Create Template](/docs/reference/database-templates/database-templates.createTemplate)
    - [Update Template](/docs/reference/database-templates/database-templates.updateTemplate)
    - [Delete Template](/docs/reference/database-templates/database-templates.deleteTemplate)
    - [Instantiate Template](/docs/reference/database-templates/database-templates.instantiateTemplate)
    - [Duplicate Database](/docs/reference/database-templates/database-templates.duplicateDatabase)
    - [List Record Templates](/docs/reference/database-templates/database-templates.listRecordTemplates)
    - [Create Record Template](/docs/reference/database-templates/database-templates.createRecordTemplate)
    - [Update Record Template](/docs/reference/database-templates/database-templates.updateRecordTemplate)
    - [Delete Record Template](/docs/reference/database-templates/database-templates.deleteRecordTemplate)
    - [Instantiate Record Template](/docs/reference/database-templates/database-templates.instantiateRecordTemplate)
    - [Duplicate Record](/docs/reference/database-templates/database-templates.duplicateRecord)
    - [Import Csv](/docs/reference/database-templates/database-templates.importCsv)
    - [Export Csv](/docs/reference/database-templates/database-templates.exportCsv)
  - Database publish
    - [Get Config](/docs/reference/database-publish/database-publish.getConfig)
    - [Unpublish](/docs/reference/database-publish/database-publish.unpublish)
    - [Publish](/docs/reference/database-publish/database-publish.publish)
  - Public databases
    - [Get Published](/docs/reference/public-databases/public-databases.getPublished)
  - Gantt
    - [List Dependencies](/docs/reference/gantt/gantt.listDependencies)
    - [Create Dependency](/docs/reference/gantt/gantt.createDependency)
    - [Delete Dependency](/docs/reference/gantt/gantt.deleteDependency)
  - Actions
    - [List Connector Operations](/docs/reference/actions/actions.listConnectorOperations)
    - [List](/docs/reference/actions/actions.list)
    - [Create](/docs/reference/actions/actions.create)
    - [Get](/docs/reference/actions/actions.get)
    - [Update](/docs/reference/actions/actions.update)
    - [Remove](/docs/reference/actions/actions.remove)
    - [Run](/docs/reference/actions/actions.run)
    - [List Runs](/docs/reference/actions/actions.listRuns)
    - [Run Database Button](/docs/reference/actions/actions.runDatabaseButton)
  - Automations
    - [List](/docs/reference/automations/automations.list)
    - [Create](/docs/reference/automations/automations.create)
    - [Get](/docs/reference/automations/automations.get)
    - [Update](/docs/reference/automations/automations.update)
    - [Remove](/docs/reference/automations/automations.remove)
    - [Run](/docs/reference/automations/automations.run)
    - [Run From Node](/docs/reference/automations/automations.runFromNode)
    - [List Runs](/docs/reference/automations/automations.listRuns)
    - [Publish](/docs/reference/automations/automations.publish)
    - [List Versions](/docs/reference/automations/automations.listVersions)
    - [Restore Version](/docs/reference/automations/automations.restoreVersion)
    - [List Templates](/docs/reference/automations/automations.listTemplates)
    - [Create Template](/docs/reference/automations/automations.createTemplate)
    - [Remove Template](/docs/reference/automations/automations.removeTemplate)
    - [Operations](/docs/reference/automations/automations.operations)
    - [List Dead Letters](/docs/reference/automations/automations.listDeadLetters)
    - [Replay Dead Letter](/docs/reference/automations/automations.replayDeadLetter)
    - [Acknowledge Dead Letter](/docs/reference/automations/automations.acknowledgeDeadLetter)
    - [Rotate Webhook Secret](/docs/reference/automations/automations.rotateWebhookSecret)
    - [Get Run](/docs/reference/automations/automations.getRun)
    - [Cancel Run](/docs/reference/automations/automations.cancelRun)
    - [Retry Run](/docs/reference/automations/automations.retryRun)
    - [Resume Node](/docs/reference/automations/automations.resumeNode)
    - [Replay Node](/docs/reference/automations/automations.replayNode)
  - Outbound webhooks
    - [List](/docs/reference/outbound-webhooks/outbound-webhooks.list)
    - [Create](/docs/reference/outbound-webhooks/outbound-webhooks.create)
    - [Update](/docs/reference/outbound-webhooks/outbound-webhooks.update)
    - [Remove](/docs/reference/outbound-webhooks/outbound-webhooks.remove)
    - [List Deliveries](/docs/reference/outbound-webhooks/outbound-webhooks.listDeliveries)
    - [Replay Delivery](/docs/reference/outbound-webhooks/outbound-webhooks.replayDelivery)
  - Inbound webhooks
    - [List](/docs/reference/inbound-webhooks/inbound-webhooks.list)
    - [Create](/docs/reference/inbound-webhooks/inbound-webhooks.create)
    - [Update](/docs/reference/inbound-webhooks/inbound-webhooks.update)
    - [Remove](/docs/reference/inbound-webhooks/inbound-webhooks.remove)
    - [List Deliveries](/docs/reference/inbound-webhooks/inbound-webhooks.listDeliveries)
  - Product controls
    - [Get Feature](/docs/reference/product-controls/product-controls.getFeature)
    - [Get Experiment](/docs/reference/product-controls/product-controls.getExperiment)
  - Surfaces
    - [Create](/docs/reference/surfaces/surfaces.create)
    - [Get](/docs/reference/surfaces/surfaces.get)
    - [Update](/docs/reference/surfaces/surfaces.update)
    - [Delete](/docs/reference/surfaces/surfaces.delete)
    - [Get Deletion Impact](/docs/reference/surfaces/surfaces.getDeletionImpact)
    - [List Blocks](/docs/reference/surfaces/surfaces.listBlocks)
    - [Apply Block Ops](/docs/reference/surfaces/surfaces.applyBlockOps)
    - [List Comments](/docs/reference/surfaces/surfaces.listComments)
    - [Create Block Comment](/docs/reference/surfaces/surfaces.createBlockComment)
    - [Resolve Comment](/docs/reference/surfaces/surfaces.resolveComment)
    - [Delete Comment](/docs/reference/surfaces/surfaces.deleteComment)
  - Canvas
    - [List Elements](/docs/reference/canvas/canvas.listElements)
    - [Apply Ops](/docs/reference/canvas/canvas.applyOps)
  - Resources
    - [List](/docs/reference/resources/resources.list)
    - [Create](/docs/reference/resources/resources.create)
    - [Update](/docs/reference/resources/resources.update)
    - [Delete](/docs/reference/resources/resources.delete)
    - [Get Deletion Impact](/docs/reference/resources/resources.getDeletionImpact)
  - Page publish
    - [Get Config](/docs/reference/page-publish/page-publish.getConfig)
    - [Unpublish](/docs/reference/page-publish/page-publish.unpublish)
    - [Publish](/docs/reference/page-publish/page-publish.publish)
    - [Get Embed Data](/docs/reference/page-publish/page-publish.getEmbedData)
  - Public pages
    - [Get Published](/docs/reference/public-pages/public-pages.getPublished)
  - Data sources
    - [List](/docs/reference/data-sources/data-sources.list)
    - [Create](/docs/reference/data-sources/data-sources.create)
    - [Preview](/docs/reference/data-sources/data-sources.preview)
    - [Get](/docs/reference/data-sources/data-sources.get)
    - [Update](/docs/reference/data-sources/data-sources.update)
    - [Delete](/docs/reference/data-sources/data-sources.delete)
    - [Deletion Impact](/docs/reference/data-sources/data-sources.deletionImpact)
    - [Refresh](/docs/reference/data-sources/data-sources.refresh)
    - [List Runs](/docs/reference/data-sources/data-sources.listRuns)
  - Connections
    - [List](/docs/reference/connections/connections.list)
    - [Create](/docs/reference/connections/connections.create)
    - [Delete](/docs/reference/connections/connections.delete)
  - Model sources
    - [List](/docs/reference/model-sources/model-sources.list)
    - [Create](/docs/reference/model-sources/model-sources.create)
    - [Validate Key](/docs/reference/model-sources/model-sources.validateKey)
    - [Update](/docs/reference/model-sources/model-sources.update)
    - [Delete](/docs/reference/model-sources/model-sources.delete)
    - [List Models](/docs/reference/model-sources/model-sources.listModels)
  - Link preview
    - [Get](/docs/reference/link-preview/link-preview.get)
  - Time tracking
    - [Active Entry](/docs/reference/time-tracking/time-tracking.activeEntry)
    - [Start](/docs/reference/time-tracking/time-tracking.start)
    - [Manual](/docs/reference/time-tracking/time-tracking.manual)
    - [List](/docs/reference/time-tracking/time-tracking.list)
    - [Timesheet](/docs/reference/time-tracking/time-tracking.timesheet)
    - [Get](/docs/reference/time-tracking/time-tracking.get)
    - [Update](/docs/reference/time-tracking/time-tracking.update)
    - [Delete](/docs/reference/time-tracking/time-tracking.delete)
    - [Pause](/docs/reference/time-tracking/time-tracking.pause)
    - [Resume](/docs/reference/time-tracking/time-tracking.resume)
    - [Stop](/docs/reference/time-tracking/time-tracking.stop)
    - [Abandon](/docs/reference/time-tracking/time-tracking.abandon)
  - Tools
    - [List](/docs/reference/tools/tools.list)
    - [Invoke](/docs/reference/tools/tools.invoke)
  - Rag
    - [Ingest](/docs/reference/rag/rag.ingest)
    - [List Models](/docs/reference/rag/rag.listModels)
    - [List Sources](/docs/reference/rag/rag.listSources)
    - [Set Sources](/docs/reference/rag/rag.setSources)
    - [Search](/docs/reference/rag/rag.search)
  - Ai
    - [List Models](/docs/reference/ai/ai.listModels)
  - Ai database
    - [Plan](/docs/reference/ai-database/ai-database.plan)
    - [Apply](/docs/reference/ai-database/ai-database.apply)
    - [Get Run](/docs/reference/ai-database/ai-database.getRun)
    - [List Runs](/docs/reference/ai-database/ai-database.listRuns)
  - Agent
    - [List Chats](/docs/reference/agent/agent.listChats)
    - [Create Chat](/docs/reference/agent/agent.createChat)
    - [Get Transcript](/docs/reference/agent/agent.getTranscript)
    - [Update Chat](/docs/reference/agent/agent.updateChat)
    - [Start Message](/docs/reference/agent/agent.startMessage)
    - [Start Edit Message](/docs/reference/agent/agent.startEditMessage)
    - [Start Regenerate Message](/docs/reference/agent/agent.startRegenerateMessage)
    - [Resume Tool](/docs/reference/agent/agent.resumeTool)
    - [Cancel Run](/docs/reference/agent/agent.cancelRun)
    - [Switch Version](/docs/reference/agent/agent.switchVersion)
    - [Branch Chat](/docs/reference/agent/agent.branchChat)
  - Assets
    - [List](/docs/reference/assets/assets.list)
    - [Get Metadata](/docs/reference/assets/assets.getMetadata)
    - [Delete](/docs/reference/assets/assets.delete)
    - [Rotate Access Key](/docs/reference/assets/assets.rotateAccessKey)
  - Integrations
    - [List Providers](/docs/reference/integrations/integrations.listProviders)
    - [Start Install](/docs/reference/integrations/integrations.startInstall)
    - [List Connections](/docs/reference/integrations/integrations.listConnections)
    - [Create Connection](/docs/reference/integrations/integrations.createConnection)
    - [Get Connection](/docs/reference/integrations/integrations.getConnection)
    - [Update Connection](/docs/reference/integrations/integrations.updateConnection)
    - [Delete Connection](/docs/reference/integrations/integrations.deleteConnection)
    - [Run Sync](/docs/reference/integrations/integrations.runSync)
    - [List Sync Runs](/docs/reference/integrations/integrations.listSyncRuns)
    - [Browse Resources](/docs/reference/integrations/integrations.browseResources)
    - [Sync Folder Children](/docs/reference/integrations/integrations.syncFolderChildren)
    - [List Resources](/docs/reference/integrations/integrations.listResources)
    - [Get Resource Content](/docs/reference/integrations/integrations.getResourceContent)
    - [Read Resource Ref](/docs/reference/integrations/integrations.readResourceRef)
    - [Get Placement](/docs/reference/integrations/integrations.getPlacement)
    - [Unlink Placement](/docs/reference/integrations/integrations.unlinkPlacement)
    - [Link Resource](/docs/reference/integrations/integrations.linkResource)
    - [Mount Resource](/docs/reference/integrations/integrations.mountResource)
    - [List Operations](/docs/reference/integrations/integrations.listOperations)
    - [Execute Operation](/docs/reference/integrations/integrations.executeOperation)
    - [List Operation Runs](/docs/reference/integrations/integrations.listOperationRuns)
  - Auth
    - [Me](/docs/reference/auth/auth.me)
  - Billing
    - [Get Subscription](/docs/reference/billing/billing.getSubscription)
    - [Get Plan Catalog](/docs/reference/billing/billing.getPlanCatalog)
    - [Get Ai Usage](/docs/reference/billing/billing.getAiUsage)
    - [Get Billing Detail](/docs/reference/billing/billing.getBillingDetail)
    - [Change Plan](/docs/reference/billing/billing.changePlan)
    - [Get Ai Seats](/docs/reference/billing/billing.getAiSeats)
    - [Set Ai Seat](/docs/reference/billing/billing.setAiSeat)
    - [Create Checkout](/docs/reference/billing/billing.createCheckout)
    - [Customer Portal](/docs/reference/billing/billing.customerPortal)
    - [Get Public Pricing](/docs/reference/billing/billing.getPublicPricing)
  - Admin
    - [Bootstrap Status](/docs/reference/admin/admin.bootstrapStatus)
    - [Create Bootstrap Owner](/docs/reference/admin/admin.createBootstrapOwner)
    - [Get Bootstrap](/docs/reference/admin/admin.getBootstrap)
    - [Get Dashboard](/docs/reference/admin/admin.getDashboard)
    - [List Flags](/docs/reference/admin/admin.listFlags)
    - [Create Flag](/docs/reference/admin/admin.createFlag)
    - [Update Flag](/docs/reference/admin/admin.updateFlag)
    - [List Experiments](/docs/reference/admin/admin.listExperiments)
    - [Create Experiment](/docs/reference/admin/admin.createExperiment)
    - [Update Experiment](/docs/reference/admin/admin.updateExperiment)
    - [List Segments](/docs/reference/admin/admin.listSegments)
    - [Create Segment](/docs/reference/admin/admin.createSegment)
    - [List Audit Events](/docs/reference/admin/admin.listAuditEvents)
    - [List Runs](/docs/reference/admin/admin.listRuns)
    - [List Policies](/docs/reference/admin/admin.listPolicies)
    - [Update Policy](/docs/reference/admin/admin.updatePolicy)
    - [List Admins](/docs/reference/admin/admin.listAdmins)
    - [Invite Admin](/docs/reference/admin/admin.inviteAdmin)
  - Admin billing
    - [Get Overview](/docs/reference/admin-billing/admin-billing.getOverview)
    - [Create Price](/docs/reference/admin-billing/admin-billing.createPrice)
    - [Update Price](/docs/reference/admin-billing/admin-billing.updatePrice)
    - [Update Plan](/docs/reference/admin-billing/admin-billing.updatePlan)
    - [Launch Pricing Experiment](/docs/reference/admin-billing/admin-billing.launchPricingExperiment)
    - [List Migratable](/docs/reference/admin-billing/admin-billing.listMigratable)
    - [Link Subscription](/docs/reference/admin-billing/admin-billing.linkSubscription)
  - Public forms
    - [Get Form](/docs/reference/public-forms/public-forms.getForm)
    - [Submit](/docs/reference/public-forms/public-forms.submit)
  - Legacy imports
    - [Create Upload](/docs/reference/legacy-imports/legacy-imports.createUpload)
    - [Create](/docs/reference/legacy-imports/legacy-imports.create)
    - [Get](/docs/reference/legacy-imports/legacy-imports.get)
    - [Preflight](/docs/reference/legacy-imports/legacy-imports.preflight)
    - [Update Workspaces](/docs/reference/legacy-imports/legacy-imports.updateWorkspaces)
    - [Approve](/docs/reference/legacy-imports/legacy-imports.approve)
    - [Start](/docs/reference/legacy-imports/legacy-imports.start)
    - [Cancel](/docs/reference/legacy-imports/legacy-imports.cancel)
    - [Retry](/docs/reference/legacy-imports/legacy-imports.retry)
    - [Rollback](/docs/reference/legacy-imports/legacy-imports.rollback)
    - [Report](/docs/reference/legacy-imports/legacy-imports.report)