Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rootkey.ai/llms.txt

Use this file to discover all available pages before exploring further.

This section is under active development. Full endpoint documentation will be published shortly. Contact support@rootkey.ai if you need early access or technical specifications.

Overview

The Records API allows you to create and manage individual records within ROOTKey tables. Each record operation - creation, update, or deletion - is processed through the configured data processing protocol, generating a cryptographic proof that is anchored to the blockchain. Records provide row-level auditability within structured datasets. Every write produces an immutable, verifiable history entry, enabling full record-level traceability for compliance, forensic, and operational purposes.

Key Capabilities

  • Create individual records within a defined table schema
  • Update records with full version history and integrity anchoring per version
  • Retrieve record history and validate any version against its on-chain proof
  • Query records with filtering and pagination
  • Transfer record ownership within or across vaults

Endpoints

Documentation for the following endpoints is in progress:
MethodEndpointDescription
POST/tables/:tableId/recordsCreate a new record
GET/tables/:tableId/recordsList records in a table
GET/tables/:tableId/records/:idGet a specific record
PUT/tables/:tableId/records/:idUpdate a record
DELETE/tables/:tableId/records/:idDelete a record
GET/tables/:tableId/records/:id/historyGet record version history
POST/tables/:tableId/records/:id/validateValidate record integrity

  • Tables API - manage the table structure that contains records
  • Files - for unstructured document management
  • Protocols - understand how records are anchored based on the active protocol