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.

The ROOTKey API is a REST API that gives you programmatic access to vault management, file integrity anchoring, validation, and analytics. All communication happens over HTTPS with JSON request and response bodies. Every write operation is anchored to the Polygon blockchain according to the configured data processing protocol.

​
Architecture

The blockchain anchor is written synchronously (RKP-1) or asynchronously (RKP-2, RKP-3) depending on your vault configuration.

​
Core Resources

Vaults

Vaults are the top-level containers for your data assets. Each vault has its own protocol configuration, access controls, and lifecycle management.

Files

Files are the primary asset type within a vault. Each file supports versioning, validation, history traversal, and ownership transfer - all with integrity anchoring.

Records

Individual records within a table, with full version history and per-record integrity validation.

Data Recovery

Restore soft-deleted vaults and files within the recovery window. Blockchain anchors are unaffected - on-chain proofs remain valid regardless of deletion state.

​
Key Capabilities

CapabilityDescription
Integrity anchoringEvery write operation produces a cryptographic proof anchored to the Polygon blockchain
Version historyFull lineage tracking for files and records - every version is independently verifiable
ValidationOn-demand integrity validation against the on-chain proof - detect tampering at any point in the asset lifecycle
Ownership transferTransfer custody of assets between vaults or accounts with an immutable chain-of-custody record
AnalyticsUsage and activity metrics for monitoring workloads, adoption, and operational patterns
Data RecoveryRestore soft-deleted vaults and files within the retention window before permanent deletion

​
Base URLs

EnvironmentBase URL
Developmenthttps://dev-api.rootkey.ai
Productionhttps://api.rootkey.ai
All endpoints are relative to the base URL for the target environment. See Environments for details on switching between them.

​
Authentication

Every request must include your API key in the x-api-key header: 
x-api-key: your_api_key_here
API keys are scoped to an environment (sandbox or live) and a workspace. Generate and manage your keys from the ROOTKey platform dashboard. See API Keys for step-by-step instructions.
Never expose API keys in client-side code, public repositories, or logs. Rotate keys immediately if you suspect a compromise.

​
Protocol Configuration

Each vault is configured with a data processing protocol that determines how writes are anchored:
ProtocolAnchoringThroughputUse for
RKP-1Full on-chainLowerRegulatory-critical, legal, financial
RKP-2Off-chain + proofHigherIoT, high-volume, real-time
RKP-3HybridBalancedEnterprise document management

​
Request Format

All request bodies must be sent as JSON with the Content-Type: application/json header. 
Content-Type: application/json

​
Response Format

Responses are JSON objects. Successful responses return a 2xx status code. Errors return a structured object with a machine-readable code and a human-readable message. See Error Reference for the full error schema.

​
Rate Limits

API requests are rate-limited per API key based on your active plan. Exceeded limits return 429 Too Many Requests. See Rate Limits for plan-specific limits and retry guidance.

​
Versioning

The API is versioned. Breaking changes are introduced only in new major versions with advance notice. See API Versioning for the full versioning policy and deprecation timelines.

​
Support

If you encounter issues or have questions about the API, contact our team at support@rootkey.ai or visit the Support page.